Merge pull request #507 from linuxserver/template-hybrid

template update to s6 v2-v3 hybrid

Dockerfile.complex

@@ -1,15 +1,15 @@
 ## Buildstage ##
-FROM ghcr.io/linuxserver/baseimage-alpine:3.12 as buildstage
+FROM ghcr.io/linuxserver/baseimage-alpine:3.15 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"
+  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/

README.md

@@ -11,6 +11,8 @@ If adding multiple mods, enter them in an array separated by `|`, such as `DOCKE
 * 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.
+* The mod should be compatible with both s6v2 and s6v3 (until s6v2 based baseimages are deprecated).
+* After all init scripts and services are created, run `find ./ -name run -exec chmod +x {} +; find ./ -name finish -exec chmod +x {} +` to fix permissions.
 * Edit this readme with pertinent info, delete these instructions.
 * Finally edit the `.github/workflows/BuildImage.yml`. Customize the build branch, and the vars for `BASEIMAGE` and `MODNAME`.
 * 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.

root/etc/cont-init.d/95-apt-get

@@ -0,0 +1,5 @@
+#!/usr/bin/with-contenv bash
+
+if [ -f /usr/bin/apt ]; then
+    apt-get update
+fi

root/etc/cont-init.d/98-vpn-config

@@ -4,7 +4,6 @@
 if [ ! -f /usr/local/lib/python***/dist-packages/sshuttle ] && \
 [ -f /usr/bin/apt ]; then
   ## Ubuntu
-  apt-get update
   apt-get install --no-install-recommends -y \
     iptables \
     openssh-client \

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

@@ -0,0 +1,30 @@
+#!/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

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

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

@@ -0,0 +1 @@
+/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

@@ -0,0 +1,8 @@
+#!/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

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

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

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

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

@@ -0,0 +1,7 @@
+#!/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

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