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

Added settings overview

This commit is contained in:
Krateng 2020-10-29 18:21:12 +01:00
parent f555ee9d9f
commit 79d7af5025
2 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -108,7 +108,7 @@ to run the server in the foreground.
### Customization
* Have a look at the `default.ini` file in the `~/.local/share/maloja/settings` folder to see what settings are available. Specify your own choices in `settings.ini`. You can also set each of these settings as an environment variable with the prefix `MALOJA_` (e.g. `MALOJA_SKIP_SETUP`).
* Have a look at the [available settings](settings.md) and specifiy your choices in `~/.local/share/maloja/settings/settings.ini`. You can also set each of these settings as an environment variable with the prefix `MALOJA_` (e.g. `MALOJA_SKIP_SETUP`).
* If you have activated admin mode in your web interface, you can upload custom images for artists or tracks by simply dragging them onto the existing image on the artist or track page. You can also manage custom images directly in the file system - consult `images.info` in the `~/.local/share/maloja/images` folder.

39
settings.md Normal file
View File

@ -0,0 +1,39 @@
Technically, each setting can be set via environment variable or the settings file. The columns are filled according to what is reasonable. Please do not configure each aspect of your server via environment variables!
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