mpd/.config/mpd/mpd.conf (view raw)
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 "~/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#
20# playlist_directory "~/.config/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 "~/.config/mpd/database"
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.
36#
37log_file "~/.config/mpd/log"
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#
43pid_file "~/.config/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 "~/.config/mpd/state"
51#
52# The location of the sticker database. This is a database which
53# manages dynamic information attached to songs.
54#
55sticker_file "~/.config/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#
67#user "nobody"
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#
74#group "nogroup"
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 than the default, any.
78# This setting can deny access to control of the daemon. Not effective if
79# systemd socket activiation is in use.
80#
81# For network
82bind_to_address "localhost"
83#
84# And for Unix Socket
85#bind_to_address "~/.mpd/socket"
86#
87# This setting is the TCP port that is desired for the daemon to get assigned
88# to.
89#
90port "6600"
91#
92# Suppress all messages below the given threshold. Use "verbose" for
93# troubleshooting. Available setting arguments are "notice", "info", "verbose",
94# "warning" and "error".
95#
96#log_level "notice"
97#
98# Setting "restore_paused" to "yes" puts MPD into pause mode instead
99# of starting playback after startup.
100#
101#restore_paused "no"
102#
103# This setting enables MPD to create playlists in a format usable by other
104# music players.
105#
106#save_absolute_paths_in_playlists "no"
107#
108# This setting defines a list of tag types that will be extracted during the
109# audio file discovery process. The complete list of possible values can be
110# found in the user manual.
111#metadata_to_use "artist,album,title,track,name,genre,date,composer,performer,disc"
112#
113# This example just enables the "comment" tag without disabling all
114# the other supported tags:
115#metadata_to_use "+comment"
116#
117# This setting enables automatic update of MPD's database when files in
118# music_directory are changed.
119#
120auto_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. %h will be replaced with the hostname.
154#
155#zeroconf_name "Music Player @ %h"
156#
157###############################################################################
158
159
160# Permissions #################################################################
161#
162# If this setting is set, MPD will require password authorization. The password
163# 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# Database #######################################################################
175#
176# An example of a database section instead of the old 'db_file' setting.
177# It enables mounting other storages into the music directory.
178#
179#database {
180# plugin "simple"
181# path "~/.local/share/mpd/db
182# cache_directory "~/.local/share/mpd/cache"
183#}
184#
185# An example of database config for a sattelite setup
186#
187#music_directory "nfs://fileserver.local/srv/mp3"
188#database {
189# plugin "proxy"
190# host "other.mpd.host"
191# port "6600"
192#}
193
194# Input #######################################################################
195#
196input {
197 plugin "curl"
198# proxy "proxy.isp.com:8080"
199# proxy_user "user"
200# proxy_password "password"
201}
202
203#
204###############################################################################
205
206# Audio Output ################################################################
207#
208# MPD supports various audio output types, as well as playing through multiple
209# audio outputs at the same time, through multiple audio_output settings
210# blocks. Setting this block is optional, though the server will only attempt
211# autodetection for one sound card.
212#
213
214# An example of an ALSA output:
215#
216# audio_output {
217# type "alsa"
218# name "alsa"
219# device "pulse" # optional
220# ## mixer_type "hardware" # optional
221# ## mixer_device "default" # optional
222# ## mixer_control "PCM" # optional
223# ## mixer_index "0" # optional
224# }
225
226# An example of an OSS output:
227#
228#audio_output {
229# type "oss"
230# name "My OSS Device"
231## device "/dev/dsp" # optional
232## mixer_type "hardware" # optional
233## mixer_device "/dev/mixer" # optional
234## mixer_control "PCM" # optional
235#}
236#
237# An example of a shout output (for streaming to Icecast):
238#
239#audio_output {
240# type "shout"
241# encoder "vorbis" # optional
242# name "My Shout Stream"
243# host "localhost"
244# port "8000"
245# mount "/mpd.ogg"
246# password "hackme"
247# quality "5.0"
248# bitrate "128"
249# format "44100:16:1"
250## protocol "icecast2" # optional
251## user "source" # optional
252## description "My Stream Description" # optional
253## url "http://example.com" # optional
254## genre "jazz" # optional
255## public "no" # optional
256## timeout "2" # optional
257## mixer_type "software" # optional
258#}
259#
260# An example of a recorder output:
261#
262#audio_output {
263# type "recorder"
264# name "My recorder"
265# encoder "vorbis" # optional, vorbis or lame
266# path "/var/lib/mpd/recorder/mpd.ogg"
267## quality "5.0" # do not define if bitrate is defined
268# bitrate "128" # do not define if quality is defined
269# format "44100:16:1"
270#}
271#
272# An example of a httpd output (built-in HTTP streaming server):
273#
274#audio_output {
275# type "httpd"
276# name "My HTTP Stream"
277# encoder "vorbis" # optional, vorbis or lame
278# port "8000"
279# bind_to_address "0.0.0.0" # optional, IPv4 or IPv6
280## quality "5.0" # do not define if bitrate is defined
281# bitrate "128" # do not define if quality is defined
282# format "44100:16:1"
283# max_clients "0" # optional 0=no limit
284#}
285#
286# An example of a pulseaudio output (streaming to a remote pulseaudio server)
287#
288#audio_output {
289 #type "pulse"
290 #name "My Pulse Output"
291## server "remote_server" # optional
292## sink "remote_server_sink" # optional
293## media_role "media_role" #optional
294#}
295#
296# An example of a winmm output (Windows multimedia API).
297#
298#audio_output {
299# type "winmm"
300# name "My WinMM output"
301## device "Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
302# or
303## device "0" # optional
304## mixer_type "hardware" # optional
305#}
306#
307# An example of a wasapi output (Windows multimedia API).
308#
309#audio_output {
310# type "wasapi"
311# name "My WASAPI output"
312## device "Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
313# or
314## device "0" # optional
315## Exclusive mode blocks all other audio source, and get best audio quality without resampling.
316## exclusive "no" # optional
317## Enumerate all devices in log.
318## enumerate "no" # optional
319#}
320#
321# An example of an openal output.
322#
323#audio_output {
324# type "openal"
325# name "My OpenAL output"
326## device "Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
327#}
328#
329# An example of an sndio output.
330#
331#audio_output {
332# type "sndio"
333# name "sndio output"
334# mixer_type "hardware"
335#}
336#
337# An example of an OS X output:
338#
339#audio_output {
340# type "osx"
341# name "My OS X Device"
342## device "Built-in Output" # optional
343## channel_map "-1,-1,0,1" # optional
344#}
345#
346## Example "pipe" output:
347#
348#audio_output {
349# type "pipe"
350# name "my pipe"
351# command "aplay -f cd 2>/dev/null"
352## Or if you're want to use AudioCompress
353# command "AudioCompress -m | aplay -f cd 2>/dev/null"
354## Or to send raw PCM stream through PCM:
355# command "nc example.org 8765"
356# format "44100:16:2"
357#}
358#
359## An example of a null output (for no audio output):
360#
361#audio_output {
362# type "null"
363# name "My Null Output"
364# mixer_type "none" # optional
365#}
366#
367###############################################################################
368
369
370# Normalization automatic volume adjustments ##################################
371#
372# This setting specifies the type of ReplayGain to use. This setting can have
373# the argument "off", "album", "track" or "auto". "auto" is a special mode that
374# chooses between "track" and "album" depending on the current state of
375# random playback. If random playback is enabled then "track" mode is used.
376# See <https://wiki.hydrogenaud.io/index.php?title=Replaygain> for
377# more details about ReplayGain.
378# This setting is off by default.
379#
380#replaygain "album"
381#
382# This setting sets the pre-amp used for files that have ReplayGain tags. By
383# default this setting is disabled.
384#
385#replaygain_preamp "0"
386#
387# This setting sets the pre-amp used for files that do NOT have ReplayGain tags.
388# By default this setting is disabled.
389#
390#replaygain_missing_preamp "0"
391#
392# This setting enables or disables ReplayGain limiting.
393# MPD calculates actual amplification based on the ReplayGain tags
394# and replaygain_preamp / replaygain_missing_preamp setting.
395# If replaygain_limit is enabled MPD will never amplify audio signal
396# above its original level. If replaygain_limit is disabled such amplification
397# might occur. By default this setting is enabled.
398#
399#replaygain_limit "yes"
400#
401# This setting enables on-the-fly normalization volume adjustment. This will
402# result in the volume of all playing audio to be adjusted so the output has
403# equal "loudness". This setting is disabled by default.
404#
405#volume_normalization "no"
406#
407###############################################################################
408
409# Character Encoding ##########################################################
410#
411# If file or directory names do not display correctly for your locale then you
412# may need to modify this setting.
413#
414#filesystem_charset "UTF-8"
415#
416###############################################################################