Updated settings.md

Refactor container image to use linuxserverio alpine base

.dockerignore

@@ -1,5 +1,6 @@
 *
 !maloja
+!container
 !Containerfile
 !requirements.txt
 !pyproject.toml

Containerfile

@@ -1,40 +1,59 @@
-FROM alpine:3.15
-# Python image includes two Python versions, so use base Alpine
-
-# Based on the work of Jonathan Boeckel <jonathanboeckel1996@gmail.com>
+FROM lsiobase/alpine:3.17 as base
 
 WORKDIR /usr/src/app
 
-# Install run dependencies first
-RUN apk add --no-cache python3 py3-lxml tzdata
+COPY --chown=abc:abc . .
 
-# system pip could be removed after build, but apk then decides to also remove all its
-# python dependencies, even if they are explicitly installed as python packages
-# whut
+# based on https://github.com/linuxserver/docker-pyload-ng/blob/main/Dockerfile
+# Everything is run in one command so we can purge all build dependencies and cache in the same layer after maloja is installed
+#
+# -- it may be possible to decrease image size slightly by using build stage and copying all site-packages to runtime stage
+# but the image is already pretty small (117mb uncompressed, ~40mb compressed)
 RUN \
-	apk add py3-pip && \
-	pip install wheel
+    echo "**** install build packages ****" && \
+	apk add --no-cache --virtual=build-deps \
+	gcc \
+	g++ \
+	python3-dev \
+	libxml2-dev \
+	libxslt-dev \
+	libffi-dev \
+	libc-dev \
+	py3-pip \
+	linux-headers && \
+	echo "**** install runtime packages ****" && \
+	apk add --no-cache \
+	python3 \
+	py3-lxml \
+	tzdata && \
+	echo "**** install pip dependencies ****" && \
+	python3 -m ensurepip && \
+    pip3 install -U --no-cache-dir \
+        pip \
+        wheel && \
+    echo "**** install maloja requirements ****" && \
+    pip3 install --no-cache-dir -r requirements.txt && \
+    echo "**** install maloja ****" && \
+    pip3 install /usr/src/app && \
+    echo "**** cleanup ****" && \
+    apk del --purge \
+        build-deps && \
+    rm -rf \
+        /tmp/* \
+        ${HOME}/.cache
 
-
-COPY ./requirements.txt ./requirements.txt
-
-RUN \
-	apk add --no-cache --virtual .build-deps gcc g++ python3-dev libxml2-dev libxslt-dev libffi-dev libc-dev py3-pip linux-headers && \
-	pip install --no-cache-dir -r requirements.txt && \
-	apk del .build-deps
-
-
-# no chance for caching below here
-
-COPY . .
-
-RUN pip install /usr/src/app
+COPY container/root/ /
 
 # Docker-specific configuration
 # defaulting to IPv4 is no longer necessary (default host is dual stack)
 ENV MALOJA_SKIP_SETUP=yes
 ENV PYTHONUNBUFFERED=1
 
+# Prevents breaking change for previous container that ran maloja as root
+# which meant MALOJA_DATA_DIRECTORY was created by and owned by root (UID 0)
+#
+# On linux hosts (non-podman rootless) these variables should be set to the host user that should own the host folder bound to MALOJA_DATA_DIRECTORY
+ENV PUID=0
+ENV PGID=0
+
 EXPOSE 42010
-# use exec form for better signal handling https://docs.docker.com/engine/reference/builder/#entrypoint
-ENTRYPOINT ["maloja", "run"]

README.md

@@ -96,6 +96,23 @@ An example of a minimum run configuration to access maloja via `localhost:42010`
 	docker run -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
 ```
 
+#### Linux Host
+
+**NOTE:** If you are using [rootless containers with Podman](https://developers.redhat.com/blog/2020/09/25/rootless-containers-with-podman-the-basics#why_podman_) this DOES NOT apply to you.
+
+If you are running Docker on a **Linux Host** you should specify `user:group` ids of the user who owns the folder on the host machine bound to `MALOJA_DATA_DIRECTORY` in order to avoid [docker file permission problems.](https://ikriv.com/blog/?p=4698) These can be specified using the [environmental variables **PUID** and **PGID**.](https://docs.linuxserver.io/general/understanding-puid-and-pgid)
+
+To get the UID and GID for the current user run these commands from a terminal:
+
+* `id -u` -- prints UID (EX `1000`)
+* `id -g` -- prints GID (EX `1001`)
+
+The modified run command with these variables would look like:
+
+```console
+	docker run -e PUID=1000 -e PGID=1001 -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
+```
+
 ### Extras
 
 * If you'd like to display images, you will need API keys for [Last.fm](https://www.last.fm/api/account/create) and [Spotify](https://developer.spotify.com/dashboard/applications). These are free of charge!

container/root/etc/s6-overlay/s6-rc.d/init-permission-check/run

@@ -0,0 +1,10 @@
+#!/usr/bin/with-contenv bash
+
+if [ "$(s6-setuidgid abc id -u)" = "0" ]; then
+   echo "-------------------------------------"
+   echo "WARN: Running as root! If you meant to do this than this message can be ignored."
+   echo "If you are running this container on a *linux* host and are not using podman rootless you SHOULD"
+   echo "change the ENVs PUID and PGID for this container to ensure correct permissions on your config folder."
+   echo -e "See: https://github.com/krateng/maloja#linux-host\n"
+   echo -e "-------------------------------------\n"
+fi

container/root/etc/s6-overlay/s6-rc.d/init-permission-check/type

@@ -0,0 +1 @@
+oneshot

container/root/etc/s6-overlay/s6-rc.d/init-permission-check/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-permission-check/run

container/root/etc/s6-overlay/s6-rc.d/svc-python/run

@@ -0,0 +1,7 @@
+#!/usr/bin/with-contenv bash
+
+# used https://github.com/linuxserver/docker-wikijs/blob/master/root/etc/s6-overlay/s6-rc.d/svc-wikijs/run as a template
+
+echo -e "\nMaloja is starting!"
+exec \
+	  s6-setuidgid abc python -m maloja run

container/root/etc/s6-overlay/s6-rc.d/svc-python/type

@@ -0,0 +1 @@
+longrun

maloja/thirdparty/musicbrainz.py

@@ -18,7 +18,7 @@ class MusicBrainz(MetadataInterface):
 
 	metadata = {
 		"response_type":"json",
-		"response_parse_tree_track": ["images",0,"image"],
+		"response_parse_tree_track": ["images",0,"thumbnails","500"],
 		"required_settings": [],
 	}
 

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