mpdconf.example 12.8 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 31 32
# These settings are the locations for the daemon log files for the daemon.
# These logs are great for troubleshooting, depending on your log_level
# settings.
Avuton Olrich's avatar
Avuton Olrich committed
33
#
34
# The special value "syslog" makes MPD use the local syslog daemon. This
35
# setting defaults to logging to syslog.
Max Kellermann's avatar
Max Kellermann committed
36
#
37
#log_file			"~/.mpd/log"
Warren Dukes's avatar
Warren Dukes committed
38
#
39 40
# 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
41
# default and the pid file will not be stored.
42
#
Avuton Olrich's avatar
Avuton Olrich committed
43
#pid_file			"~/.mpd/pid"
Warren Dukes's avatar
Warren Dukes committed
44
#
45 46
# 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
47
# it was brought down. This setting is disabled by default and the server
48
# state will be reset on server start up.
Warren Dukes's avatar
Warren Dukes committed
49
#
Avuton Olrich's avatar
Avuton Olrich committed
50
#state_file			"~/.mpd/state"
Warren Dukes's avatar
Warren Dukes committed
51
#
52 53 54 55 56
# 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
57
###############################################################################
58 59


Avuton Olrich's avatar
Avuton Olrich committed
60
# General music daemon options ################################################
61
#
62 63 64 65
# 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
66
#
Avuton Olrich's avatar
Avuton Olrich committed
67
#user				"nobody"
68
#
69 70 71 72 73 74 75
# 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"
#
76
# This setting sets the address for the daemon to listen on. Careful attention
77
# should be paid if this is assigned to anything other than the default, any.
78 79
# This setting can deny access to control of the daemon. Not effective if
# systemd socket activiation is in use.
Warren Dukes's avatar
Warren Dukes committed
80
#
Avuton Olrich's avatar
Avuton Olrich committed
81 82
# For network
#bind_to_address		"any"
Warren Dukes's avatar
Warren Dukes committed
83
#
Avuton Olrich's avatar
Avuton Olrich committed
84 85
# And for Unix Socket
#bind_to_address		"~/.mpd/socket"
Warren Dukes's avatar
Warren Dukes committed
86
#
87 88
# This setting is the TCP port that is desired for the daemon to get assigned
# to.
Warren Dukes's avatar
Warren Dukes committed
89
#
Avuton Olrich's avatar
Avuton Olrich committed
90
#port				"6600"
91
#
92
# Suppress all messages below the given threshold.  Use "verbose" for
93 94
# troubleshooting. Available setting arguments are "notice", "info", "verbose",
# "warning" and "error".
95
#
96
#log_level			"notice"
97
#
98 99 100 101 102
# Setting "restore_paused" to "yes" puts MPD into pause mode instead
# of starting playback after startup.
#
#restore_paused "no"
#
103 104
# This setting enables MPD to create playlists in a format usable by other
# music players.
Avuton Olrich's avatar
Avuton Olrich committed
105 106 107
#
#save_absolute_paths_in_playlists	"no"
#
108 109
# 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
110
# found in the user manual.
Avuton Olrich's avatar
Avuton Olrich committed
111 112
#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
#
113 114 115 116
# This example just enables the "comment" tag without disabling all
# the other supported tags:
#metadata_to_use "+comment"
#
117
# This setting enables automatic update of MPD's database when files in
118 119 120
# music_directory are changed.
#
#auto_update	"yes"
121 122 123 124 125 126
#
# 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
127
###############################################################################
128

Avuton Olrich's avatar
Avuton Olrich committed
129

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

Avuton Olrich's avatar
Avuton Olrich committed
144

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


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

173

174 175
# Database #######################################################################
#
176 177 178 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"
#}
#
# An example of database config for a sattelite setup
#
#music_directory "nfs://fileserver.local/srv/mp3"
188 189 190 191 192 193
#database {
#       plugin "proxy"
#       host "other.mpd.host"
#       port "6600"
#}

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

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

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


Avuton Olrich's avatar
Avuton Olrich committed
369
# Normalization automatic volume adjustments ##################################
Warren Dukes's avatar
Warren Dukes committed
370
#
371
# This setting specifies the type of ReplayGain to use. This setting can have
372 373 374
# 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.
375 376
# See <https://wiki.hydrogenaud.io/index.php?title=Replaygain> for
# more details about ReplayGain.
377
# This setting is off by default.
Warren Dukes's avatar
Warren Dukes committed
378
#
Avuton Olrich's avatar
Avuton Olrich committed
379
#replaygain			"album"
Warren Dukes's avatar
Warren Dukes committed
380
#
381 382
# 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
383
#
Avuton Olrich's avatar
Avuton Olrich committed
384
#replaygain_preamp		"0"
Warren Dukes's avatar
Warren Dukes committed
385
#
386 387 388 389 390 391 392 393 394 395 396 397 398 399
# 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"
#
400
# This setting enables on-the-fly normalization volume adjustment. This will
401
# result in the volume of all playing audio to be adjusted so the output has
402
# equal "loudness". This setting is disabled by default.
Warren Dukes's avatar
Warren Dukes committed
403
#
Avuton Olrich's avatar
Avuton Olrich committed
404
#volume_normalization		"no"
Warren Dukes's avatar
Warren Dukes committed
405
#
Avuton Olrich's avatar
Avuton Olrich committed
406
###############################################################################
407

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