Merge pull request #718 from josevh/transmission-env-var-settings

transmission: env-var-settings initial release

.github/workflows/BuildImage.yml

@@ -5,8 +5,8 @@ on: [push, pull_request_target, workflow_dispatch]
 env:
   GITHUB_REPO: "linuxserver/docker-mods" #don't modify
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
+  BASEIMAGE: "transmission" #replace
-  MODNAME: "replace_modname" #replace
+  MODNAME: "env-var-settings" #replace
 
 jobs:
   set-vars:

Dockerfile

@@ -2,7 +2,7 @@
 
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="josevh"
 
 # copy local files
 COPY root/ /

Dockerfile.complex

@@ -1,25 +0,0 @@
-# syntax=docker/dockerfile:1
-
-## Buildstage ##
-FROM ghcr.io/linuxserver/baseimage-alpine:3.17 as buildstage
-
-RUN \
-  echo "**** install packages ****" && \
-  apk add --no-cache \
-    curl && \
-  echo "**** grab rclone ****" && \
-  mkdir -p /root-layer && \
-  curl -o \
-    /root-layer/rclone.deb -L \
-    "https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-amd64.deb"
-
-# copy local files
-COPY root/ /root-layer/
-
-## Single layer deployed image ##
-FROM scratch
-
-LABEL maintainer="username"
-
-# Add files from buildstage
-COPY --from=buildstage /root-layer/ /

README.md

@@ -1,25 +1,11 @@
-# Rsync - Docker mod for openssh-server
+# ENV Var Settings - Docker mod for transmission
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod sets Transmission settings provided via environment variables.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+The environment variable names are a combination of `'TRANSMISSION_'` and the
+setting name capitalized with hyphens (`'-'`) converted to underscores (`'_'`). For example, the setting
+`'peer-port'` can be set with environment variable `TRANSMISSION_PEER_PORT`.
 
-If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
+In transmission docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:transmission-env-var-settings`.
 
-# Mod creation instructions
+If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:transmission-env-var-settings|linuxserver/mods:universal-wait-for-internet`
-
-* Fork the repo, create a new branch based on the branch `template`.
-* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
-* Inspect the `root` folder contents. Edit, add and remove as necessary.
-* After all init scripts and services are created, run `find ./  -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
-* Edit this readme with pertinent info, delete these instructions.
-* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic if needed.
-* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
-* Submit PR against the branch created by the team.
-
-
-## Tips and tricks
-
-* Some images have helpers built in, these images are currently:
-    * [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
-    * [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

@@ -1,30 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is the init file used for adding os or pip packages to install lists.
-# It takes advantage of the built-in init-mods-package-install init script that comes with the baseimages.
-# If using this, we need to make sure we set this init as a dependency of init-mods-package-install so this one runs first
-
-if ! command -v apprise; then
-    echo "**** Adding apprise and its deps to package install lists ****"
-    echo "apprise" >> /mod-pip-packages-to-install.list
-    ## Ubuntu
-    if [ -f /usr/bin/apt ]; then
-        echo "\
-            python3 \
-            python3-pip \
-            runc" >> /mod-repo-packages-to-install.list
-    fi
-    # Alpine
-    if [ -f /sbin/apk ]; then
-        echo "\
-            cargo \
-            libffi-dev \
-            openssl-dev \
-            python3 \
-            python3-dev \
-            python3 \
-            py3-pip" >> /mod-repo-packages-to-install.list
-    fi
-else
-    echo "**** apprise already installed, skipping ****"
-fi

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/type

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

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

@@ -1,8 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is an install script that is designed to run after init-mods-package-install
-# so it can take advantage of packages installed
-# init-mods-end depends on this script so that later init and services wait until this script exits
-
-echo "**** Setting up apprise ****"
-apprise blah blah

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/type

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

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

root/etc/s6-overlay/s6-rc.d/init-mod-transmission-env-var-settings/run

@@ -0,0 +1,59 @@
+#!/usr/bin/with-contenv python3
+
+import json
+import os
+import sys
+
+from json.decoder import JSONDecodeError
+
+SETTINGS_FILE_PATH = "/config/settings.json"
+
+
+def setting_name_env_var_name(setting_name):
+    return "TRANSMISSION_{}".format(setting_name.replace("-", "_").upper())
+
+
+def main():
+    # check file exists and is writable, just in case..
+    if not os.path.exists(SETTINGS_FILE_PATH):
+        raise Exception(f"Settings file '{SETTINGS_FILE_PATH}' does not exist.")
+    if not os.path.isfile(SETTINGS_FILE_PATH):
+        raise Exception(f"Settings file '{SETTINGS_FILE_PATH}' is a directory.")
+    if not os.access(SETTINGS_FILE_PATH, os.W_OK):
+        raise Exception(f"Settings file '{SETTINGS_FILE_PATH}' is not writable.")
+
+    # read settings file
+    settings_json = None
+    with open(SETTINGS_FILE_PATH, "r") as f:
+        settings_json = json.loads(f.read())
+
+    # update settings with ENV vars
+    for setting_name in settings_json:
+        env_var_name = setting_name_env_var_name(setting_name)
+        env_var_value = os.getenv(env_var_name)
+
+        if env_var_value is not None:
+            setting_type = type(settings_json[setting_name])
+            if setting_type == bool:
+                setting_value = env_var_value.lower() == "true"
+            else:
+                setting_value = setting_type(env_var_value)
+
+            print(f"From ENV setting '{setting_name}'='{setting_value}'.")
+            settings_json[setting_name] = setting_value
+
+    with open(SETTINGS_FILE_PATH, "w", encoding="utf-8") as f:
+        json.dump(settings_json, f, ensure_ascii=False, indent=4)
+        print("Transmission settings file saved.")
+
+
+if __name__ == "__main__":
+    try:
+        print("Applying transmission env-var-settings mod...")
+        main()
+    except Exception as e:
+        print(f"Failed to apply transmission env-var-settings mod with error: '{e}'.", file=sys.stderr)
+    else:
+        print("Applied transmission env-var-settings mod successfully.")
+    finally:
+        sys.exit(0)

root/etc/s6-overlay/s6-rc.d/init-mod-transmission-env-var-settings/type

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

root/etc/s6-overlay/s6-rc.d/init-mod-transmission-env-var-settings/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mod-transmission-env-var-settings/run

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/run

@@ -1,7 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is an example service that would run for the mod
-# It depends on init-services, the baseimage hook for start of all longrun services
-
-exec \
-    s6-setuidgid abc run my app

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/type

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