mpdconf.example 12.3 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 9 10 11
# available audio files and add them to the daemon's online database. This 
# 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 16 17
# This setting sets the MPD internal playlist directory. The purpose of this
# directory is storage for playlists created by MPD. The server will use 
# 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 23
# This setting sets the location of the MPD database. This file is used to
# 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"
Avuton Olrich's avatar
Avuton Olrich committed
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 35
# The special value "syslog" makes MPD use the local syslog daemon. This
# setting defaults to logging to syslog, otherwise logging is disabled.
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 48
# it was brought down. This setting is disabled by default and the server 
# 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 77
# This setting sets the address for the daemon to listen on. Careful attention
# should be paid if this is assigned to anything other then 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 93 94 95
# This setting controls the type of information which is logged. Available 
# setting arguments are "default", "secure" or "verbose". The "verbose" setting
# argument is recommended for troubleshooting, though can quickly stretch
# available resources on limited hardware storage.
96
#
Avuton Olrich's avatar
Avuton Olrich committed
97
#log_level			"default"
98
#
Avuton Olrich's avatar
Avuton Olrich committed
99 100 101 102 103
# If you have a problem with your MP3s ending abruptly it is recommended that 
# you set this argument to "no" to attempt to fix the problem. If this solves
# the problem, it is highly recommended to fix the MP3 files with vbrfix
# (available from <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
# point gapless MP3 playback can be enabled.
104
#
Avuton Olrich's avatar
Avuton Olrich committed
105 106
#gapless_mp3_playback			"yes"
#
107 108 109 110 111
# Setting "restore_paused" to "yes" puts MPD into pause mode instead
# of starting playback after startup.
#
#restore_paused "no"
#
112 113
# This setting enables MPD to create playlists in a format usable by other
# music players.
Avuton Olrich's avatar
Avuton Olrich committed
114 115 116
#
#save_absolute_paths_in_playlists	"no"
#
117 118
# 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
119
# found in the user manual.
Avuton Olrich's avatar
Avuton Olrich committed
120 121
#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
#
122 123 124 125
# This setting enables automatic update of MPD's database when files in 
# music_directory are changed.
#
#auto_update	"yes"
126 127 128 129 130 131
#
# 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
132
###############################################################################
133

Avuton Olrich's avatar
Avuton Olrich committed
134

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

Avuton Olrich's avatar
Avuton Olrich committed
149

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


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

178

179 180 181 182 183 184 185 186 187
# Database #######################################################################
#

#database {
#       plugin "proxy"
#       host "other.mpd.host"
#       port "6600"
#}

188 189 190 191 192 193 194 195 196 197 198 199 200
# Input #######################################################################
#

input {
        plugin "curl"
#       proxy "proxy.isp.com:8080"
#       proxy_user "user"
#       proxy_password "password"
}

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

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


Avuton Olrich's avatar
Avuton Olrich committed
349
# Normalization automatic volume adjustments ##################################
Warren Dukes's avatar
Warren Dukes committed
350
#
351
# This setting specifies the type of ReplayGain to use. This setting can have
352 353 354 355 356
# 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.
# See <http://www.replaygain.org> for more details about ReplayGain.
# This setting is off by default.
Warren Dukes's avatar
Warren Dukes committed
357
#
Avuton Olrich's avatar
Avuton Olrich committed
358
#replaygain			"album"
Warren Dukes's avatar
Warren Dukes committed
359
#
360 361
# 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
362
#
Avuton Olrich's avatar
Avuton Olrich committed
363
#replaygain_preamp		"0"
Warren Dukes's avatar
Warren Dukes committed
364
#
365 366 367 368 369 370 371 372 373 374 375 376 377 378
# 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"
#
379 380
# This setting enables on-the-fly normalization volume adjustment. This will
# result in the volume of all playing audio to be adjusted so the output has 
381
# equal "loudness". This setting is disabled by default.
Warren Dukes's avatar
Warren Dukes committed
382
#
Avuton Olrich's avatar
Avuton Olrich committed
383
#volume_normalization		"no"
Warren Dukes's avatar
Warren Dukes committed
384
#
Avuton Olrich's avatar
Avuton Olrich committed
385
###############################################################################
386

Avuton Olrich's avatar
Avuton Olrich committed
387
# Character Encoding ##########################################################
Warren Dukes's avatar
Warren Dukes committed
388
#
389
# If file or directory names do not display correctly for your locale then you 
390
# may need to modify this setting.
Warren Dukes's avatar
Warren Dukes committed
391
#
Avuton Olrich's avatar
Avuton Olrich committed
392
#filesystem_charset		"UTF-8"
Warren Dukes's avatar
Warren Dukes committed
393
#
394
###############################################################################