mirror/maloja
1
0
Fork 0
mirror of https://github.com/krateng/maloja.git synced 2023-08-10 21:12:55 +03:00
Code Issues Projects Releases Wiki Activity

Prettified settings overview

Browse Source
This commit is contained in:
Krateng 2020-10-29 19:16:38 +01:00
parent 79d7af5025
commit ac29f9728e
1 changed files with 42 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
settings.md
View File

@ -2,38 +2,45 @@ Technically, each setting can be set via environment variable or the settings fi
Settings File | Environment Variable | Type | Description 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. **Setup**
WEB_PORT |   | Integer | HTTP port to use for your web interface and API `SKIP_SETUP` | `MALOJA_SKIP_SETUP` | Boolean | Whether to make server startup non-interactive. Vital for docker.
HOST |   | String | Host for your server - most likely `::` for IPv6 or `0.0.0.0` for IPv4   | `MALOJA_FORCE_PASSWORD` | String | Sets password for admin login in web interface. This should normally be done via the interactive prompt.
METADATA_PROVIDERS |   | List (String) | Which metadata providers should be used in what order. Musicbrainz is rate-limited and should not be used first. **Debug**
SCROBBLE_LASTFM |   | Boolean | Proxy-scrobble to Last.fm `LOGGING` | `MALOJA_LOGGING` | Boolean | Enable logging
LASTFM_API_KEY |   | String | API key for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider `DEV_MODE` | `MALOJA_DEV_MODE` | Boolean | Enable developer mode
LASTFM_API_SECRET |   | String | API secret for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider **Technical**
SPOTIFY_API_ID |   | String | API ID for Spotify. Necessary if using it as a metadata provider. `WEB_PORT` |   | Integer | HTTP port to use for your web interface and API
SPOTIFY_API_SECRET |   | String | API Secret for Spotify. Necessary if using it as a metadata provider. `HOST` |   | String | Host for your server - most likely `::` for IPv6 or `0.0.0.0` for IPv4
TRACK_SEARCH_PROVIDER |   | String | Provider for track search next to scrobbles. None to disable. `CACHE_EXPIRE_POSITIVE` |   | Integer | Days until images are refetched
THUMBOR_SERVER |   | String | URL of Thumbor server to serve custom artwork. `CACHE_EXPIRE_NEGATIVE` |   | Integer | Days until failed image fetches are reattempted
THUMBOR_SECRET |   | String | Secret of Thumbor server `USE_DB_CACHE` |   | Boolean | Whether to use the Database Cache.
CACHE_EXPIRE_POSITIVE |   | Integer | Days until images are refetched `CACHE_DATABASE_SHORT` |   | Boolean | Whether to use the Volatile DB Cache.
CACHE_EXPIRE_NEGATIVE |   | Integer | Days until failed image fetches are reattempted `CACHE_DATABASE_PERM` |   | Boolean | Whether to use the Permanent DB Cache.
USE_DB_CACHE |   | Boolean | Whether to use the Database Cache. `DB_CACHE_ENTRIES` |   | Integer | Maximal entries of cache.
CACHE_DATABASE_SHORT |   | Boolean | Whether to use the Volatile DB 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)
CACHE_DATABASE_PERM |   | Boolean | Whether to use the Permanent DB Cache. **Fluff**
DB_CACHE_ENTRIES |   | Integer | Maximal entries of cache. `SCROBBLES_GOLD` |   | Integer | How many scrobbles should be considered 'Gold' status for a track
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) `SCROBBLES_PLATINUM` |   | Integer | How many scrobbles should be considered 'Platinum' status for a track
INVALID_ARTISTS |   | List (String) | Artists that should be discarded immediately `SCROBBLES_DIAMOND` |   | Integer | How many scrobbles should be considered 'Diamond' status for a track
REMOVE_FROM_TITLE |   | List (String) | Phrases that should be removed from song titles `NAME` |   | String | Your Name for display
USE_LOCAL_IMAGES |   | Boolean | Use local images if present **Third Party Services**
LOCAL_IMAGE_ROTATE |   | Integer | How many seconds to wait between rotating local images `METADATA_PROVIDERS` |   | List (String) | Which metadata providers should be used in what order. Musicbrainz is rate-limited and should not be used first.
DEFAULT_RANGE_CHARTS_ARTISTS |   | String | What range is shown per default for the tile view on the start page `SCROBBLE_LASTFM` |   | Boolean | Proxy-scrobble to Last.fm
DEFAULT_RANGE_CHARTS_TRACKS |   | String | What range is shown per default for the tile view on the start page `LASTFM_API_KEY` |   | String | API key for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider
DEFAULT_STEP_PULSE |   | String | What steps are shown per default for the pulse view on the start page `LASTFM_API_SECRET` |   | String | API secret for Last.fm. Necessary if proxy-scrobbling to Last.fm or using it as a metadata provider
CHARTS_DISPLAY_TILES |   | Boolean | Whether to show tiles on chart pages `SPOTIFY_API_ID` |   | String | API ID for Spotify. Necessary if using it as a metadata provider.
DISCOURAGE_CPU_HEAVY_STATS |   | Boolean | Prevent visitors from mindlessly clicking on CPU-heavy options. Does not actually disable them for malicious actors! `SPOTIFY_API_SECRET` |   | String | API Secret for Spotify. Necessary if using it as a metadata provider.
SCROBBLES_GOLD |   | Integer | How many scrobbles should be considered 'Gold' status for a track `TRACK_SEARCH_PROVIDER` |   | String | Provider for track search next to scrobbles. None to disable.
SCROBBLES_PLATINUM |   | Integer | How many scrobbles should be considered 'Platinum' status for a track `THUMBOR_SERVER` |   | String | URL of Thumbor server to serve custom artwork.
SCROBBLES_DIAMOND |   | Integer | How many scrobbles should be considered 'Diamond' status for a track `THUMBOR_SECRET` |   | String | Secret of Thumbor server
NAME |   | String | Your Name for display **Database**
SKIP_SETUP | MALOJA_SKIP_SETUP | Boolean | Whether to make server startup non-interactive. Vital for docker. `INVALID_ARTISTS` |   | List (String) | Artists that should be discarded immediately
LOGGING | MALOJA_LOGGING | Boolean | Enable logging `REMOVE_FROM_TITLE` |   | List (String) | Phrases that should be removed from song titles
DEV_MODE | MALOJA_DEV_MODE | Boolean | Enable developer mode **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