Merge pull request #32 from linuxserver/aliases-develop

Author: thespad

Dockerfile

@@ -27,8 +27,6 @@ RUN \
     yarn && \
   apk add --no-cache --virtual=build-dependencies \
     build-base \
-    g++ \
-    gcc \
     icu-dev \
     libidn-dev \    
     libpq-dev \

Dockerfile.aarch64

@@ -27,8 +27,6 @@ RUN \
     yarn && \
   apk add --no-cache --virtual=build-dependencies \
     build-base \
-    g++ \
-    gcc \
     gcompat \
     icu-dev \
     libidn-dev \    

README.md

@@ -68,11 +68,17 @@ This image provides various versions that are available via tags. Please read th
 
 ## Application Setup
 
-To generate keys for `SECRET_KEY_BASE` & `OTP_SECRET` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon secret` once for each.
+We provide aliases for the common commands that execute in the correct context so that environment variables from secrets are available to them:
 
-To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon mastodon:webpush:generate_vapid_key`
+* To generate keys for `SECRET_KEY_BASE` & `OTP_SECRET` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-secret` once for each.
 
-To use `tootctl` you can run something like `docker exec -it -w /app/www mastodon bin/tootctl <command>`
+* To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-vapid`
+
+Both of the secret generation aliases above can be run without any other setup having been carried out.
+
+* To use `tootctl` you can run something like `docker exec -it lscr.io/linuxserver/mastodon bin/tootctl <command>`
+
+Using `tootctl` requires you to complete the initial Mastodon configuration first.
 
 This container *requires* separate postgres and redis instances to run.
 
@@ -351,6 +357,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **26.01.23:** - Add aliases for key generation & tootctl to better support secrets.
 * **19.12.22:** - Support separate sidekiq queue instances.
 * **08.11.22:** - Add develop branch.
 * **05.11.22:** - Initial Release.

readme-vars.yml

@@ -76,11 +76,17 @@ param_volumes:
 # application setup block
 app_setup_block_enabled: true
 app_setup_block: |
-  To generate keys for `SECRET_KEY_BASE` & `OTP_SECRET` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon secret` once for each.
+  We provide aliases for the common commands that execute in the correct context so that environment variables from secrets are available to them:
 
-  To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon mastodon:webpush:generate_vapid_key`
+  * To generate keys for `SECRET_KEY_BASE` & `OTP_SECRET` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-secret` once for each.
 
-  To use `tootctl` you can run something like `docker exec -it -w /app/www mastodon bin/tootctl <command>`
+  * To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-vapid`
+
+  Both of the secret generation aliases above can be run without any other setup having been carried out.
+
+  * To use `tootctl` you can run something like `docker exec -it lscr.io/linuxserver/mastodon tootctl <command>`
+
+  Using `tootctl` requires you to complete the initial Mastodon configuration first.
 
   This container *requires* separate postgres and redis instances to run.
 
@@ -100,6 +106,7 @@ app_setup_block: |
 
 # changelog
 changelogs:
+  - { date: "26.01.23:", desc: "Add aliases for key generation & tootctl to better support secrets." }
   - { date: "19.12.22:", desc: "Support separate sidekiq queue instances." }
   - { date: "08.11.22:", desc: "Add develop branch." }
   - { date: "05.11.22:", desc: "Initial Release." }

root/generate-secret

@@ -0,0 +1,6 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+cd /app/www || exit 1
+
+rake secret

root/generate-vapid

@@ -0,0 +1,6 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+cd /app/www || exit 1
+
+rake mastodon:webpush:generate_vapid_key

root/tootctl

@@ -0,0 +1,6 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+cd /app/www || exit 1
+
+bin/tootctl "$@"