mpdconf.example 12.1 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
# 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
#
Avuton Olrich's avatar
Avuton Olrich committed
52
###############################################################################
53 54


Avuton Olrich's avatar
Avuton Olrich committed
55
# General music daemon options ################################################
56
#
57 58 59 60
# 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
61
#
Avuton Olrich's avatar
Avuton Olrich committed
62
#user				"nobody"
63
#
64 65 66
# 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
67
#
Avuton Olrich's avatar
Avuton Olrich committed
68 69
# For network
#bind_to_address		"any"
Warren Dukes's avatar
Warren Dukes committed
70
#
Avuton Olrich's avatar
Avuton Olrich committed
71 72
# And for Unix Socket
#bind_to_address		"~/.mpd/socket"
Warren Dukes's avatar
Warren Dukes committed
73
#
74 75
# This setting is the TCP port that is desired for the daemon to get assigned
# to.
Warren Dukes's avatar
Warren Dukes committed
76
#
Avuton Olrich's avatar
Avuton Olrich committed
77
#port				"6600"
78
#
79 80 81 82
# 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.
83
#
Avuton Olrich's avatar
Avuton Olrich committed
84
#log_level			"default"
85
#
Avuton Olrich's avatar
Avuton Olrich committed
86 87 88 89 90
# 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.
91
#
Avuton Olrich's avatar
Avuton Olrich committed
92 93
#gapless_mp3_playback			"yes"
#
94 95
# This setting enables MPD to create playlists in a format usable by other
# music players.
Avuton Olrich's avatar
Avuton Olrich committed
96 97 98
#
#save_absolute_paths_in_playlists	"no"
#
99 100 101
# 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
102 103 104 105
#
#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
#
###############################################################################
106

Avuton Olrich's avatar
Avuton Olrich committed
107

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

Avuton Olrich's avatar
Avuton Olrich committed
122

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


Avuton Olrich's avatar
Avuton Olrich committed
138
# Permissions #################################################################
139
#
140 141
# 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
142
#
143 144
#password                        "password@read,add,control,admin"
#
145
# This setting specifies the permissions a user has who has not yet logged in. 
146
#
147
#default_permissions             "read,add,control,admin"
Warren Dukes's avatar
Warren Dukes committed
148
#
Avuton Olrich's avatar
Avuton Olrich committed
149
###############################################################################
Warren Dukes's avatar
Warren Dukes committed
150

151

152 153 154 155 156 157 158 159 160 161 162 163 164
# Input #######################################################################
#

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

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

Avuton Olrich's avatar
Avuton Olrich committed
165
# Audio Output ################################################################
166
#
167 168 169 170
# 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.
171
#
172 173
# See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of 
# other audio outputs.
174
#
175
# An example of an ALSA output:
176
#
177
#audio_output {
178 179 180 181 182 183
#	type		"alsa"
#	name		"My ALSA Device"
#	device		"hw:0,0"	# optional
#	format		"44100:16:2"	# optional
#	mixer_device	"default"	# optional
#	mixer_control	"PCM"		# optional
184
#	mixer_index	"0"		# optional
185
#}
186
#
187 188 189
# An example of an OSS output:
#
#audio_output {
190 191 192 193 194 195
#	type		"oss"
#	name		"My OSS Device"
#	device		"/dev/dsp"	# optional
#	format		"44100:16:2"	# optional
#	mixer_device	"/dev/mixer"	# optional
#	mixer_control	"PCM"		# optional
196 197 198 199 200
#}
#
# An example of a shout output (for streaming to Icecast):
#
#audio_output {
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
#	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
217
#}
218
#
219 220 221
# An example of a httpd output (built-in HTTP streaming server):
#
#audio_output {
222 223 224 225 226 227 228
#	type		"httpd"
#	name		"My HTTP Stream"
#	encoder		"vorbis"		# optional, vorbis or lame
#	port		"8000"
#	quality		"5.0"			# do not define if bitrate is defined
#	bitrate		"128"			# do not define if quality is defined
#	format		"44100:16:1"
229 230
#}
#
Avuton Olrich's avatar
Avuton Olrich committed
231
# An example of a pulseaudio output (streaming to a remote pulseaudio server)
232 233
#
#audio_output {
234 235 236 237
#	type		"pulse"
#	name		"My Pulse Output"
#	server		"remote_server"		# optional
#	sink		"remote_server_sink"	# optional
238 239
#}
#
240 241 242 243 244 245 246 247 248 249 250 251 252
## 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
253 254 255
## An example of a null output (for no audio output):
#
#audio_output {
256 257
#	type		"null"
#	name		"My Null Output"
Avuton Olrich's avatar
Avuton Olrich committed
258
#}
259
#
260 261 262
# 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.
263
#
Avuton Olrich's avatar
Avuton Olrich committed
264
#audio_output_format		"44100:16:2"
265
#
266 267 268 269
# 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.
270
#
Avuton Olrich's avatar
Avuton Olrich committed
271 272 273
#samplerate_converter		"Fastest Sinc Interpolator"
#
###############################################################################
274 275


Avuton Olrich's avatar
Avuton Olrich committed
276
# Volume control mixer ########################################################
Warren Dukes's avatar
Warren Dukes committed
277
#
278 279 280 281
# These are the global volume control settings. By default, this setting will
# be detected to the available audio output device, with preference going to 
# hardware mixing. Hardware and software mixers for individual audio_output
# sections cannot yet be mixed.
Warren Dukes's avatar
Warren Dukes committed
282
#
283 284 285
# An example for controlling an ALSA, OSS or Pulseaudio mixer; If this
# setting is used other sound applications will be affected by the volume
# being controlled by MPD.
Warren Dukes's avatar
Warren Dukes committed
286
#
287
#mixer_type			"hardware"
288
#
289 290 291
# An example for controlling all mixers through software. This will control
# all controls, even if the mixer is not supported by the device and will not
# affect any other sound producing applications.
292
#
Avuton Olrich's avatar
Avuton Olrich committed
293
#mixer_type			"software"
294
#
295 296
# This example will not allow MPD to touch the mixer at all and will disable
# all volume controls.
297 298 299
#
#mixer_type			"disabled"
#
Avuton Olrich's avatar
Avuton Olrich committed
300
###############################################################################
301

302

Avuton Olrich's avatar
Avuton Olrich committed
303
# Normalization automatic volume adjustments ##################################
Warren Dukes's avatar
Warren Dukes committed
304
#
305 306
# 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
307
# details. This setting is disabled by default.
Warren Dukes's avatar
Warren Dukes committed
308
#
Avuton Olrich's avatar
Avuton Olrich committed
309
#replaygain			"album"
Warren Dukes's avatar
Warren Dukes committed
310
#
311 312
# 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
313
#
Avuton Olrich's avatar
Avuton Olrich committed
314
#replaygain_preamp		"0"
Warren Dukes's avatar
Warren Dukes committed
315
#
316 317
# 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 
318
# equal "loudness". This setting is disabled by default.
Warren Dukes's avatar
Warren Dukes committed
319
#
Avuton Olrich's avatar
Avuton Olrich committed
320
#volume_normalization		"no"
Warren Dukes's avatar
Warren Dukes committed
321
#
Avuton Olrich's avatar
Avuton Olrich committed
322
###############################################################################
323 324


Avuton Olrich's avatar
Avuton Olrich committed
325
# MPD Internal Buffering ######################################################
Warren Dukes's avatar
Warren Dukes committed
326
#
327 328 329
# 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
330
#
Avuton Olrich's avatar
Avuton Olrich committed
331
#audio_buffer_size		"2048"
Warren Dukes's avatar
Warren Dukes committed
332
#
333 334 335
# 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
336
#
Avuton Olrich's avatar
Avuton Olrich committed
337
#buffer_before_play		"10%"
Warren Dukes's avatar
Warren Dukes committed
338
#
Avuton Olrich's avatar
Avuton Olrich committed
339
###############################################################################
340

341

Avuton Olrich's avatar
Avuton Olrich committed
342
# Resource Limitations ########################################################
343
#
344 345 346
# 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.
347
#
Avuton Olrich's avatar
Avuton Olrich committed
348 349 350 351 352
#connection_timeout		"60"
#max_connections		"10"
#max_playlist_length		"16384"
#max_command_list_size		"2048"
#max_output_buffer_size		"8192"
353
#
Avuton Olrich's avatar
Avuton Olrich committed
354
###############################################################################
355 356


Avuton Olrich's avatar
Avuton Olrich committed
357
# Character Encoding ##########################################################
Warren Dukes's avatar
Warren Dukes committed
358
#
359 360 361
# 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
362
#
Avuton Olrich's avatar
Avuton Olrich committed
363
#filesystem_charset		"UTF-8"
Warren Dukes's avatar
Warren Dukes committed
364
#
365
# This setting controls the encoding that ID3v1 tags should be converted from.
Warren Dukes's avatar
Warren Dukes committed
366
#
Avuton Olrich's avatar
Avuton Olrich committed
367
#id3v1_encoding			"ISO-8859-1"
368
#
369
###############################################################################