mpdconf.example 12.9 KB
Newer Older
1 2
# An example configuration file for MPD.
# Read the user manual for documentation: http://www.musicpd.org/doc/user/
3

Avuton Olrich's avatar
Avuton Olrich committed
4

5
# Files and directories #######################################################
Avuton Olrich's avatar
Avuton Olrich committed
6
#
7
# This setting controls the top directory which MPD will search to discover the
8
# available audio files and add them to the daemon's online database. This
9 10 11
# setting defaults to the XDG directory, otherwise the music directory will be
# be disabled and audio files will only be accepted over ipc socket (using
# file:// protocol) or streaming files over an accepted protocol.
Avuton Olrich's avatar
Avuton Olrich committed
12
#
13
#music_directory		"~/music"
Avuton Olrich's avatar
Avuton Olrich committed
14
#
15
# This setting sets the MPD internal playlist directory. The purpose of this
16
# directory is storage for playlists created by MPD. The server will use
17
# playlist files not created by the server but only if they are in the MPD
18
# format. This setting defaults to playlist saving being disabled.
Avuton Olrich's avatar
Avuton Olrich committed
19
#
20
#playlist_directory		"~/.mpd/playlists"
Avuton Olrich's avatar
Avuton Olrich committed
21
#
22
# This setting sets the location of the MPD database. This file is used to
23
# load the database at server start up and store the database while the
24 25 26
# server is not up. This setting defaults to disabled which will allow
# MPD to accept files over ipc socket (using file:// protocol) or streaming
# files over an accepted protocol.
Avuton Olrich's avatar
Avuton Olrich committed
27
#
28
#db_file			"~/.mpd/database"
29

30
# These settings are the locations for the daemon log files for the daemon.
Avuton Olrich's avatar
Avuton Olrich committed
31
#
32
# The special value "syslog" makes MPD use the local syslog daemon. This
33
# setting defaults to logging to syslog.
Max Kellermann's avatar
Max Kellermann committed
34
#
35 36
# If you use systemd, do not configure a log_file.  With systemd, MPD
# defaults to the systemd journal, which is fine.
Warren Dukes's avatar
Warren Dukes committed
37
#
38 39
#log_file			"~/.mpd/log"

40 41
# This setting sets the location of the file which stores the process ID
# for use of mpd --kill and some init scripts. This setting is disabled by
42
# default and the pid file will not be stored.
43
#
44
# If you use systemd, do not configure a pid_file.
Warren Dukes's avatar
Warren Dukes committed
45
#
46 47
#pid_file			"~/.mpd/pid"

48 49
# This setting sets the location of the file which contains information about
# most variables to get MPD back into the same general shape it was in before
50
# it was brought down. This setting is disabled by default and the server
51
# state will be reset on server start up.
Warren Dukes's avatar
Warren Dukes committed
52
#
Avuton Olrich's avatar
Avuton Olrich committed
53
#state_file			"~/.mpd/state"
Warren Dukes's avatar
Warren Dukes committed
54
#
55 56 57 58 59
# The location of the sticker database.  This is a database which
# manages dynamic information attached to songs.
#
#sticker_file			"~/.mpd/sticker.sql"
#
Avuton Olrich's avatar
Avuton Olrich committed
60
###############################################################################
61 62


Avuton Olrich's avatar
Avuton Olrich committed
63
# General music daemon options ################################################
64
#
65 66 67 68
# This setting specifies the user that MPD will run as. MPD should never run as
# root and you may use this setting to make MPD change its user ID after
# initialization. This setting is disabled by default and MPD is run as the
# current user.
Warren Dukes's avatar
Warren Dukes committed
69
#
Avuton Olrich's avatar
Avuton Olrich committed
70
#user				"nobody"
71
#
72 73 74 75 76 77 78
# This setting specifies the group that MPD will run as. If not specified
# primary group of user specified with "user" setting will be used (if set).
# This is useful if MPD needs to be a member of group such as "audio" to
# have permission to use sound card.
#
#group				"nogroup"
#
79
# This setting sets the address for the daemon to listen on. Careful attention
80
# should be paid if this is assigned to anything other than the default, any.
81
# This setting can deny access to control of the daemon. Not effective if
82
# systemd socket activation is in use.
Warren Dukes's avatar
Warren Dukes committed
83
#
Avuton Olrich's avatar
Avuton Olrich committed
84 85
# For network
#bind_to_address		"any"
Warren Dukes's avatar
Warren Dukes committed
86
#
Avuton Olrich's avatar
Avuton Olrich committed
87 88
# And for Unix Socket
#bind_to_address		"~/.mpd/socket"
Warren Dukes's avatar
Warren Dukes committed
89
#
90 91
# This setting is the TCP port that is desired for the daemon to get assigned
# to.
Warren Dukes's avatar
Warren Dukes committed
92
#
Avuton Olrich's avatar
Avuton Olrich committed
93
#port				"6600"
94
#
95
# Suppress all messages below the given threshold.  Use "verbose" for
96 97
# troubleshooting. Available setting arguments are "notice", "info", "verbose",
# "warning" and "error".
98
#
99
#log_level			"notice"
100
#
101 102 103 104 105
# Setting "restore_paused" to "yes" puts MPD into pause mode instead
# of starting playback after startup.
#
#restore_paused "no"
#
106 107
# This setting enables MPD to create playlists in a format usable by other
# music players.
Avuton Olrich's avatar
Avuton Olrich committed
108 109 110
#
#save_absolute_paths_in_playlists	"no"
#
111 112
# This setting defines a list of tag types that will be extracted during the
# audio file discovery process. The complete list of possible values can be
113
# found in the user manual.
Avuton Olrich's avatar
Avuton Olrich committed
114 115
#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
#
116 117 118 119
# This example just enables the "comment" tag without disabling all
# the other supported tags:
#metadata_to_use "+comment"
#
120
# This setting enables automatic update of MPD's database when files in
121 122 123
# music_directory are changed.
#
#auto_update	"yes"
124 125 126 127 128 129
#
# Limit the depth of the directories being watched, 0 means only watch
# the music directory itself.  There is no limit by default.
#
#auto_update_depth "3"
#
Avuton Olrich's avatar
Avuton Olrich committed
130
###############################################################################
131

Avuton Olrich's avatar
Avuton Olrich committed
132

Avuton Olrich's avatar
Avuton Olrich committed
133 134
# Symbolic link behavior ######################################################
#
135
# If this setting is set to "yes", MPD will discover audio files by following
136
# symbolic links outside of the configured music_directory.
Avuton Olrich's avatar
Avuton Olrich committed
137 138 139
#
#follow_outside_symlinks	"yes"
#
140
# If this setting is set to "yes", MPD will discover audio files by following
141
# symbolic links inside of the configured music_directory.
Avuton Olrich's avatar
Avuton Olrich committed
142 143 144 145
#
#follow_inside_symlinks		"yes"
#
###############################################################################
146

Avuton Olrich's avatar
Avuton Olrich committed
147

Avuton Olrich's avatar
Avuton Olrich committed
148
# Zeroconf / Avahi Service Discovery ##########################################
149
#
150 151
# If this setting is set to "yes", service information will be published with
# Zeroconf / Avahi.
152
#
Avuton Olrich's avatar
Avuton Olrich committed
153
#zeroconf_enabled		"yes"
154
#
155
# The argument to this setting will be the Zeroconf / Avahi unique name for
156
# this MPD server on the network. %h will be replaced with the hostname.
157
#
158
#zeroconf_name			"Music Player @ %h"
159
#
Avuton Olrich's avatar
Avuton Olrich committed
160
###############################################################################
161 162


Avuton Olrich's avatar
Avuton Olrich committed
163
# Permissions #################################################################
164
#
165
# If this setting is set, MPD will require password authorization. The password
166
# setting can be specified multiple times for different password profiles.
Warren Dukes's avatar
Warren Dukes committed
167
#
168 169
#password                        "password@read,add,control,admin"
#
170
# This setting specifies the permissions a user has who has not yet logged in.
171
#
172
#default_permissions             "read,add,control,admin"
Warren Dukes's avatar
Warren Dukes committed
173
#
Avuton Olrich's avatar
Avuton Olrich committed
174
###############################################################################
Warren Dukes's avatar
Warren Dukes committed
175

176

177 178
# Database #######################################################################
#
179 180 181 182 183 184 185 186 187
# An example of a database section instead of the old 'db_file' setting.
# It enables mounting other storages into the music directory.
#
#database {
#       plugin "simple"
#       path "~/.local/share/mpd/db
#       cache_directory "~/.local/share/mpd/cache"
#}
#
188
# An example of database config for a satellite setup
189 190
#
#music_directory "nfs://fileserver.local/srv/mp3"
191 192 193 194 195 196
#database {
#       plugin "proxy"
#       host "other.mpd.host"
#       port "6600"
#}

197 198 199 200 201 202 203 204 205 206 207 208
# Input #######################################################################
#
input {
        plugin "curl"
#       proxy "proxy.isp.com:8080"
#       proxy_user "user"
#       proxy_password "password"
}

#
###############################################################################

Avuton Olrich's avatar
Avuton Olrich committed
209
# Audio Output ################################################################
210
#
211 212
# MPD supports various audio output types, as well as playing through multiple
# audio outputs at the same time, through multiple audio_output settings
213 214
# blocks. Setting this block is optional, though the server will only attempt
# autodetection for one sound card.
215
#
216
# An example of an ALSA output:
217
#
218
#audio_output {
219 220
#	type		"alsa"
#	name		"My ALSA Device"
221
##	device		"hw:0,0"	# optional
Max Kellermann's avatar
Max Kellermann committed
222
##	mixer_type      "hardware"	# optional
223 224 225
##	mixer_device	"default"	# optional
##	mixer_control	"PCM"		# optional
##	mixer_index	"0"		# optional
226
#}
227
#
228 229 230
# An example of an OSS output:
#
#audio_output {
231 232
#	type		"oss"
#	name		"My OSS Device"
233
##	device		"/dev/dsp"	# optional
Max Kellermann's avatar
Max Kellermann committed
234
##	mixer_type      "hardware"	# optional
235 236
##	mixer_device	"/dev/mixer"	# optional
##	mixer_control	"PCM"		# optional
237 238 239 240 241
#}
#
# An example of a shout output (for streaming to Icecast):
#
#audio_output {
242
#	type		"shout"
243
#	encoder		"vorbis"		# optional
244 245 246 247 248 249 250 251
#	name		"My Shout Stream"
#	host		"localhost"
#	port		"8000"
#	mount		"/mpd.ogg"
#	password	"hackme"
#	quality		"5.0"
#	bitrate		"128"
#	format		"44100:16:1"
252 253 254
##	protocol	"icecast2"		# optional
##	user		"source"		# optional
##	description	"My Stream Description"	# optional
255
##	url		"http://example.com"	# optional
256 257 258
##	genre		"jazz"			# optional
##	public		"no"			# optional
##	timeout		"2"			# optional
Max Kellermann's avatar
Max Kellermann committed
259
##	mixer_type      "software"		# optional
260
#}
261
#
262 263 264 265 266 267 268
# An example of a recorder output:
#
#audio_output {
#	type		"recorder"
#	name		"My recorder"
#	encoder		"vorbis"		# optional, vorbis or lame
#	path		"/var/lib/mpd/recorder/mpd.ogg"
Max Kellermann's avatar
Max Kellermann committed
269
##	quality		"5.0"			# do not define if bitrate is defined
270 271 272 273
#	bitrate		"128"			# do not define if quality is defined
#	format		"44100:16:1"
#}
#
274 275 276
# An example of a httpd output (built-in HTTP streaming server):
#
#audio_output {
277 278 279 280
#	type		"httpd"
#	name		"My HTTP Stream"
#	encoder		"vorbis"		# optional, vorbis or lame
#	port		"8000"
281
#	bind_to_address	"0.0.0.0"		# optional, IPv4 or IPv6
282
##	quality		"5.0"			# do not define if bitrate is defined
283 284
#	bitrate		"128"			# do not define if quality is defined
#	format		"44100:16:1"
285
#	max_clients	"0"			# optional 0=no limit
286 287
#}
#
Avuton Olrich's avatar
Avuton Olrich committed
288
# An example of a pulseaudio output (streaming to a remote pulseaudio server)
289 290
#
#audio_output {
291 292
#	type		"pulse"
#	name		"My Pulse Output"
293 294
##	server		"remote_server"		# optional
##	sink		"remote_server_sink"	# optional
295
##	media_role	"media_role"		#optional
296 297
#}
#
298 299 300 301
# An example of a winmm output (Windows multimedia API).
#
#audio_output {
#	type		"winmm"
302
#	name		"My WinMM output"
303 304 305 306 307 308
##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
#		or
##	device		"0"		# optional
##	mixer_type	"hardware"	# optional
#}
#
309 310 311 312 313 314 315 316 317 318 319 320 321 322
# An example of a wasapi output (Windows multimedia API).
#
#audio_output {
#	type		"wasapi"
#	name		"My WASAPI output"
##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
#		or
##	device		"0"		# optional
## Exclusive mode blocks all other audio source, and get best audio quality without resampling.
##	exclusive	"no"		# optional
## Enumerate all devices in log.
##	enumerate	"no"		# optional
#}
#
323
# An example of an openal output.
324 325 326
#
#audio_output {
#	type		"openal"
327
#	name		"My OpenAL output"
328 329 330
##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
#}
#
331 332 333 334 335
# An example of an sndio output.
#
#audio_output {
#	type		"sndio"
#	name		"sndio output"
336
#	mixer_type	"hardware"
337 338
#}
#
339 340 341 342 343 344 345 346 347
# An example of an OS X output:
#
#audio_output {
#	type		"osx"
#	name		"My OS X Device"
##	device		"Built-in Output"	# optional
##	channel_map      "-1,-1,0,1"	# optional
#}
#
348 349 350 351 352 353 354 355 356 357 358 359 360
## Example "pipe" output:
#
#audio_output {
#	type		"pipe"
#	name		"my pipe"
#	command		"aplay -f cd 2>/dev/null"
## Or if you're want to use AudioCompress
#	command		"AudioCompress -m | aplay -f cd 2>/dev/null"
## Or to send raw PCM stream through PCM:
#	command		"nc example.org 8765"
#	format		"44100:16:2"
#}
#
Avuton Olrich's avatar
Avuton Olrich committed
361 362 363
## An example of a null output (for no audio output):
#
#audio_output {
364 365
#	type		"null"
#	name		"My Null Output"
366
#	mixer_type      "none"			# optional
Avuton Olrich's avatar
Avuton Olrich committed
367
#}
368
#
Avuton Olrich's avatar
Avuton Olrich committed
369
###############################################################################
370 371


Avuton Olrich's avatar
Avuton Olrich committed
372
# Normalization automatic volume adjustments ##################################
Warren Dukes's avatar
Warren Dukes committed
373
#
374
# This setting specifies the type of ReplayGain to use. This setting can have
375 376 377
# the argument "off", "album", "track" or "auto". "auto" is a special mode that
# chooses between "track" and "album" depending on the current state of
# random playback. If random playback is enabled then "track" mode is used.
378 379
# See <https://wiki.hydrogenaud.io/index.php?title=Replaygain> for
# more details about ReplayGain.
380
# This setting is off by default.
Warren Dukes's avatar
Warren Dukes committed
381
#
Avuton Olrich's avatar
Avuton Olrich committed
382
#replaygain			"album"
Warren Dukes's avatar
Warren Dukes committed
383
#
384 385
# This setting sets the pre-amp used for files that have ReplayGain tags. By
# default this setting is disabled.
Warren Dukes's avatar
Warren Dukes committed
386
#
Avuton Olrich's avatar
Avuton Olrich committed
387
#replaygain_preamp		"0"
Warren Dukes's avatar
Warren Dukes committed
388
#
389 390 391 392 393 394 395 396 397 398 399 400 401 402
# This setting sets the pre-amp used for files that do NOT have ReplayGain tags.
# By default this setting is disabled.
#
#replaygain_missing_preamp	"0"
#
# This setting enables or disables ReplayGain limiting.
# MPD calculates actual amplification based on the ReplayGain tags
# and replaygain_preamp / replaygain_missing_preamp setting.
# If replaygain_limit is enabled MPD will never amplify audio signal
# above its original level. If replaygain_limit is disabled such amplification
# might occur. By default this setting is enabled.
#
#replaygain_limit		"yes"
#
403
# This setting enables on-the-fly normalization volume adjustment. This will
404
# result in the volume of all playing audio to be adjusted so the output has
405
# equal "loudness". This setting is disabled by default.
Warren Dukes's avatar
Warren Dukes committed
406
#
Avuton Olrich's avatar
Avuton Olrich committed
407
#volume_normalization		"no"
Warren Dukes's avatar
Warren Dukes committed
408
#
Avuton Olrich's avatar
Avuton Olrich committed
409
###############################################################################
410

Avuton Olrich's avatar
Avuton Olrich committed
411
# Character Encoding ##########################################################
Warren Dukes's avatar
Warren Dukes committed
412
#
413
# If file or directory names do not display correctly for your locale then you
414
# may need to modify this setting.
Warren Dukes's avatar
Warren Dukes committed
415
#
Avuton Olrich's avatar
Avuton Olrich committed
416
#filesystem_charset		"UTF-8"
Warren Dukes's avatar
Warren Dukes committed
417
#
418
###############################################################################