supysonic/config.sample

[base]
; A database URI. See the 'schema' folder for schema creation scripts. Note that
; you don't have to run these scripts yourself.
; Default: sqlite:////tmp/supysonic/supysonic.db
;database_uri = sqlite:////var/supysonic/supysonic.db
;database_uri = mysql://supysonic:supysonic@localhost/supysonic
;database_uri = postgres://supysonic:supysonic@localhost/supysonic

; Optional, restrict scanner to these extensions. Default: none
;scanner_extensions = mp3 ogg

; Should the scanner follow symbolic links? Default: no
follow_symlinks = no

[webapp]
; Optional cache directory. Default: /tmp/supysonic
cache_dir = /var/supysonic/cache

; Main cache max size in MB. Default: 512
cache_size = 512

; Transcode cache max size in MB. Default: 1024 (1GB)
transcode_cache_size = 1024

; Optional rotating log file. Default: none
log_file = /var/supysonic/supysonic.log

; Log level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL.
; Default: WARNING
log_level = WARNING

; Enable the Subsonic REST API. You'll most likely want to keep this on, here
; for testing purposes. Default: on
;mount_api = on

; Enable the administrative web interface. Default: on
;mount_webui = on

; Space separated list of prefixes that should be ignored on index endpoints
; Default: El La Le Las Les Los The
index_ignored_prefixes = El La Le Las Les Los The

[daemon]
; Socket file the daemon will listen on for incoming management commands
; Default: /tmp/supysonic/supysonic.sock
socket = /var/run/supysonic.sock

; Defines if the file watcher should be started. Default: yes
run_watcher = yes

; Delay in seconds before triggering scanning operation after a change have been
; detected.
; This prevents running too many scans when multiple changes are detected for a
; single file over a short time span. Default: 5
wait_delay = 5

; Command used by the jukebox
jukebox_command = mplayer -ss %offset %path

; Optional rotating log file for the scanner daemon. Logs to stderr if empty
log_file = /var/supysonic/supysonic-daemon.log
log_level = INFO

[lastfm]
; API and secret key to enable scrobbling. http://www.last.fm/api/accounts
; Defaults: none
;api_key =
;secret =

[transcoding]
; Programs used to convert from one format/bitrate to another. Defaults: none
transcoder_mp3_mp3 = lame --quiet --mp3input -b %outrate %srcpath -
transcoder = ffmpeg -i %srcpath -ab %outratek -v 0 -f %outfmt -
decoder_mp3 = mpg123 --quiet -w - %srcpath
decoder_ogg = oggdec -o %srcpath
decoder_flac = flac -d -c -s %srcpath
encoder_mp3 = lame --quiet -b %outrate - -
encoder_ogg = oggenc2 -Q -M %outrate -

; Default format, used when a client requests a bitrate lower than the original
; file and no specific format
default_transcode_target = mp3

[mimetypes]
; Extension to mimetype mappings in case your system has some trouble guessing
; Default: none
;mp3 = audio/mpeg
;ogg = audio/vorbis
Added configuration sample file 2015-04-05 13:12:45 +00:00			`[base]`
Add ignored articles support Closes #200 2020-11-09 16:31:04 +00:00			`; A database URI. See the 'schema' folder for schema creation scripts. Note that`
			`; you don't have to run these scripts yourself.`
Reworked and split documentation 2018-02-14 18:45:39 +00:00			`; Default: sqlite:////tmp/supysonic/supysonic.db`
Config sample update 2017-11-29 19:09:48 +00:00			`;database_uri = sqlite:////var/supysonic/supysonic.db`
			`;database_uri = mysql://supysonic:supysonic@localhost/supysonic`
			`;database_uri = postgres://supysonic:supysonic@localhost/supysonic`
Added configuration sample file 2015-04-05 13:12:45 +00:00
Config sample update 2017-11-29 19:09:48 +00:00			`; Optional, restrict scanner to these extensions. Default: none`
			`;scanner_extensions = mp3 ogg`
Add new secret_key option to config.sample 2017-08-07 09:52:16 +00:00
Added setting to follow symlinks #48, #146 2019-07-06 15:04:08 +00:00			`; Should the scanner follow symbolic links? Default: no`
			`follow_symlinks = no`

Updated configuration sample 2015-04-05 14:17:47 +00:00			`[webapp]`
Config sample update 2017-11-29 19:09:48 +00:00			`; Optional cache directory. Default: /tmp/supysonic`
Added configuration sample file 2015-04-05 13:12:45 +00:00			`cache_dir = /var/supysonic/cache`

Implement a cache manager for album art and transcodes Quick summary ------------- - Adds a Cache class (plus tests for it) that provides an API for managing a cache of files on disk - Adds two new settings to the configuration file: `cache_size` (default 512MB) and `transcode_cache_size` (default 1GB). - Creates two cache managers using the settings above: one for general stuff (currently album art) and one for transcodes - Adds the caching of transcoded files to disk for future use - Modifies the existing image caching to use the cache manager Longer explanations and justifications -------------------------------------- The reason I separated out transcodes into an entirely separate cache is that I could imagine a single transcode pushing out a ton of smaller images or other cached content. By separating them it should reduce the number of deletes caused by adding something to the cache. The cache manager allows for caching a value from a generator via passthrough. This means that a generator can be transparently wrapped to save its output in the cache. The bytes from the generator will be written to a temp file in the cache and yielded back. When it completes, the temp file will be renamed according to the provided cache key. This is how caching transcoded music is implemented. If multiple generators for the same key are started, they will all write to individual temp files until they complete and race to overwrite each other. Since the key should uniquely represent the content it indexes the files will be identical so overwriting them is harmless. The cache will store everything for a minimum amount of time (configurable, default is set at 5 minutes). After this time has elapsed, the data can be deleted to free up space. This minimum is so that when you cache a file to the disk you can expect it to be there after, even if another large file is added to the cache and requests that some files are deleted to make space. To ensure that a file will not be paged out of the cache regardless of the minimum time, there is a `protect` context manager that will refuse the delete the key from the cache as long as it's active. The cache has a maximum size, however this is more of a recommendation as opposed to a hard limit. The actual size will frequently exceed the limit temporarily until something can be paged out. 2019-01-14 06:46:21 +00:00			`; Main cache max size in MB. Default: 512`
			`cache_size = 512`

			`; Transcode cache max size in MB. Default: 1024 (1GB)`
			`transcode_cache_size = 1024`

Config sample update 2017-11-29 19:09:48 +00:00			`; Optional rotating log file. Default: none`
Added configuration sample file 2015-04-05 13:12:45 +00:00			`log_file = /var/supysonic/supysonic.log`

Small config doc/sample update Closes #177 Closes #178 2020-01-18 16:20:58 +00:00			`; Log level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL.`
			`; Default: WARNING`
Updated configuration sample 2015-04-05 14:17:47 +00:00			`log_level = WARNING`

Small config doc/sample update Closes #177 Closes #178 2020-01-18 16:20:58 +00:00			`; Enable the Subsonic REST API. You'll most likely want to keep this on, here`
			`; for testing purposes. Default: on`
Config sample update 2017-11-29 19:09:48 +00:00			`;mount_api = on`

			`; Enable the administrative web interface. Default: on`
			`;mount_webui = on`

Add ignored articles support Closes #200 2020-11-09 16:31:04 +00:00			`; Space separated list of prefixes that should be ignored on index endpoints`
			`; Default: El La Le Las Les Los The`
			`index_ignored_prefixes = El La Le Las Les Los The`

Updated configuration sample 2015-04-05 14:17:47 +00:00			`[daemon]`
Docs update 2019-04-13 14:53:37 +00:00			`; Socket file the daemon will listen on for incoming management commands`
			`; Default: /tmp/supysonic/supysonic.sock`
			`socket = /var/run/supysonic.sock`

Added a config variable to define if the watcher should be started 2019-04-13 15:14:03 +00:00			`; Defines if the file watcher should be started. Default: yes`
			`run_watcher = yes`

Small config doc/sample update Closes #177 Closes #178 2020-01-18 16:20:58 +00:00			`; Delay in seconds before triggering scanning operation after a change have been`
			`; detected.`
Slight changes to watcher Configurable scan delay Test friendliness 2017-12-05 21:15:04 +00:00			`; This prevents running too many scans when multiple changes are detected for a`
			`; single file over a short time span. Default: 5`
			`wait_delay = 5`

Docs update 2019-11-23 14:08:18 +00:00			`; Command used by the jukebox`
			`jukebox_command = mplayer -ss %offset %path`

Docs update for recent watcher logging changes 2018-11-11 18:38:13 +00:00			`; Optional rotating log file for the scanner daemon. Logs to stderr if empty`
Updated configuration sample 2015-04-05 14:17:47 +00:00			`log_file = /var/supysonic/supysonic-daemon.log`
			`log_level = INFO`
Added configuration sample file 2015-04-05 13:12:45 +00:00
			`[lastfm]`
			`; API and secret key to enable scrobbling. http://www.last.fm/api/accounts`
Config sample update 2017-11-29 19:09:48 +00:00			`; Defaults: none`
			`;api_key =`
			`;secret =`
Added configuration sample file 2015-04-05 13:12:45 +00:00
			`[transcoding]`
Config sample update 2017-11-29 19:09:48 +00:00			`; Programs used to convert from one format/bitrate to another. Defaults: none`
add transcoders to the sample config file 2017-06-24 20:31:58 +00:00			`transcoder_mp3_mp3 = lame --quiet --mp3input -b %outrate %srcpath -`
			`transcoder = ffmpeg -i %srcpath -ab %outratek -v 0 -f %outfmt -`
			`decoder_mp3 = mpg123 --quiet -w - %srcpath`
			`decoder_ogg = oggdec -o %srcpath`
			`decoder_flac = flac -d -c -s %srcpath`
			`encoder_mp3 = lame --quiet -b %outrate - -`
Support setting basic metadata in transcoded media Other small fixes: - Fixed typo in README - Fixed `oggenc2` using `-q` instead of `-Q` to mean "quiet" Fixes #170 2019-11-11 20:04:25 +00:00			`encoder_ogg = oggenc2 -Q -M %outrate -`
Added configuration sample file 2015-04-05 13:12:45 +00:00
Updated config sample 2019-10-26 14:26:51 +00:00			`; Default format, used when a client requests a bitrate lower than the original`
			`; file and no specific format`
			`default_transcode_target = mp3`

Added configuration sample file 2015-04-05 13:12:45 +00:00			`[mimetypes]`
Config sample update 2017-11-29 19:09:48 +00:00			`; Extension to mimetype mappings in case your system has some trouble guessing`
			`; Default: none`
			`;mp3 = audio/mpeg`
			`;ogg = audio/vorbis`
Added configuration sample file 2015-04-05 13:12:45 +00:00