1# An example configuration file for MPD.
2# Read the user manual for documentation: http://www.musicpd.org/doc/user/
3
4
5# Files and directories #######################################################
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# setting defaults to the XDG directory, otherwise the music directory will be
10# be disabled and audio files will only be accepted over ipc socket (using
11# file:// protocol) or streaming files over an accepted protocol.
12#
13music_directory		"/var/mpd/music"
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.
19#
20playlist_directory		"/var/mpd/.mpd/playlists"
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# server is not up. This setting defaults to disabled which will allow
25# MPD to accept files over ipc socket (using file:// protocol) or streaming
26# files over an accepted protocol.
27#
28db_file			"/var/mpd/.mpd/database"
29
30# These settings are the locations for the daemon log files for the daemon.
31#
32# The special value "syslog" makes MPD use the local syslog daemon. This
33# setting defaults to logging to syslog.
34#
35# If you use systemd, do not configure a log_file.  With systemd, MPD
36# defaults to the systemd journal, which is fine.
37#
38log_file			"/var/mpd/.mpd/log"
39
40# This setting sets the location of the file which stores the process ID
41# 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.
45#
46pid_file			"/var/mpd/.mpd/pid"
47
48# This setting sets the location of the file which contains information about
49# 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.
52#
53state_file			"/var/mpd/.mpd/state"
54#
55# The location of the sticker database.  This is a database which
56# manages dynamic information attached to songs.
57#
58sticker_file			"/var/mpd/.mpd/sticker.sql"
59#
60###############################################################################
61
62
63# General music daemon options ################################################
64#
65# This setting specifies the user that MPD will run as. MPD should never run as
66# root and you may use this setting to make MPD change its user ID after
67# initialization. This setting is disabled by default and MPD is run as the
68# current user.
69#
70user				"mpd"
71#
72# This setting specifies the group that MPD will run as. If not specified
73# primary group of user specified with "user" setting will be used (if set).
74# This is useful if MPD needs to be a member of group such as "audio" to
75# have permission to use sound card.
76#
77#group				"nogroup"
78#
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.
83#
84# For network
85#bind_to_address		"any"
86#
87# And for Unix Socket
88#bind_to_address		"/var/mpd/.mpd/socket"
89#
90# This setting is the TCP port that is desired for the daemon to get assigned
91# to.
92#
93#port				"6600"
94#
95# Suppress all messages below the given threshold.  Use "verbose" for
96# troubleshooting. Available setting arguments are "notice", "info", "verbose",
97# "warning" and "error".
98#
99#log_level			"notice"
100#
101# Setting "restore_paused" to "yes" puts MPD into pause mode instead
102# of starting playback after startup.
103#
104#restore_paused "no"
105#
106# This setting enables MPD to create playlists in a format usable by other
107# music players.
108#
109#save_absolute_paths_in_playlists	"no"
110#
111# This setting defines a list of tag types that will be extracted during the
112# audio file discovery process. The complete list of possible values can be
113# found in the user manual.
114#metadata_to_use	"artist,album,title,track,name,genre,date,composer,performer,disc"
115#
116# This example just enables the "comment" tag without disabling all
117# the other supported tags:
118#metadata_to_use "+comment"
119#
120# This setting enables automatic update of MPD's database when files in
121# music_directory are changed.
122#
123#auto_update	"yes"
124#
125# Limit the depth of the directories being watched, 0 means only watch
126# the music directory itself.  There is no limit by default.
127#
128#auto_update_depth "3"
129#
130###############################################################################
131
132
133# Symbolic link behavior ######################################################
134#
135# If this setting is set to "yes", MPD will discover audio files by following
136# symbolic links outside of the configured music_directory.
137#
138#follow_outside_symlinks	"yes"
139#
140# If this setting is set to "yes", MPD will discover audio files by following
141# symbolic links inside of the configured music_directory.
142#
143#follow_inside_symlinks		"yes"
144#
145###############################################################################
146
147
148# Zeroconf / Avahi Service Discovery ##########################################
149#
150# If this setting is set to "yes", service information will be published with
151# Zeroconf / Avahi.
152#
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#
160###############################################################################
161
162
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.
167#
168#password                        "password@read,add,control,admin"
169#
170# This setting specifies the permissions a user has who has not yet logged in.
171#
172#default_permissions             "read,add,control,admin"
173#
174###############################################################################
175
176
177# Database #######################################################################
178#
179# An example of a database section instead of the old 'db_file' setting.
180# It enables mounting other storages into the music directory.
181#
182#database {
183#       plugin "simple"
184#       path "/var/mpd/.local/share/mpd/db
185#       cache_directory "/var/mpd/.local/share/mpd/cache"
186#}
187#
188# An example of database config for a satellite setup
189#
190#music_directory "nfs://fileserver.local/srv/mp3"
191#database {
192#       plugin "proxy"
193#       host "other.mpd.host"
194#       port "6600"
195#}
196
197# Input #######################################################################
198#
199input {
200        plugin "curl"
201#       proxy "proxy.isp.com:8080"
202#       proxy_user "user"
203#       proxy_password "password"
204}
205
206#
207###############################################################################
208
209# Audio Output ################################################################
210#
211# MPD supports various audio output types, as well as playing through multiple
212# audio outputs at the same time, through multiple audio_output settings
213# blocks. Setting this block is optional, though the server will only attempt
214# autodetection for one sound card.
215#
216# An example of an ALSA output:
217#
218#audio_output {
219#	type		"alsa"
220#	name		"My ALSA Device"
221##	device		"hw:0,0"	# optional
222##	mixer_type      "hardware"	# optional
223##	mixer_device	"default"	# optional
224##	mixer_control	"PCM"		# optional
225##	mixer_index	"0"		# optional
226#}
227#
228# An example of an OSS output:
229#
230audio_output {
231	type		"oss"
232	name		"Default OSS Device"
233##	device		"/dev/dsp"	# optional
234##	mixer_type      "hardware"	# optional
235##	mixer_device	"/dev/mixer"	# optional
236##	mixer_control	"PCM"		# optional
237}
238#
239# An example of a shout output (for streaming to Icecast):
240#
241#audio_output {
242#	type		"shout"
243#	encoder		"vorbis"		# optional
244#	name		"My Shout Stream"
245#	host		"localhost"
246#	port		"8000"
247#	mount		"/mpd.ogg"
248#	password	"hackme"
249#	quality		"5.0"
250#	bitrate		"128"
251#	format		"44100:16:1"
252##	protocol	"icecast2"		# optional
253##	user		"source"		# optional
254##	description	"My Stream Description"	# optional
255##	url		"http://example.com"	# optional
256##	genre		"jazz"			# optional
257##	public		"no"			# optional
258##	timeout		"2"			# optional
259##	mixer_type      "software"		# optional
260#}
261#
262# An example of a recorder output:
263#
264#audio_output {
265#	type		"recorder"
266#	name		"My recorder"
267#	encoder		"vorbis"		# optional, vorbis or lame
268#	path		"/var/lib/mpd/recorder/mpd.ogg"
269##	quality		"5.0"			# do not define if bitrate is defined
270#	bitrate		"128"			# do not define if quality is defined
271#	format		"44100:16:1"
272#}
273#
274# An example of a httpd output (built-in HTTP streaming server):
275#
276#audio_output {
277#	type		"httpd"
278#	name		"My HTTP Stream"
279#	encoder		"vorbis"		# optional, vorbis or lame
280#	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#	bitrate		"128"			# do not define if quality is defined
284#	format		"44100:16:1"
285#	max_clients	"0"			# optional 0=no limit
286#}
287#
288# An example of a pulseaudio output (streaming to a remote pulseaudio server)
289#
290#audio_output {
291#	type		"pulse"
292#	name		"My Pulse Output"
293##	server		"remote_server"		# optional
294##	sink		"remote_server_sink"	# optional
295##	media_role	"media_role"		#optional
296#}
297#
298# An example of a winmm output (Windows multimedia API).
299#
300#audio_output {
301#	type		"winmm"
302#	name		"My WinMM output"
303##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
304#		or
305##	device		"0"		# optional
306##	mixer_type	"hardware"	# optional
307#}
308#
309# An example of a wasapi output (Windows multimedia API).
310#
311#audio_output {
312#	type		"wasapi"
313#	name		"My WASAPI output"
314##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
315#		or
316##	device		"0"		# optional
317## Exclusive mode blocks all other audio source, and get best audio quality without resampling.
318##	exclusive	"no"		# optional
319## Enumerate all devices in log.
320##	enumerate	"no"		# optional
321#}
322#
323# An example of an openal output.
324#
325#audio_output {
326#	type		"openal"
327#	name		"My OpenAL output"
328##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
329#}
330#
331# An example of an sndio output.
332#
333#audio_output {
334#	type		"sndio"
335#	name		"sndio output"
336#	mixer_type	"hardware"
337#}
338#
339# An example of an OS X output:
340#
341#audio_output {
342#	type		"osx"
343#	name		"My OS X Device"
344##	device		"Built-in Output"	# optional
345##	channel_map      "-1,-1,0,1"	# optional
346#}
347#
348## Example "pipe" output:
349#
350#audio_output {
351#	type		"pipe"
352#	name		"my pipe"
353#	command		"aplay -f cd 2>/dev/null"
354## Or if you're want to use AudioCompress
355#	command		"AudioCompress -m | aplay -f cd 2>/dev/null"
356## Or to send raw PCM stream through PCM:
357#	command		"nc example.org 8765"
358#	format		"44100:16:2"
359#}
360#
361## An example of a null output (for no audio output):
362#
363#audio_output {
364#	type		"null"
365#	name		"My Null Output"
366#	mixer_type      "none"			# optional
367#}
368#
369###############################################################################
370
371
372# Normalization automatic volume adjustments ##################################
373#
374# This setting specifies the type of ReplayGain to use. This setting can have
375# the argument "off", "album", "track" or "auto". "auto" is a special mode that
376# chooses between "track" and "album" depending on the current state of
377# random playback. If random playback is enabled then "track" mode is used.
378# See <https://wiki.hydrogenaud.io/index.php?title=Replaygain> for
379# more details about ReplayGain.
380# This setting is off by default.
381#
382#replaygain			"album"
383#
384# This setting sets the pre-amp used for files that have ReplayGain tags. By
385# default this setting is disabled.
386#
387#replaygain_preamp		"0"
388#
389# This setting sets the pre-amp used for files that do NOT have ReplayGain tags.
390# By default this setting is disabled.
391#
392#replaygain_missing_preamp	"0"
393#
394# This setting enables or disables ReplayGain limiting.
395# MPD calculates actual amplification based on the ReplayGain tags
396# and replaygain_preamp / replaygain_missing_preamp setting.
397# If replaygain_limit is enabled MPD will never amplify audio signal
398# above its original level. If replaygain_limit is disabled such amplification
399# might occur. By default this setting is enabled.
400#
401#replaygain_limit		"yes"
402#
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.
406#
407#volume_normalization		"no"
408#
409###############################################################################
410
411# Character Encoding ##########################################################
412#
413# If file or directory names do not display correctly for your locale then you
414# may need to modify this setting.
415#
416#filesystem_charset		"UTF-8"
417#
418###############################################################################
419