blob: f9f92c98bdf4aa31be17bc01e9ded46ce1147bdb [file] [log] [blame]
Patrick Williamsb48b7b42016-08-17 15:04:38 -05001# An example configuration file for MPD
2# See the mpd.conf man page for a more detailed description of each parameter.
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 "%music_directory%"
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 "%playlist_directory%"
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 "%db_file%"
29#
30# These settings are the locations for the daemon log files for the daemon.
31# These logs are great for troubleshooting, depending on your log_level
32# settings.
33#
34# The special value "syslog" makes MPD use the local syslog daemon. This
35# setting defaults to logging to syslog, otherwise logging is disabled.
36#
37log_file "%log_file%"
38#
39# This setting sets the location of the file which stores the process ID
40# 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#
43#pid_file "/var/run/mpd/mpd.pid"
44#
45# This setting sets the location of the file which contains information about
46# 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.
49#
50state_file "%state_file%"
51#
52# The location of the sticker database. This is a database which
53# manages dynamic information attached to songs.
54#
55#sticker_file "~/.mpd/sticker.sql"
56#
57###############################################################################
58
59
60# General music daemon options ################################################
61#
62# This setting specifies the user that MPD will run as. MPD should never run as
63# root and you may use this setting to make MPD change its user ID after
64# initialization. This setting is disabled by default and MPD is run as the
65# current user.
66#
67user "mpd"
68#
69# This setting specifies the group that MPD will run as. If not specified
70# primary group of user specified with "user" setting will be used (if set).
71# This is useful if MPD needs to be a member of group such as "audio" to
72# have permission to use sound card.
73#
74group "audio"
75#
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 then the default, any.
78# This setting can deny access to control of the daemon.
79#
80# For network
81bind_to_address "any"
82#
83# And for Unix Socket
84#bind_to_address "~/.mpd/socket"
85#
86# This setting is the TCP port that is desired for the daemon to get assigned
87# to.
88#
89#port "6600"
90#
91# This setting controls the type of information which is logged. Available
92# setting arguments are "default", "secure" or "verbose". The "verbose" setting
93# argument is recommended for troubleshooting, though can quickly stretch
94# available resources on limited hardware storage.
95#
96#log_level "default"
97#
98# If you have a problem with your MP3s ending abruptly it is recommended that
99# you set this argument to "no" to attempt to fix the problem. If this solves
100# the problem, it is highly recommended to fix the MP3 files with vbrfix
101# (available from <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
102# point gapless MP3 playback can be enabled.
103#
104#gapless_mp3_playback "yes"
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. Optionally, 'comment' can be added to this
113# list.
114#
115#metadata_to_use "artist,album,title,track,name,genre,date,composer,performer,disc"
116#
117# This setting enables automatic update of MPD's database when files in
118# music_directory are changed.
119#
120#auto_update "yes"
121#
122# Limit the depth of the directories being watched, 0 means only watch
123# the music directory itself. There is no limit by default.
124#
125#auto_update_depth "3"
126#
127###############################################################################
128
129
130# Symbolic link behavior ######################################################
131#
132# If this setting is set to "yes", MPD will discover audio files by following
133# symbolic links outside of the configured music_directory.
134#
135#follow_outside_symlinks "yes"
136#
137# If this setting is set to "yes", MPD will discover audio files by following
138# symbolic links inside of the configured music_directory.
139#
140#follow_inside_symlinks "yes"
141#
142###############################################################################
143
144
145# Zeroconf / Avahi Service Discovery ##########################################
146#
147# If this setting is set to "yes", service information will be published with
148# Zeroconf / Avahi.
149#
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.
154#
155#zeroconf_name "Music Player"
156#
157###############################################################################
158
159
160# Permissions #################################################################
161#
162# If this setting is set, MPD will require password authorization. The password
163# can setting can be specified multiple times for different password profiles.
164#
165#password "password@read,add,control,admin"
166#
167# This setting specifies the permissions a user has who has not yet logged in.
168#
169#default_permissions "read,add,control,admin"
170#
171###############################################################################
172
173
174# Input #######################################################################
175#
176
177input {
178 plugin "curl"
179# proxy "proxy.isp.com:8080"
180# proxy_user "user"
181# proxy_password "password"
182}
183
184#
185###############################################################################
186
187# Audio Output ################################################################
188#
189# MPD supports various audio output types, as well as playing through multiple
190# audio outputs at the same time, through multiple audio_output settings
191# blocks. Setting this block is optional, though the server will only attempt
192# autodetection for one sound card.
193#
194# See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of
195# other audio outputs.
196#
197# board specific examples #####################################################
198# (feel free to add futher)
199#
200# gumstix overo (tested with TOBI expansion board)
201#audio_output {
202# type "alsa"
203# name "overo"
204# mixer_control "Headset"
205# mixer_index "0"
206#}
207#
208# general examples ############################################################
209#
210# An example of an ALSA output:
211#
212#audio_output {
213# type "alsa"
214# name "My ALSA Device"
215## device "hw:0,0" # optional
216## format "44100:16:2" # optional
217## mixer_type "hardware" # optional
218## mixer_device "default" # optional
219## mixer_control "PCM" # optional
220## mixer_index "0" # optional
221#}
222#
223# An example of an OSS output:
224#
225#audio_output {
226# type "oss"
227# name "My OSS Device"
228## device "/dev/dsp" # optional
229## format "44100:16:2" # optional
230## mixer_type "hardware" # optional
231## mixer_device "/dev/mixer" # optional
232## mixer_control "PCM" # optional
233#}
234#
235# An example of a shout output (for streaming to Icecast):
236#
237#audio_output {
238# type "shout"
239# encoding "ogg" # optional
240# name "My Shout Stream"
241# host "localhost"
242# port "8000"
243# mount "/mpd.ogg"
244# password "hackme"
245# quality "5.0"
246# bitrate "128"
247# format "44100:16:1"
248## protocol "icecast2" # optional
249## user "source" # optional
250## description "My Stream Description" # optional
251## genre "jazz" # optional
252## public "no" # optional
253## timeout "2" # optional
254## mixer_type "software" # optional
255#}
256#
257# An example of a recorder output:
258#
259#audio_output {
260# type "recorder"
261# name "My recorder"
262# encoder "vorbis" # optional, vorbis or lame
263# path "/var/lib/mpd/recorder/mpd.ogg"
264## quality "5.0" # do not define if bitrate is defined
265# bitrate "128" # do not define if quality is defined
266# format "44100:16:1"
267#}
268#
269# An example of a httpd output (built-in HTTP streaming server):
270#
271#audio_output {
272# type "httpd"
273# name "My HTTP Stream"
274# encoder "vorbis" # optional, vorbis or lame
275# port "8000"
276# bind_to_address "0.0.0.0" # optional, IPv4 or IPv6
277## quality "5.0" # do not define if bitrate is defined
278# bitrate "128" # do not define if quality is defined
279# format "44100:16:1"
280# max_clients "0" # optional 0=no limit
281#}
282#
283# An example of a pulseaudio output (streaming to a remote pulseaudio server)
284#
285#audio_output {
286# type "pulse"
287# name "My Pulse Output"
288## server "remote_server" # optional
289## sink "remote_server_sink" # optional
290#}
291#
292## Example "pipe" output:
293#
294#audio_output {
295# type "pipe"
296# name "my pipe"
297# command "aplay -f cd 2>/dev/null"
298## Or if you're want to use AudioCompress
299# command "AudioCompress -m | aplay -f cd 2>/dev/null"
300## Or to send raw PCM stream through PCM:
301# command "nc example.org 8765"
302# format "44100:16:2"
303#}
304#
305## An example of a null output (for no audio output):
306#
307#audio_output {
308# type "null"
309# name "My Null Output"
310# mixer_type "none" # optional
311#}
312#
313# This setting will change all decoded audio to be converted to the specified
314# format before being passed to the audio outputs. By default, this setting is
315# disabled.
316#
317#audio_output_format "44100:16:2"
318#
319# If MPD has been compiled with libsamplerate support, this setting specifies
320# the sample rate converter to use. Possible values can be found in the
321# mpd.conf man page or the libsamplerate documentation. By default, this is
322# setting is disabled.
323#
324#samplerate_converter "Fastest Sinc Interpolator"
325#
326###############################################################################
327
328
329# Normalization automatic volume adjustments ##################################
330#
331# This setting specifies the type of ReplayGain to use. This setting can have
332# the argument "off", "album" or "track". See <http://www.replaygain.org>
333# for more details. This setting is off by default.
334#
335#replaygain "album"
336#
337# This setting sets the pre-amp used for files that have ReplayGain tags. By
338# default this setting is disabled.
339#
340#replaygain_preamp "0"
341#
342# This setting enables on-the-fly normalization volume adjustment. This will
343# result in the volume of all playing audio to be adjusted so the output has
344# equal "loudness". This setting is disabled by default.
345#
346#volume_normalization "no"
347#
348###############################################################################
349
350
351# MPD Internal Buffering ######################################################
352#
353# This setting adjusts the size of internal decoded audio buffering. Changing
354# this may have undesired effects. Don't change this if you don't know what you
355# are doing.
356#
357#audio_buffer_size "2048"
358#
359# This setting controls the percentage of the buffer which is filled before
360# beginning to play. Increasing this reduces the chance of audio file skipping,
361# at the cost of increased time prior to audio playback.
362#
363#buffer_before_play "10%"
364#
365###############################################################################
366
367
368# Resource Limitations ########################################################
369#
370# These settings are various limitations to prevent MPD from using too many
371# resources. Generally, these settings should be minimized to prevent security
372# risks, depending on the operating resources.
373#
374#connection_timeout "60"
375#max_connections "10"
376#max_playlist_length "16384"
377#max_command_list_size "2048"
378#max_output_buffer_size "8192"
379#
380###############################################################################
381
382
383# Character Encoding ##########################################################
384#
385# If file or directory names do not display correctly for your locale then you
386# may need to modify this setting.
387#
388#filesystem_charset "UTF-8"
389#
390# This setting controls the encoding that ID3v1 tags should be converted from.
391#
392#id3v1_encoding "ISO-8859-1"
393#
394###############################################################################
395
396
397# SIDPlay decoder #############################################################
398#
399# songlength_database:
400# Location of your songlengths file, as distributed with the HVSC.
401# The sidplay plugin checks this for matching MD5 fingerprints.
402# See http://www.c64.org/HVSC/DOCUMENTS/Songlengths.faq
403#
404# default_songlength:
405# This is the default playing time in seconds for songs not in the
406# songlength database, or in case you're not using a database.
407# A value of 0 means play indefinitely.
408#
409# filter:
410# Turns the SID filter emulation on or off.
411#
412#decoder {
413# plugin "sidplay"
414# songlength_database "/media/C64Music/DOCUMENTS/Songlengths.txt"
415# default_songlength "120"
416# filter "true"
417#}
418#
419###############################################################################
420