You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: Documentation/Reference/MaxAdmin.md
+12-3
Original file line number
Diff line number
Diff line change
@@ -287,13 +287,22 @@ Then simply set this file to have execute permissions and it may be run like any
287
287
288
288
## The .maxadmin file
289
289
290
-
MaxAdmin supports a mechanism to set defaults for all the command line switches via a file in the home directory of the user. If a file named .maxadmin exists it will be read and parameters set according to the lies in this files. The parameter that can be set is: socket. An example of a .maxadmin file that will alter the default password and user name arguments would be
290
+
MaxAdmin supports a mechanism to set defaults for the command line switches via a file in the home directory of the user. If a file named `.maxadmin` exists, it will be read and parameters set according to the entries in that file.
291
+
292
+
This mechanism can be used to provide defaults to the command line options. If a command line option is provided, it will still override the value in the `.maxadmin` file.
293
+
294
+
The parameters than can be set are:
295
+
*`1.4`: _hostname_, _port_, _user_ and _passwd_
296
+
*`2.0.0` and `2.0.1`: _socket_
297
+
*`2.0.2` onwards: _socket_, _hostname_, _port_, _user_ and _passwd_ (and as synonym _password_)
298
+
299
+
An example of a `.maxadmin` file that will alter the default socket path is:
291
300
292
301
socket=/somepath/maxadmin.socket
293
302
294
-
This mechanism can be used to provide a means of passwords entry into maxadmin or to override any of the command line option defaults. If a command line option is given that will still override the value in the .maxadmin file.
303
+
Note that if in `2.0.2` or later, a value for _socket_ as well as any of the internet socket related options, such as _hostname_, is provided in `.maxadmin`, then _socket_ takes precedense. In that case, provide at least one internet socket related option on the command line to force MaxAdmin to use an internet socket and thus the internet socket related options from `.maxadmin`.
295
304
296
-
The .maxadmin file may be made read only to protect any passwords written to that file.
305
+
The `.maxadmin` file may be made read only to protect any passwords written to that file.
0 commit comments