You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

397 lines
15 KiB

  1. # A quick guide to configuring forked-daapd:
  2. #
  3. # For regular use, the most important setting to configure is "directories",
  4. # which should be the location of your media. Whatever user you have set as
  5. # "uid" must have read access to this location. If the location is a network
  6. # mount, please see the README.
  7. #
  8. # In all likelihood, that's all you need to do!
  9. general {
  10. # Username
  11. # Make sure the user has read access to the library directories you set
  12. # below, and full access to the databases, log and local audio
  13. uid = "daapd"
  14. # Database location
  15. # db_path = "/var/cache/forked-daapd/songs3.db"
  16. # Log file and level
  17. # Available levels: fatal, log, warning, info, debug, spam
  18. logfile = "/var/log/forked-daapd.log"
  19. loglevel = log
  20. # Admin password for the web interface
  21. # Note that access to the web interface from computers in
  22. # "trusted_network" (see below) does not require password
  23. # admin_password = ""
  24. # Websocket port for the web interface.
  25. # websocket_port = 3688
  26. # Sets who is allowed to connect without authorisation. This applies to
  27. # client types like Remotes, DAAP clients (iTunes) and to the web
  28. # interface. Options are "any", "localhost" or the prefix to one or
  29. # more ipv4/6 networks. The default is { "localhost", "192.168", "fd" }
  30. # trusted_networks = { "localhost", "192.168", "fd" }
  31. # Enable/disable IPv6
  32. ipv6 = no
  33. # Location of cache database
  34. # cache_path = "/var/cache/forked-daapd/cache.db"
  35. # DAAP requests that take longer than this threshold (in msec) get their
  36. # replies cached for next time. Set to 0 to disable caching.
  37. # cache_daap_threshold = 1000
  38. # When starting playback, autoselect speaker (if none of the previously
  39. # selected speakers/outputs are available)
  40. # speaker_autoselect = yes
  41. # Most modern systems have a high-resolution clock, but if you are on an
  42. # unusual platform and experience audio drop-outs, you can try changing
  43. # this option
  44. # high_resolution_clock = yes
  45. }
  46. # Library configuration
  47. library {
  48. # Name of the library as displayed by the clients (%h: hostname). If you
  49. # change the name after pairing with Remote you may have to re-pair.
  50. name = "My Music on %h"
  51. # TCP port to listen on. Default port is 3689 (daap)
  52. port = 3689
  53. # Password for the library. Optional.
  54. # password = ""
  55. # Directories to index
  56. directories = { "/srv/music" }
  57. # Follow symlinks. Default: true.
  58. # follow_symlinks = true
  59. # Directories containing podcasts
  60. # For each directory that is indexed the path is matched against these
  61. # names. If there is a match all items in the directory are marked as
  62. # podcasts. Eg. if you index /srv/music, and your podcasts are in
  63. # /srv/music/Podcasts, you can set this to "/Podcasts".
  64. # (changing this setting only takes effect after rescan, see the README)
  65. podcasts = { "/Podcasts" }
  66. # Directories containing audiobooks
  67. # For each directory that is indexed the path is matched against these
  68. # names. If there is a match all items in the directory are marked as
  69. # audiobooks.
  70. # (changing this setting only takes effect after rescan, see the README)
  71. audiobooks = { "/Audiobooks" }
  72. # Directories containing compilations (eg soundtracks)
  73. # For each directory that is indexed the path is matched against these
  74. # names. If there is a match all items in the directory are marked as
  75. # compilations.
  76. # (changing this setting only takes effect after rescan, see the README)
  77. compilations = { "/Compilations" }
  78. # Compilations usually have many artists, and sometimes no album artist.
  79. # If you don't want every artist to be listed in artist views, you can
  80. # set a single name which will be used for all compilation tracks
  81. # without an album artist, and for all tracks in the compilation
  82. # directories.
  83. # (changing this setting only takes effect after rescan, see the README)
  84. compilation_artist = "Various Artists"
  85. # If your album and artist lists are cluttered, you can choose to hide
  86. # albums and artists with only one track. The tracks will still be
  87. # visible in other lists, e.g. songs and playlists. This setting
  88. # currently only works in some remotes.
  89. # hide_singles = false
  90. # Internet streams in your playlists will by default be shown in the
  91. # "Radio" library, like iTunes does. However, some clients (like
  92. # TunesRemote+) won't show the "Radio" library. If you would also like
  93. # to have them shown like normal playlists, you can enable this option.
  94. # radio_playlists = false
  95. # These are the default playlists. If you want them to have other names,
  96. # you can set it here.
  97. # name_library = "Library"
  98. # name_music = "Music"
  99. # name_movies = "Movies"
  100. # name_tvshows = "TV Shows"
  101. # name_podcasts = "Podcasts"
  102. # name_audiobooks = "Audiobooks"
  103. # name_radio = "Radio"
  104. # Artwork file names (without file type extension)
  105. # forked-daapd will look for jpg and png files with these base names
  106. # artwork_basenames = { "artwork", "cover", "Folder" }
  107. # Enable searching for artwork corresponding to each individual media
  108. # file instead of only looking for album artwork. This is disabled by
  109. # default to reduce cache size.
  110. # artwork_individual = false
  111. # File types the scanner should ignore
  112. # Non-audio files will never be added to the database, but here you
  113. # can prevent the scanner from even probing them. This might improve
  114. # scan time. By default .db, .ini, .db-journal, .pdf and .metadata are
  115. # ignored.
  116. # filetypes_ignore = { ".db", ".ini", ".db-journal", ".pdf", ".metadata" }
  117. # File paths the scanner should ignore
  118. # If you want to exclude files on a more advanced basis you can enter
  119. # one or more POSIX regular expressions, and any file with a matching
  120. # path will be ignored.
  121. # filepath_ignore = { "myregex" }
  122. # Disable startup file scanning
  123. # When forked-daapd starts it will do an initial file scan of your
  124. # library (and then watch it for changes). If you are sure your library
  125. # never changes while forked-daapd is not running, you can disable the
  126. # initial file scan and save some system ressources. Disabling this scan
  127. # may lead to forked-daapd's database coming out of sync with the
  128. # library. If that happens read the instructions in the README on how
  129. # to trigger a rescan.
  130. # filescan_disable = false
  131. # Should iTunes metadata override ours?
  132. # itunes_overrides = false
  133. # Should we import the content of iTunes smart playlists?
  134. # itunes_smartpl = false
  135. # Decoding options for DAAP clients
  136. # Since iTunes has native support for mpeg, mp4a, mp4v, alac and wav,
  137. # such files will be sent as they are. Any other formats will be decoded
  138. # to raw wav. If forked-daapd detects a non-iTunes DAAP client, it is
  139. # assumed to only support mpeg and wav, other formats will be decoded.
  140. # Here you can change when to decode. Note that these settings have no
  141. # effect on AirPlay.
  142. # Formats: mp4a, mp4v, mpeg, alac, flac, mpc, ogg, wma, wmal, wmav, aif, wav
  143. # Formats that should never be decoded
  144. # no_decode = { "format", "format" }
  145. # Formats that should always be decoded
  146. # force_decode = { "format", "format" }
  147. # Watch named pipes in the library for data and autostart playback when
  148. # there is data to be read. To exclude specific pipes from watching,
  149. # consider using the above _ignore options.
  150. # pipe_autostart = true
  151. # Enable automatic rating updates
  152. # If enabled, rating is automatically updated after a song has either been
  153. # played or skipped (only skipping to the next song is taken into account).
  154. # The calculation is taken from the beets plugin "mpdstats" (see
  155. # https://beets.readthedocs.io/en/latest/plugins/mpdstats.html).
  156. # It consist of calculating a stable rating based only on the play- and
  157. # skipcount and a rolling rating based on the current rating and the action
  158. # (played or skipped). Both results are combined with a mix-factor of 0.75:
  159. # new rating = 0.75 * stable rating + 0.25 * rolling rating)
  160. # rating_updates = false
  161. # Allows creating, deleting and modifying m3u playlists in the library directories.
  162. # Only supported by the player web interface and some mpd clients
  163. # Defaults to being disabled.
  164. # allow_modifying_stored_playlists = false
  165. # A directory in one of the library directories that will be used as the default
  166. # playlist directory. forked-dapd creates new playlists in this directory if only
  167. # a playlist name is provided (requires "allow_modify_stored_playlists" set to true).
  168. # default_playlist_directory = ""
  169. }
  170. # Local audio output
  171. audio {
  172. # Name - used in the speaker list in Remote
  173. nickname = "Computer"
  174. # Type of the output (alsa, pulseaudio, dummy or disabled)
  175. # type = "alsa"
  176. # For pulseaudio output, an optional server hostname or IP can be
  177. # specified (e.g. "localhost"). If not set, connection is made via local
  178. # socket.
  179. # server = ""
  180. # Audio PCM device name for local audio output - ALSA only
  181. # card = "default"
  182. # Mixer channel to use for volume control - ALSA only
  183. # If not set, PCM will be used if available, otherwise Master.
  184. # mixer = ""
  185. # Mixer device to use for volume control - ALSA only
  186. # If not set, the value for "card" will be used.
  187. # mixer_device = ""
  188. # Enable or disable audio resampling to keep local audio in sync with
  189. # e.g. Airplay. This feature relies on accurate ALSA measurements of
  190. # delay, and some devices don't provide that. If that is the case you
  191. # are better off disabling the feature.
  192. # sync_disable = false
  193. # Here you can adjust when local audio is started relative to other
  194. # speakers, e.g. Airplay. Negative values correspond to moving local
  195. # audio ahead, positive correspond to delaying it. The unit is
  196. # milliseconds. The offset must be between -1000 and 1000 (+/- 1 sec).
  197. # offset_ms = 0
  198. # To calculate what and if resampling is required, local audio delay is
  199. # measured each second. After a period the collected measurements are
  200. # used to estimate drift and latency, which determines if corrections
  201. # are required. This setting sets the length of that period in seconds.
  202. # adjust_period_seconds = 100
  203. }
  204. # ALSA device settings
  205. # If you have multiple ALSA devices you can configure them individually via
  206. # sections like the below. Make sure to set the "card name" correctly. See the
  207. # README about ALSA for details. Note that these settings will override the ALSA
  208. # settings in the "audio" section above.
  209. #alsa "card name" {
  210. # Name - used in the speaker list in Remote
  211. # If not set, the card name will be used
  212. # nickname = "Computer"
  213. # Mixer channel to use for volume control
  214. # If not set, PCM will be used if available, otherwise Master
  215. # mixer = ""
  216. # Mixer device to use for volume control
  217. # If not set, the card name will be used
  218. # mixer_device = ""
  219. #}
  220. # Pipe output
  221. # Allows forked-daapd to output audio data to a named pipe
  222. #fifo {
  223. # nickname = "fifo"
  224. # path = "/path/to/fifo"
  225. #}
  226. # AirPlay/Airport Express device settings
  227. # (make sure you get the capitalization of the device name right)
  228. #airplay "My AirPlay device" {
  229. # forked-daapd's volume goes to 11! If that's more than you can handle
  230. # you can set a lower value here
  231. # max_volume = 11
  232. # Enable this option to exclude a particular AirPlay device from the
  233. # speaker list
  234. # exclude = false
  235. # Enable this option to keep a particular AirPlay device in the speaker
  236. # list and thus ignore mdns notifications about it no longer being
  237. # present. The speaker will remain until restart of forked-daapd.
  238. # permanent = false
  239. # AirPlay password
  240. # password = "s1kr3t"
  241. #}
  242. # Chromecast settings
  243. # (make sure you get the capitalization of the device name right)
  244. #chromecast "My Chromecast device" {
  245. # Enable this option to exclude a particular device from the speaker
  246. # list
  247. # exclude = false
  248. #}
  249. # Spotify settings (only have effect if Spotify enabled - see README/INSTALL)
  250. spotify {
  251. # Directory where user settings should be stored (credentials)
  252. # settings_dir = "/var/cache/forked-daapd/libspotify"
  253. # Cache directory
  254. # cache_dir = "/tmp"
  255. # Set preferred bitrate for music streaming
  256. # 0: No preference (default), 1: 96kbps, 2: 160kbps, 3: 320kbps
  257. # bitrate = 0
  258. # Your Spotify playlists will by default be put in a "Spotify" playlist
  259. # folder. If you would rather have them together with your other
  260. # playlists you can set this option to true.
  261. # base_playlist_disable = false
  262. # Spotify playlists usually have many artist, and if you don't want
  263. # every artist to be listed when artist browsing in Remote, you can set
  264. # the artist_override flag to true. This will use the compilation_artist
  265. # as album artist for Spotify items.
  266. # artist_override = false
  267. # Similar to the different artists in Spotify playlists, the playlist
  268. # items belong to different albums, and if you do not want every album
  269. # to be listed when browsing in Remote, you can set the album_override
  270. # flag to true. This will use the playlist name as album name for
  271. # Spotify items. Notice that if an item is in more than one playlist,
  272. # it will only appear in one album when browsing (in which album is
  273. # random).
  274. # album_override = false
  275. }
  276. # MPD configuration (only have effect if MPD enabled - see README/INSTALL)
  277. mpd {
  278. # TCP port to listen on for MPD client requests.
  279. # Default port is 6600, set to 0 to disable MPD support.
  280. # port = 6600
  281. # HTTP port to listen for artwork requests (only supported by some MPD
  282. # clients and will need additional configuration in the MPD client to
  283. # work). Set to 0 to disable serving artwork over http.
  284. # http_port = 0
  285. # By default forked-daapd will - like iTunes - clear the playqueue if
  286. # playback stops. Setting clear_queue_on_stop_disable to true will keep
  287. # the playlist like MPD does. Note that some dacp clients do not show
  288. # the playqueue if playback is stopped.
  289. # clear_queue_on_stop_disable = false
  290. }
  291. # SQLite configuration (allows to modify the operation of the SQLite databases)
  292. # Make sure to read the SQLite documentation for the corresponding PRAGMA
  293. # statements as changing them from the defaults may increase the possibility of
  294. # database corruptions! By default the SQLite default values are used.
  295. sqlite {
  296. # Cache size in number of db pages for the library database
  297. # (SQLite default page size is 1024 bytes and cache size is 2000 pages)
  298. # pragma_cache_size_library = 2000
  299. # Cache size in number of db pages for the daap cache database
  300. # (SQLite default page size is 1024 bytes and cache size is 2000 pages)
  301. # pragma_cache_size_cache = 2000
  302. # Sets the journal mode for the database
  303. # DELETE (default), TRUNCATE, PERSIST, MEMORY, WAL, OFF
  304. # pragma_journal_mode = DELETE
  305. # Change the setting of the "synchronous" flag
  306. # 0: OFF, 1: NORMAL, 2: FULL (default)
  307. # pragma_synchronous = 2
  308. # Number of bytes set aside for memory-mapped I/O for the library database
  309. # (requires sqlite 3.7.17 or later)
  310. # 0: disables mmap (default), any other value > 0: number of bytes for mmap
  311. # pragma_mmap_size_library = 0
  312. # Number of bytes set aside for memory-mapped I/O for the cache database
  313. # (requires sqlite 3.7.17 or later)
  314. # 0: disables mmap (default), any other value > 0: number of bytes for mmap
  315. # pragma_mmap_size_cache = 0
  316. # Should the database be vacuumed on startup? (increases startup time,
  317. # but may reduce database size). Default is yes.
  318. # vacuum = yes
  319. }
  320. # Streaming audio settings for remote connections (ie stream.mp3)
  321. streaming {
  322. # Sample rate, typically 44100 or 48000
  323. # sample_rate = 44100
  324. # Set the MP3 streaming bit rate (in kbps), valid options: 64 / 96 / 128 / 192 / 320
  325. # bit_rate = 192
  326. }