Updated settings.md

settings.md

@@ -1,4 +1,14 @@
-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!
+If you wish to adjust settings in the settings.ini file, do so while the server
+	is not running in order to avoid data being overwritten.
+
+	Technically, each setting can be set via environment variable or the settings
+	file - simply add the prefix `MALOJA_` for environment variables. It is recommended
+	to use the settings file where possible and not configure each aspect of your
+	server via environment variables!
+
+	You also can specify additional settings in the files`/run/secrets/maloja.yml` or
+	`/run/secrets/maloja.ini`, as well as their values directly in files of the respective
+	name in `/run/secrets/` (e.g. `/run/secrets/lastfm_api_key`).
 
 Settings File			| Environment Variable			| Type			| Description
 ------					| ---------						| ---------		| ---------
@@ -15,16 +25,14 @@ Settings File			| Environment Variable			| Type			| Description
 `logging`	| `MALOJA_LOGGING`  | Boolean | Enable Logging
 `dev_mode`	| `MALOJA_DEV_MODE`  | Boolean | Enable developer mode
 **Network**
-`host`	| `MALOJA_HOST`  | String | Host for your server - most likely :: for IPv6 or 0.0.0.0 for IPv4
+`host`	| `MALOJA_HOST`  | String | Host for your server, e.g. '*' for dual stack, '::' for IPv6 or '0.0.0.0' for IPv4
 `port`	| `MALOJA_PORT`  | Integer | Port
 **Technical**
 `cache_expire_positive`	| `MALOJA_CACHE_EXPIRE_POSITIVE`  | Integer | Days until images are refetched
 `cache_expire_negative`	| `MALOJA_CACHE_EXPIRE_NEGATIVE`  | Integer | Days until failed image fetches are reattempted
-`use_db_cache`	| `MALOJA_USE_DB_CACHE`  | Boolean | Use DB Cache
-`cache_database_short`	| `MALOJA_CACHE_DATABASE_SHORT`  | Boolean | Use volatile Database Cache
-`cache_database_perm`	| `MALOJA_CACHE_DATABASE_PERM`  | Boolean | Use permanent Database Cache
-`db_cache_entries`	| `MALOJA_DB_CACHE_ENTRIES`  | Integer | Maximal Cache entries
-`db_max_memory`	| `MALOJA_DB_MAX_MEMORY`  | Integer | Maximal percentage of 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)
+`db_max_memory`	| `MALOJA_DB_MAX_MEMORY`  | Integer | RAM Usage in percent at which Maloja should no longer increase its database cache.
+`use_request_cache`	| `MALOJA_USE_REQUEST_CACHE`  | Boolean | Use request-local DB Cache
+`use_global_cache`	| `MALOJA_USE_GLOBAL_CACHE`  | Boolean | Use global DB Cache
 **Fluff**
 `scrobbles_gold`	| `MALOJA_SCROBBLES_GOLD`  | Integer | How many scrobbles a track needs to be considered 'Gold' status
 `scrobbles_platinum`	| `MALOJA_SCROBBLES_PLATINUM`  | Integer | How many scrobbles a track needs to be considered 'Platinum' status
@@ -35,17 +43,25 @@ Settings File			| Environment Variable			| Type			| Description
 `scrobble_lastfm`	| `MALOJA_SCROBBLE_LASTFM`  | Boolean | Proxy-Scrobble to Last.fm
 `lastfm_api_key`	| `MALOJA_LASTFM_API_KEY`  | String | Last.fm API Key
 `lastfm_api_secret`	| `MALOJA_LASTFM_API_SECRET`  | String | Last.fm API Secret
+`lastfm_api_sk`	| `MALOJA_LASTFM_API_SK`  | String | Last.fm API Session Key
+`lastfm_username`	| `MALOJA_LASTFM_USERNAME`  | String | Last.fm Username
+`lastfm_password`	| `MALOJA_LASTFM_PASSWORD`  | String | Last.fm Password
 `spotify_api_id`	| `MALOJA_SPOTIFY_API_ID`  | String | Spotify API ID
 `spotify_api_secret`	| `MALOJA_SPOTIFY_API_SECRET`  | String | Spotify API Secret
 `audiodb_api_key`	| `MALOJA_AUDIODB_API_KEY`  | String | TheAudioDB API Key
+`other_maloja_url`	| `MALOJA_OTHER_MALOJA_URL`  | String | Other Maloja Instance URL
+`other_maloja_api_key`	| `MALOJA_OTHER_MALOJA_API_KEY`  | String | Other Maloja Instance API Key
 `track_search_provider`	| `MALOJA_TRACK_SEARCH_PROVIDER`  | String | Track Search Provider
 `send_stats`	| `MALOJA_SEND_STATS`  | Boolean | Send Statistics
+`proxy_images`	| `MALOJA_PROXY_IMAGES`  | Boolean | Whether third party images should be downloaded and served directly by Maloja (instead of just linking their URL)
 **Database**
 `invalid_artists`	| `MALOJA_INVALID_ARTISTS`  | Set | Artists that should be discarded immediately
 `remove_from_title`	| `MALOJA_REMOVE_FROM_TITLE`  | Set | Phrases that should be removed from song titles
 `delimiters_feat`	| `MALOJA_DELIMITERS_FEAT`  | Set | Delimiters used for extra artists, even when in the title field
 `delimiters_informal`	| `MALOJA_DELIMITERS_INFORMAL`  | Set | Delimiters in informal artist strings with spaces expected around them
 `delimiters_formal`	| `MALOJA_DELIMITERS_FORMAL`  | Set | Delimiters used to tag multiple artists when only one tag field is available
+`filters_remix`	| `MALOJA_FILTERS_REMIX`  | Set | Filters used to recognize the remix artists in the title
+`parse_remix_artists`	| `MALOJA_PARSE_REMIX_ARTISTS`  | Boolean | Parse Remix Artists
 **Web Interface**
 `default_range_charts_artists`	| `MALOJA_DEFAULT_RANGE_CHARTS_ARTISTS`  | Choice | Default Range Artist Charts
 `default_range_charts_tracks`	| `MALOJA_DEFAULT_RANGE_CHARTS_TRACKS`  | Choice | Default Range Track Charts
@@ -54,6 +70,6 @@ Settings File			| Environment Variable			| Type			| Description
 `display_art_icons`	| `MALOJA_DISPLAY_ART_ICONS`  | Boolean | Display Album/Artist Icons
 `discourage_cpu_heavy_stats`	| `MALOJA_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`	| `MALOJA_USE_LOCAL_IMAGES`  | Boolean | Use Local Images
-`local_image_rotate`	| `MALOJA_LOCAL_IMAGE_ROTATE`  | Integer | Local Image Rotate
 `timezone`	| `MALOJA_TIMEZONE`  | Integer | UTC Offset
 `time_format`	| `MALOJA_TIME_FORMAT`  | String | Time Format
+`theme`	| `MALOJA_THEME`  | String | Theme