mirror
/
maloja
mirror of https://github.com/krateng/maloja.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
maloja/settings.md

56 lines
5.3 KiB
Markdown
Raw Normal View History

Clarified settings, GH-77
2021-08-24 05:54:09 +03:00
Technically, each setting can be set via environment variable or the settings file - simply add the prefix `MALOJA_` for environment variables. The columns are filled according to what is reasonable, it is recommended to use the settings file where possible and not configure each aspect of your server via environment variables!
Added settings overview
2020-10-29 20:21:12 +03:00
Settings File | Environment Variable | Type | Description
------ | --------- | --------- | ---------
Prettified settings overview
2020-10-29 21:16:38 +03:00
**Setup**
Housekeeping
2021-01-01 06:13:58 +03:00
  | `MALOJA_DATA_DIRECTORY` | String | Use this directory to store all application files. Useful for docker. Overwrites all individually specified directories below.
  | `MALOJA_DIRECTORY_CONFIG` | String | Use this directory to store configuration files.
`DIRECTORY_STATE` | `MALOJA_DIRECTORY_STATE` | String | Use this directory to store state files.
`DIRECTORY_LOGS` | `MALOJA_DIRECTORY_LOGS` | String | Use this directory to store log files.
`DIRECTORY_CACHE` | `MALOJA_DIRECTORY_CACHE` | String | Use this directory to store cache files.
Prettified settings overview
2020-10-29 21:16:38 +03:00
`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.
Housekeeping
2021-01-01 06:13:58 +03:00
`CLEAN_OUTPUT` | `MALOJA_CLEAN_OUTPUT` | Boolean | Avoid mutable console output. Use if console output will be redirected e.g. to a web interface.
Prettified settings overview
2020-10-29 21:16:38 +03:00
**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
Made artist delimiters a setting, fix GH-66
2021-01-07 00:09:07 +03:00
`DELIMITERS_FEAT` |   | List (String) | Delimiters used for extra artists, even when in the title field
`DELIMITERS_INFORMAL` |   | List (String) | Delimiters in informal artist strings with spaces expected around them
`DELIMITERS_FORMAL` |   | List (String) | Delimiters used to tag multiple artists when only one tag field is available
Prettified settings overview
2020-10-29 21:16:38 +03:00
**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