diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5 index bfec4cd1a..787394774 100644 --- a/doc/mpd.conf.5 +++ b/doc/mpd.conf.5 @@ -72,19 +72,6 @@ never run as root, and you may use this option to make MPD change its user id after initialization. Do not use this option if you start MPD as an unprivileged user. .TP -.B bind_to_address -This specifies which address mpd binds to and listens on. Multiple -bind_to_address parameters may be specified. The default is "any", which binds -to all available addresses. - -You can set a port that is different from the global port setting, -e.g. "localhost:6602". IPv6 addresses must be enclosed in square -brackets if you want to configure a port, e.g. "[::1]:6602". - -To bind to a Unix domain socket, specify an absolute path or a path starting -with a tilde (~). For a system-wide MPD, we suggest the path -"\fB/var/run/mpd/socket\fP". -.TP .B port This specifies the port that mpd listens on. The default is 6600. .TP @@ -114,22 +101,6 @@ If Zeroconf is enabled, this is the service name to publish. This name should be unique to your local network, but name collisions will be properly dealt with. The default is "Music Player". .TP -.B password -This specifies a password for access to mpd. The format is -"password@permissions" where permissions is a comma delimited list composed -of "read", "add", "control", and/or "admin". "read" allows for reading of the -database, displaying the current playlist, and current status of mpd. "add" -allows for adding songs and loading playlists. "control" allows for all other -player and playlist manipulations. "admin" allows the db to be updated and for -the client to kill mpd. An example value is "somePassword@read,add". Multiple -password parameters may be specified. -.TP -.B default_permissions -This specifies the permissions of a client that has not been authenticated -using a password. The format of permissions is specified in the description of -the "password" config parameter. If no passwords are specified, the default is -"read,add,control,admin", otherwise it is "" (no permissions). -.TP .B audio_output See \fBDESCRIPTION\fP and the various \fBAUDIO OUTPUT PARAMETERS\fP sections for the format of this parameter. Multiple audio_output sections may be diff --git a/doc/user.xml b/doc/user.xml index d203e22f5..85f060a0b 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -1043,6 +1043,144 @@ systemctl start mpd.socket +
+ Client Connections + +
+ Listeners + + + The setting bind_to_address specifies + which addresses MPD listens on + for connections from clients. The default is + "any", which binds to all available + addresses. + + + + You can set a port that is different from the global port + setting, e.g. "localhost:6602". IPv6 + addresses must be enclosed in square brackets if you want to + configure a port, e.g. "[::1]:6602". + + + + To bind to a local socket (UNIX domain socket), specify an + absolute path or a path starting with a tilde + (~). Some clients default to + connecting to /var/run/mpd/socket so + this may be a good choice. + + + + If no port is specified, the default port is + 6600. This default can be changed + with the port setting. + +
+ +
+ Permissions and Passwords + + + By default, all clients are unauthenticated and have a full + set of permissions. This can be restricted with the + settings default_permissions and + password. + + + + default_permissions controls the + permissions of a new client. Its value is a comma-separated + list of permissions: + + + + + + + + Name + + + Description + + + + + + + read + + + Allows reading of the database, displaying the current + playlist, and current status of MPD. + + + + + + read + + + Allows reading of the database, displaying the current + playlist, and current status of MPD. + + + + + + add + + + Allows adding songs and loading playlists. + + + + + + control + + + Allows all other player and playlist manipulations. + + + + + + admin + + + Allows database updates and allows shutting down MPD. + + + + + + + + password allows the client to send a + password to gain other permissions. This option may be + specified multiple times with different passwords. + + + + Note that the password option is not + secure: passwords are sent in clear-text over the + connection, and the client cannot verify the server's + identity. + + + + Example: + + + default_permissions "read" +password "the_password@read,add,control" +password "the_admin_password@read,add,control,admin" +
+
+
Other Settings