From ac29f9728ef1530c2a757588b62ac4b96d0828df Mon Sep 17 00:00:00 2001 From: Krateng Date: Thu, 29 Oct 2020 19:16:38 +0100 Subject: [PATCH] Prettified settings overview --- settings.md | 77 +++++++++++++++++++++++++++++------------------------ 1 file changed, 42 insertions(+), 35 deletions(-) diff --git a/settings.md b/settings.md index 99df658..af9e386 100644 --- a/settings.md +++ b/settings.md @@ -2,38 +2,45 @@ Technically, each setting can be set via environment variable or the settings fi Settings File | Environment Variable | Type | Description ------ | --------- | --------- | --------- -  | MALOJA_FORCE_PASSWORD | String | Sets password for admin login in web interface. This should normally be done via the interactive prompt. -WEB_PORT |   | Integer | HTTP port to use for your web interface and API -HOST |   | String | Host for your server - most likely `::` for IPv6 or `0.0.0.0` for IPv4 -METADATA_PROVIDERS |   | List (String) | Which metadata providers should be used in what order. Musicbrainz is rate-limited and should not be used first. -SCROBBLE_LASTFM |   | Boolean | Proxy-scrobble to Last.fm -LASTFM_API_KEY |   | String | API key for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider -LASTFM_API_SECRET |   | String | API secret for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider -SPOTIFY_API_ID |   | String | API ID for Spotify. Necessary if using it as a metadata provider. -SPOTIFY_API_SECRET |   | String | API Secret for Spotify. Necessary if using it as a metadata provider. -TRACK_SEARCH_PROVIDER |   | String | Provider for track search next to scrobbles. None to disable. -THUMBOR_SERVER |   | String | URL of Thumbor server to serve custom artwork. -THUMBOR_SECRET |   | String | Secret of Thumbor server -CACHE_EXPIRE_POSITIVE |   | Integer | Days until images are refetched -CACHE_EXPIRE_NEGATIVE |   | Integer | Days until failed image fetches are reattempted -USE_DB_CACHE |   | Boolean | Whether to use the Database Cache. -CACHE_DATABASE_SHORT |   | Boolean | Whether to use the Volatile DB Cache. -CACHE_DATABASE_PERM |   | Boolean | Whether to use the Permanent DB Cache. -DB_CACHE_ENTRIES |   | Integer | Maximal entries of cache. -DB_MAX_MEMORY |   | Integer | Maximal percentage of total RAM that should be used (by whole system) before Maloja discards cache entries. Use a higher number if your Maloja runs on a dedicated instance (e.g. a container) -INVALID_ARTISTS |   | List (String) | Artists that should be discarded immediately -REMOVE_FROM_TITLE |   | List (String) | Phrases that should be removed from song titles -USE_LOCAL_IMAGES |   | Boolean | Use local images if present -LOCAL_IMAGE_ROTATE |   | Integer | How many seconds to wait between rotating local images -DEFAULT_RANGE_CHARTS_ARTISTS |   | String | What range is shown per default for the tile view on the start page -DEFAULT_RANGE_CHARTS_TRACKS |   | String | What range is shown per default for the tile view on the start page -DEFAULT_STEP_PULSE |   | String | What steps are shown per default for the pulse view on the start page -CHARTS_DISPLAY_TILES |   | Boolean | Whether to show tiles on chart pages -DISCOURAGE_CPU_HEAVY_STATS |   | Boolean | Prevent visitors from mindlessly clicking on CPU-heavy options. Does not actually disable them for malicious actors! -SCROBBLES_GOLD |   | Integer | How many scrobbles should be considered 'Gold' status for a track -SCROBBLES_PLATINUM |   | Integer | How many scrobbles should be considered 'Platinum' status for a track -SCROBBLES_DIAMOND |   | Integer | How many scrobbles should be considered 'Diamond' status for a track -NAME |   | String | Your Name for display -SKIP_SETUP | MALOJA_SKIP_SETUP | Boolean | Whether to make server startup non-interactive. Vital for docker. -LOGGING | MALOJA_LOGGING | Boolean | Enable logging -DEV_MODE | MALOJA_DEV_MODE | Boolean | Enable developer mode +**Setup** +`SKIP_SETUP` | `MALOJA_SKIP_SETUP` | Boolean | Whether to make server startup non-interactive. Vital for docker. +  | `MALOJA_FORCE_PASSWORD` | String | Sets password for admin login in web interface. This should normally be done via the interactive prompt. +**Debug** +`LOGGING` | `MALOJA_LOGGING` | Boolean | Enable logging +`DEV_MODE` | `MALOJA_DEV_MODE` | Boolean | Enable developer mode +**Technical** +`WEB_PORT` |   | Integer | HTTP port to use for your web interface and API +`HOST` |   | String | Host for your server - most likely `::` for IPv6 or `0.0.0.0` for IPv4 +`CACHE_EXPIRE_POSITIVE` |   | Integer | Days until images are refetched +`CACHE_EXPIRE_NEGATIVE` |   | Integer | Days until failed image fetches are reattempted +`USE_DB_CACHE` |   | Boolean | Whether to use the Database Cache. +`CACHE_DATABASE_SHORT` |   | Boolean | Whether to use the Volatile DB Cache. +`CACHE_DATABASE_PERM` |   | Boolean | Whether to use the Permanent DB Cache. +`DB_CACHE_ENTRIES` |   | Integer | Maximal entries of cache. +`DB_MAX_MEMORY` |   | Integer | Maximal percentage of total RAM that should be used (by whole system) before Maloja discards cache entries. Use a higher number if your Maloja runs on a dedicated instance (e.g. a container) +**Fluff** +`SCROBBLES_GOLD` |   | Integer | How many scrobbles should be considered 'Gold' status for a track +`SCROBBLES_PLATINUM` |   | Integer | How many scrobbles should be considered 'Platinum' status for a track +`SCROBBLES_DIAMOND` |   | Integer | How many scrobbles should be considered 'Diamond' status for a track +`NAME` |   | String | Your Name for display +**Third Party Services** +`METADATA_PROVIDERS` |   | List (String) | Which metadata providers should be used in what order. Musicbrainz is rate-limited and should not be used first. +`SCROBBLE_LASTFM` |   | Boolean | Proxy-scrobble to Last.fm +`LASTFM_API_KEY` |   | String | API key for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider +`LASTFM_API_SECRET` |   | String | API secret for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider +`SPOTIFY_API_ID` |   | String | API ID for Spotify. Necessary if using it as a metadata provider. +`SPOTIFY_API_SECRET` |   | String | API Secret for Spotify. Necessary if using it as a metadata provider. +`TRACK_SEARCH_PROVIDER` |   | String | Provider for track search next to scrobbles. None to disable. +`THUMBOR_SERVER` |   | String | URL of Thumbor server to serve custom artwork. +`THUMBOR_SECRET` |   | String | Secret of Thumbor server +**Database** +`INVALID_ARTISTS` |   | List (String) | Artists that should be discarded immediately +`REMOVE_FROM_TITLE` |   | List (String) | Phrases that should be removed from song titles +**Web Interface** +`DEFAULT_RANGE_CHARTS_ARTISTS` |   | String | What range is shown per default for the tile view on the start page +`DEFAULT_RANGE_CHARTS_TRACKS` |   | String | What range is shown per default for the tile view on the start page +`DEFAULT_STEP_PULSE` |   | String | What steps are shown per default for the pulse view on the start page +`CHARTS_DISPLAY_TILES` |   | Boolean | Whether to show tiles on chart pages +`DISCOURAGE_CPU_HEAVY_STATS` |   | Boolean | Prevent visitors from mindlessly clicking on CPU-heavy options. Does not actually disable them for malicious actors! +`USE_LOCAL_IMAGES` |   | Boolean | Use local images if present +`LOCAL_IMAGE_ROTATE` |   | Integer | How many seconds to wait between rotating local images