Fresh pull from upstream (stable) package feed
[librecmc/package-feed.git] / sound / forked-daapd / files / forked-daapd.conf
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
10 general {
11         # Username
12         # Make sure the user has read access to the library directories you set
13         # below, and full access to the databases, log and local audio
14         uid = "daapd"
15
16         # Database location
17         db_path = "/var/cache/forked-daapd/songs3.db"
18
19         # Log file and level
20         # Available levels: fatal, log, warning, info, debug, spam
21         logfile = "/var/log/forked-daapd.log"
22         loglevel = log
23
24         # Admin password for the non-existent web interface
25         admin_password = "unused"
26
27         # Enable/disable IPv6
28         ipv6 = no
29
30         # Location of cache database
31         cache_path = "/var/cache/forked-daapd/cache.db"
32
33         # DAAP requests that take longer than this threshold (in msec) get their
34         # replies cached for next time. Set to 0 to disable caching.
35 #       cache_daap_threshold = 1000
36 }
37
38 # Library configuration
39 library {
40         # Name of the library as displayed by the clients
41         # %h: hostname, %v: version
42         name = "My Music on %h"
43
44         # TCP port to listen on. Default port is 3689 (daap)
45         port = 3689
46
47         # Password for the library. Optional.
48 #       password = ""
49
50         # Directories to index
51         directories = { "/srv/music" }
52
53         # Directories containing podcasts
54         # For each directory that is indexed the path is matched against these
55         # names. If there is a match all items in the directory are marked as 
56         # podcasts. Eg. if you index /srv/music, and your podcasts are in
57         # /srv/music/Podcasts, you can set this to "/Podcasts".
58         # (changing this setting only takes effect after rescan, see the README)
59         podcasts = { "/Podcasts" }
60
61         # Directories containing audiobooks
62         # For each directory that is indexed the path is matched against these
63         # names. If there is a match all items in the directory are marked as 
64         # audiobooks.
65         # (changing this setting only takes effect after rescan, see the README)
66         audiobooks = { "/Audiobooks" }
67
68         # Directories containing compilations (eg soundtracks)
69         # For each directory that is indexed the path is matched against these
70         # names. If there is a match all items in the directory are marked as 
71         # compilations.
72         # (changing this setting only takes effect after rescan, see the README)
73         compilations = { "/Compilations" }
74
75         # Compilations usually have many artists, and if you don't want every
76         # artist to be listed when artist browsing in Remote, you can set
77         # a single name which will be used for all music in the compilation dir
78         # (changing this setting only takes effect after rescan, see the README)
79         compilation_artist = "Various artists"
80
81         # Internet streams in your playlists will by default be shown in the
82         # "Radio" library, like iTunes does. However, some clients (like
83         # TunesRemote+) won't show the "Radio" library. If you would also like
84         # to have them shown like normal playlists, you can enable this option.
85 #       radio_playlists = false
86
87         # There are 5 default playlists: "Library", "Music", "Movies", "TV Shows"
88         # and "Podcasts". Here you can change the names of these playlists.
89 #       name_library    = "Library"
90 #       name_music      = "Music"
91 #       name_movies     = "Movies"
92 #       name_tvshows    = "TV Shows"
93 #       name_podcasts   = "Podcasts"
94 #       name_audiobooks = "Audiobooks"
95 #       name_radio      = "Radio"
96
97         # Artwork file names (without file type extension)
98         # forked-daapd will look for jpg and png files with these base names
99 #       artwork_basenames = { "artwork", "cover", "Folder" }
100
101         # Enable searching for artwork corresponding to each individual media
102         # file instead of only looking for album artwork. This is disabled by
103         # default to reduce cache size.
104 #       artwork_individual = false
105
106         # File types the scanner should ignore
107         # Non-audio files will never be added to the database, but here you
108         # can prevent the scanner from even probing them. This might improve
109         # scan time. By default .db, .ini, .db-journal and .pdf are ignored.
110 #       filetypes_ignore = { ".db", ".ini", ".db-journal", ".pdf" }
111
112         # File paths the scanner should ignore
113         # If you want to exclude files on a more advanced basis you can enter
114         # one or more POSIX regular expressions, and any file with a matching
115         # path will be ignored.
116 #       filepath_ignore = { "myregex" }
117
118         # Disable startup file scanning
119         # When forked-daapd starts it will do an initial file scan of your
120         # library (and then watch it for changes). If you are sure your library
121         # never changes while forked-daapd is not running, you can disable the
122         # initial file scan and save some system ressources. Disabling this scan
123         # may lead to forked-daapd's database coming out of sync with the
124         # library. If that happens read the instructions in the README on how
125         # to trigger a rescan.
126 #       filescan_disable = false
127
128         # Should iTunes metadata override ours?
129 #       itunes_overrides = false
130
131         # Formats: mp4a, mp4v, mpeg, alac, flac, mpc, ogg, wma, wmal, wmav, aif, wav
132         # Formats that should never be transcoded
133 #       no_transcode = { "alac", "mp4a" }
134         # Formats that should always be transcoded
135 #       force_transcode = { "ogg", "flac" }
136 }
137
138 # Local audio output
139 audio {
140         # Name - used in the speaker list in Remote
141         nickname = "OpenWrt"
142
143         # Audio device name for local audio output
144 #       card = "default"
145
146         # Mixer channel to use for volume control - ALSA/Linux only
147         # If not set, PCM will be used if available, otherwise Master.
148 #       mixer = ""
149 }
150
151 # AirPlay/Airport Express device settings
152 # (make sure you get the capitalization of the device name right)
153 #airplay "My AirPlay device" {
154         # forked-daapd's volume goes to 11! If that's more than you can handle
155         # you can set a lower value here
156 #       max_volume = 11
157
158         # AirPlay password
159 #       password = "s1kr3t"
160 #}
161
162 # SQLite configuration (allows to modify the operation of the SQLite databases)
163 # Make sure to read the SQLite documentation for the corresponding PRAGMA statements as
164 # changing them from the defaults may increase the possibility of database corruptions!
165 # By default the SQLite default values are used. 
166 sqlite {
167         # Cache size in number of db pages for the library database
168         # (SQLite default page size is 1024 bytes and cache size is 2000 pages)
169 #       pragma_cache_size_library = 2000
170         
171         # Cache size in number of db pages for the daap cache database
172         # (SQLite default page size is 1024 bytes and cache size is 2000 pages)
173 #       pragma_cache_size_cache = 2000
174         
175         # Sets the journal mode for the database
176         # DELETE (default), TRUNCATE, PERSIST, MEMORY, WAL, OFF 
177 #       pragma_journal_mode = DELETE
178         
179         # Change the setting of the "synchronous" flag
180         # 0: OFF, 1: NORMAL, 2: FULL (default)
181 #       pragma_synchronous = 2
182
183         # Should the database be vacuumed on startup? (increases startup time,
184         # but may reduce database size). Default is yes.
185 #       vacuum = yes
186 }
187