mpdconf.example 10.8 KB
Newer Older
1
# An example configuration file for MPD
2
# See the mpd.conf man page for a more detailed description of each parameter.
3

Avuton Olrich's avatar
Avuton Olrich committed
4 5
# Required files and directories ##############################################
#
6 7
# This setting controls the top directory which MPD will search to discover the
# available audio files and add them to the daemon's online database.
Avuton Olrich's avatar
Avuton Olrich committed
8 9 10
#
music_directory			"~/music"
#
11 12 13 14
# 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
# format.
Avuton Olrich's avatar
Avuton Olrich committed
15 16 17
#
playlist_directory		"~/.mpd/playlists"
#
18 19 20
# 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 
# server is not up.
Avuton Olrich's avatar
Avuton Olrich committed
21 22 23
#
db_file				"~/.mpd/database"
# 
24 25 26
# 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
27
#
Max Kellermann's avatar
Max Kellermann committed
28 29 30 31
# The special value "syslog" makes MPD use the local syslog daemon.
# On most systems, log messages will appear in /var/log/daemon.log
# then.
#
Avuton Olrich's avatar
Avuton Olrich committed
32 33
log_file			"~/.mpd/log"
###############################################################################
34 35


Avuton Olrich's avatar
Avuton Olrich committed
36
# Optional files ##############################################################
Warren Dukes's avatar
Warren Dukes committed
37
#
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
# default.
41
#
Avuton Olrich's avatar
Avuton Olrich committed
42
#pid_file			"~/.mpd/pid"
Warren Dukes's avatar
Warren Dukes committed
43
#
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
# it was brought down. This setting is disabled by default.
Warren Dukes's avatar
Warren Dukes committed
47
#
Avuton Olrich's avatar
Avuton Olrich committed
48
#state_file			"~/.mpd/state"
Warren Dukes's avatar
Warren Dukes committed
49
#
Avuton Olrich's avatar
Avuton Olrich committed
50
###############################################################################
51 52


Avuton Olrich's avatar
Avuton Olrich committed
53
# General music daemon options ################################################
54
#
55 56 57 58 59
# This setting specifies the user that MPD will run as, if set. MPD should
# never run as root and you may use this setting to make MPD change its user 
# id after initialization. Do not use this setting if you start MPD as an
# unprivileged user. This setting is disabled by default, and the server will
# run as root.
Warren Dukes's avatar
Warren Dukes committed
60
#
Avuton Olrich's avatar
Avuton Olrich committed
61
#user				"nobody"
62
#
63 64 65
# 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.
# This setting can deny access to control of the daemon.
Warren Dukes's avatar
Warren Dukes committed
66
#
Avuton Olrich's avatar
Avuton Olrich committed
67 68
# For network
#bind_to_address		"any"
Warren Dukes's avatar
Warren Dukes committed
69
#
Avuton Olrich's avatar
Avuton Olrich committed
70 71
# And for Unix Socket
#bind_to_address		"~/.mpd/socket"
Warren Dukes's avatar
Warren Dukes committed
72
#
73
# This setting is the port that is desired for the daemon to get assigned to.
Warren Dukes's avatar
Warren Dukes committed
74
#
Avuton Olrich's avatar
Avuton Olrich committed
75
#port				"6600"
76
#
77 78 79 80
# 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.
81
#
Avuton Olrich's avatar
Avuton Olrich committed
82
#log_level			"default"
83
#
Avuton Olrich's avatar
Avuton Olrich committed
84 85 86 87 88
# 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.
89
#
Avuton Olrich's avatar
Avuton Olrich committed
90 91
#gapless_mp3_playback			"yes"
#
92 93
# This setting enables MPD to create playlists in a format usable by other
# music players.
Avuton Olrich's avatar
Avuton Olrich committed
94 95 96
#
#save_absolute_paths_in_playlists	"no"
#
97 98 99
# This setting defines a list of tag types that will be extracted during the 
# audio file discovery process. Optionally, 'comment' can be added to this
# list.
Avuton Olrich's avatar
Avuton Olrich committed
100 101 102 103
#
#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
#
###############################################################################
104

Avuton Olrich's avatar
Avuton Olrich committed
105 106
# Symbolic link behavior ######################################################
#
107 108
# 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
109 110 111
#
#follow_outside_symlinks	"yes"
#
112 113
# If this setting is set to "yes, MPD will discover audio files by following
# symbolic links inside of the configured music_directory.
Avuton Olrich's avatar
Avuton Olrich committed
114 115 116 117
#
#follow_inside_symlinks		"yes"
#
###############################################################################
118

Avuton Olrich's avatar
Avuton Olrich committed
119
# Zeroconf / Avahi Service Discovery ##########################################
120
#
121 122
# If this setting is set to "yes", service information will be published with
# Zeroconf / Avahi.
123
#
Avuton Olrich's avatar
Avuton Olrich committed
124
#zeroconf_enabled		"yes"
125
#
126 127
# The argument to this setting will be the Zeroconf / Avahi unique name for
# this MPD server on the network.
128
#
Avuton Olrich's avatar
Avuton Olrich committed
129
#zeroconf_name			"Music Player"
130
#
Avuton Olrich's avatar
Avuton Olrich committed
131
###############################################################################
132 133


Avuton Olrich's avatar
Avuton Olrich committed
134
# Permissions #################################################################
135
#
136 137
# If this setting is set, MPD will require password authorization. The password
# can setting can be specified multiple times for different password profiles.
Warren Dukes's avatar
Warren Dukes committed
138
#
139 140
#password                        "password@read,add,control,admin"
#
141
# This setting specifies the permissions a user has who has not yet logged in. 
142
#
143
#default_permissions             "read,add,control,admin"
Warren Dukes's avatar
Warren Dukes committed
144
#
Avuton Olrich's avatar
Avuton Olrich committed
145
###############################################################################
Warren Dukes's avatar
Warren Dukes committed
146

147

Avuton Olrich's avatar
Avuton Olrich committed
148
# Audio Output ################################################################
149
#
150 151 152 153
# 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.
154
#
155 156
# See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of 
# other audio outputs.
157
#
158
# An example of an ALSA output:
159
#
160
#audio_output {
Avuton Olrich's avatar
Avuton Olrich committed
161 162 163 164
#	type			"alsa"
#	name			"My ALSA Device"
#	device			"hw:0,0"	# optional
#	format			"44100:16:2"	# optional
165 166
#	mixer_device		"default"	# optional
#	mixer_control		"PCM"		# optional
167
#}
168
#
169 170 171
# An example of an OSS output:
#
#audio_output {
Avuton Olrich's avatar
Avuton Olrich committed
172 173 174 175
#	type			"oss"
#	name			"My OSS Device"
#	device			"/dev/dsp"	# optional
#	format			"44100:16:2"	# optional
176 177
#	mixer_device		"/dev/mixer"	# optional
#	mixer_control		"PCM"		# optional
178 179 180 181 182
#}
#
# An example of a shout output (for streaming to Icecast):
#
#audio_output {
Avuton Olrich's avatar
Avuton Olrich committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
#	type			"shout"
#	encoding		"ogg"			# optional
#	name			"My Shout Stream"
#	host			"localhost"
#	port			"8000"
#	mount			"/mpd.ogg"
#	password		"hackme"
#	quality			"5.0"
#	bitrate			"128"
#	format			"44100:16:1"
#	protocol		"icecast2"		# optional
#	user			"source"		# optional
#	description		"My Stream Description"	# optional
#	genre			"jazz"			# optional
#	public			"no"			# optional
#	timeout			"2"			# optional
199
#}
200
#
Avuton Olrich's avatar
Avuton Olrich committed
201
# An example of a pulseaudio output (streaming to a remote pulseaudio server)
202 203
#
#audio_output {
Avuton Olrich's avatar
Avuton Olrich committed
204 205 206 207
#	type			"pulse"
#	name			"My Pulse Output"
#	server			"remote_server"
#	sink			"remote_server_sink"
208 209
#}
#
Avuton Olrich's avatar
Avuton Olrich committed
210 211 212 213 214 215
## An example of a null output (for no audio output):
#
#audio_output {
#	type			"null"
#	name			"My Null Output"
#}
216
#
217 218 219
# This setting will change all decoded audio to be converted to the specified
# format before being passed to the audio outputs. By default, this setting is
# disabled.
220
#
Avuton Olrich's avatar
Avuton Olrich committed
221
#audio_output_format		"44100:16:2"
222
#
223 224 225 226
# If MPD has been compiled with libsamplerate support, this setting specifies 
# the sample rate converter to use.  Possible values can be found in the 
# mpd.conf man page or the libsamplerate documentation. By default, this is
# setting is disabled.
227
#
Avuton Olrich's avatar
Avuton Olrich committed
228 229 230
#samplerate_converter		"Fastest Sinc Interpolator"
#
###############################################################################
231 232


Avuton Olrich's avatar
Avuton Olrich committed
233
# Volume control mixer ########################################################
Warren Dukes's avatar
Warren Dukes committed
234
#
Avuton Olrich's avatar
Avuton Olrich committed
235
# MPD has limited volume controls, to use them pick one below. If one is not
236 237
# specified it may be autodetected at startup, depending on the dependencies
# which were compiled into the server.
Warren Dukes's avatar
Warren Dukes committed
238
#
239
# An example for controlling an ALSA or OSS mixer:
Warren Dukes's avatar
Warren Dukes committed
240
#
241
#mixer_type			"hardware"
242
#
Avuton Olrich's avatar
Avuton Olrich committed
243
# This example is a general volume control mixer, it is used to adjust the 
244
# volume of the audio sent to the audio output, and will work with all outputs.
245
#
Avuton Olrich's avatar
Avuton Olrich committed
246
#mixer_type			"software"
247
#
Avuton Olrich's avatar
Avuton Olrich committed
248
###############################################################################
249

250

Avuton Olrich's avatar
Avuton Olrich committed
251
# Normalization automatic volume adjustments ##################################
Warren Dukes's avatar
Warren Dukes committed
252
#
253 254 255
# This setting specifies the type of ReplayGain to use. This setting can have
# the argument "album" or "track". See <http://www.replaygain.org> for more
# details. By default this setting is disabled.
Warren Dukes's avatar
Warren Dukes committed
256
#
Avuton Olrich's avatar
Avuton Olrich committed
257
#replaygain			"album"
Warren Dukes's avatar
Warren Dukes committed
258
#
259 260
# 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
261
#
Avuton Olrich's avatar
Avuton Olrich committed
262
#replaygain_preamp		"0"
Warren Dukes's avatar
Warren Dukes committed
263
#
264 265 266
# 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 
# equal "loudness".
Warren Dukes's avatar
Warren Dukes committed
267
#
Avuton Olrich's avatar
Avuton Olrich committed
268
#volume_normalization		"no"
Warren Dukes's avatar
Warren Dukes committed
269
#
Avuton Olrich's avatar
Avuton Olrich committed
270
###############################################################################
271 272


Avuton Olrich's avatar
Avuton Olrich committed
273
# MPD Internal Buffering ######################################################
Warren Dukes's avatar
Warren Dukes committed
274
#
275 276 277
# This setting adjusts the size of internal decoded audio buffering. Changing
# this may have undesired effects. Don't change this if you don't know what you
# are doing.
Warren Dukes's avatar
Warren Dukes committed
278
#
Avuton Olrich's avatar
Avuton Olrich committed
279
#audio_buffer_size		"2048"
Warren Dukes's avatar
Warren Dukes committed
280
#
281 282 283
# This setting controls the percentage of the buffer which is filled before 
# beginning to play. Increasing this reduces the chance of audio file skipping, 
# at the cost of increased time prior to audio playback.
Warren Dukes's avatar
Warren Dukes committed
284
#
Avuton Olrich's avatar
Avuton Olrich committed
285
#buffer_before_play		"10%"
Warren Dukes's avatar
Warren Dukes committed
286
#
Avuton Olrich's avatar
Avuton Olrich committed
287
###############################################################################
288

289

Avuton Olrich's avatar
Avuton Olrich committed
290
# HTTP Streaming Proxy ########################################################
Warren Dukes's avatar
Warren Dukes committed
291
#
292 293
# This setting specifies the HTTP proxy to use for playing HTTP streams. By
# default, these settings will be disabled.
294
#
Avuton Olrich's avatar
Avuton Olrich committed
295 296 297 298
#http_proxy_host		"proxy.isp.com"
#http_proxy_port		"8080"
#http_proxy_user		"user"
#http_proxy_password		"password"
299
#
Avuton Olrich's avatar
Avuton Olrich committed
300
###############################################################################
301 302


Avuton Olrich's avatar
Avuton Olrich committed
303
# Resource Limitations ########################################################
304
#
305 306 307
# These settings are various limitations to prevent MPD from using too many
# resources. Generally, these settings should be minimized to prevent security
# risks, depending on the operating resources.
308
#
Avuton Olrich's avatar
Avuton Olrich committed
309 310 311 312 313
#connection_timeout		"60"
#max_connections		"10"
#max_playlist_length		"16384"
#max_command_list_size		"2048"
#max_output_buffer_size		"8192"
314
#
Avuton Olrich's avatar
Avuton Olrich committed
315
###############################################################################
316 317


Avuton Olrich's avatar
Avuton Olrich committed
318
# Character Encoding ##########################################################
Warren Dukes's avatar
Warren Dukes committed
319
#
320 321 322
# If file or directory names do not display correctly for your locale then you 
# may need to modify this setting. After modification of this setting mpd 
# --create-db must be run to change the database.
Warren Dukes's avatar
Warren Dukes committed
323
#
Avuton Olrich's avatar
Avuton Olrich committed
324
#filesystem_charset		"UTF-8"
Warren Dukes's avatar
Warren Dukes committed
325
#
326
# This setting controls the encoding that ID3v1 tags should be converted from.
Warren Dukes's avatar
Warren Dukes committed
327
#
Avuton Olrich's avatar
Avuton Olrich committed
328
#id3v1_encoding			"ISO-8859-1"
329
#
330
###############################################################################