Workflow update

lsio/netbox/docker-compose.yaml

@@ -19,45 +19,45 @@ services:
       # specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
       - TZ=${TZ:-Europe/Amsterdam}
       # Email address for `admin` account
-      - SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
+      - SUPERUSER_EMAIL=
       # Password for `admin` account
-      - SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
+      - SUPERUSER_PASSWORD=
       # The hostname you will use to access the app (i.e., netbox.example.com)
-      - ALLOWED_HOST=<ALLOWED_HOST>
+      - ALLOWED_HOST=
       # Database name (default: netbox)
-      - DB_NAME=<DB_NAME>
+      - DB_NAME=
       # Database user
-      - DB_USER=<DB_USER>
+      - DB_USER=
       # Database password
-      - DB_PASSWORD=<DB_PASSWORD>
+      - DB_PASSWORD=
       # Database host (default: postgres)
-      - DB_HOST=<DB_HOST>
+      - DB_HOST=
       # Database port (defaul: 5432)
-      - DB_PORT=<DB_PORT>
+      - DB_PORT=
       # Redis host (default: redis)
-      - REDIS_HOST=<REDIS_HOST>
+      - REDIS_HOST=
       # Redis port number (default: 6379)
-      - REDIS_PORT=<REDIS_PORT>
+      - REDIS_PORT=
       # Redis password (default: none)
-      - REDIS_PASSWORD=<REDIS_PASSWORD>
+      - REDIS_PASSWORD=
       # Redis database ID for tasks (default: 0)
-      - REDIS_DB_TASK=<REDIS_DB_TASK>
+      - REDIS_DB_TASK=
       # Redis database ID for caching (default: 1)
-      - REDIS_DB_CACHE=<REDIS_DB_CACHE>
+      - REDIS_DB_CACHE=
       # The path you will use to access the app (i.e., /netbox, optional, default: none)
-      - BASE_PATH=<BASE_PATH> # optional
+      - BASE_PATH= # optional
       # Enable remote authentication (optional, default: False)
-      - REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> # optional
+      - REMOTE_AUTH_ENABLED= # optional
       # Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)
-      - REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> # optional
+      - REMOTE_AUTH_BACKEND= # optional
       # Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)
-      - REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> # optional
+      - REMOTE_AUTH_HEADER= # optional
       # If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)
-      - REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> # optional
+      - REMOTE_AUTH_AUTO_CREATE_USER= # optional
       # The list of groups to assign a new user account when created using remote authentication (optional, default: [])
-      - REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> # optional
+      - REMOTE_AUTH_DEFAULT_GROUPS= # optional
       # A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})
-      - REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> # optional
+      - REMOTE_AUTH_DEFAULT_PERMISSIONS= # optional
     volumes:
       # config directory volume mapping
       - ${BASEDIR:-/volume1/docker}/netbox/config:/config

lsio/netbox/docker-run.sh

@@ -11,26 +11,26 @@ docker run -d \
   -e PUID=${PUID:-1024} `# for UserID` \
   -e PGID=${PGID:-100} `# for GroupID` \
   -e TZ=${TZ:-Europe/Amsterdam} `# specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).` \
-  -e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> `# Email address for `admin` account` \
-  -e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> `# Password for `admin` account` \
-  -e ALLOWED_HOST=<ALLOWED_HOST> `# The hostname you will use to access the app (i.e., netbox.example.com)` \
-  -e DB_NAME=<DB_NAME> `# Database name (default: netbox)` \
-  -e DB_USER=<DB_USER> `# Database user` \
-  -e DB_PASSWORD=<DB_PASSWORD> `# Database password` \
-  -e DB_HOST=<DB_HOST> `# Database host (default: postgres)` \
-  -e DB_PORT=<DB_PORT> `# Database port (defaul: 5432)` \
-  -e REDIS_HOST=<REDIS_HOST> `# Redis host (default: redis)` \
-  -e REDIS_PORT=<REDIS_PORT> `# Redis port number (default: 6379)` \
-  -e REDIS_PASSWORD=<REDIS_PASSWORD> `# Redis password (default: none)` \
-  -e REDIS_DB_TASK=<REDIS_DB_TASK> `# Redis database ID for tasks (default: 0)` \
-  -e REDIS_DB_CACHE=<REDIS_DB_CACHE> `# Redis database ID for caching (default: 1)` \
-  -e BASE_PATH=<BASE_PATH> `# optional` `# The path you will use to access the app (i.e., /netbox, optional, default: none)` \
-  -e REMOTE_AUTH_ENABLED=<REMOTE_AUTH_ENABLED> `# optional` `# Enable remote authentication (optional, default: False)` \
-  -e REMOTE_AUTH_BACKEND=<REMOTE_AUTH_BACKEND> `# optional` `# Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)` \
-  -e REMOTE_AUTH_HEADER=<REMOTE_AUTH_HEADER> `# optional` `# Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)` \
-  -e REMOTE_AUTH_AUTO_CREATE_USER=<REMOTE_AUTH_AUTO_CREATE_USER> `# optional` `# If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)` \
-  -e REMOTE_AUTH_DEFAULT_GROUPS=<REMOTE_AUTH_DEFAULT_GROUPS> `# optional` `# The list of groups to assign a new user account when created using remote authentication (optional, default: [])` \
-  -e REMOTE_AUTH_DEFAULT_PERMISSIONS=<REMOTE_AUTH_DEFAULT_PERMISSIONS> `# optional` `# A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})` \
+  -e SUPERUSER_EMAIL= `# Email address for `admin` account` \
+  -e SUPERUSER_PASSWORD= `# Password for `admin` account` \
+  -e ALLOWED_HOST= `# The hostname you will use to access the app (i.e., netbox.example.com)` \
+  -e DB_NAME= `# Database name (default: netbox)` \
+  -e DB_USER= `# Database user` \
+  -e DB_PASSWORD= `# Database password` \
+  -e DB_HOST= `# Database host (default: postgres)` \
+  -e DB_PORT= `# Database port (defaul: 5432)` \
+  -e REDIS_HOST= `# Redis host (default: redis)` \
+  -e REDIS_PORT= `# Redis port number (default: 6379)` \
+  -e REDIS_PASSWORD= `# Redis password (default: none)` \
+  -e REDIS_DB_TASK= `# Redis database ID for tasks (default: 0)` \
+  -e REDIS_DB_CACHE= `# Redis database ID for caching (default: 1)` \
+  -e BASE_PATH= `# optional` `# The path you will use to access the app (i.e., /netbox, optional, default: none)` \
+  -e REMOTE_AUTH_ENABLED= `# optional` `# Enable remote authentication (optional, default: False)` \
+  -e REMOTE_AUTH_BACKEND= `# optional` `# Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)` \
+  -e REMOTE_AUTH_HEADER= `# optional` `# Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)` \
+  -e REMOTE_AUTH_AUTO_CREATE_USER= `# optional` `# If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)` \
+  -e REMOTE_AUTH_DEFAULT_GROUPS= `# optional` `# The list of groups to assign a new user account when created using remote authentication (optional, default: [])` \
+  -e REMOTE_AUTH_DEFAULT_PERMISSIONS= `# optional` `# A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})` \
   -p 8000:8000 `# will map the container's port 8000 to port 8000 on the host` \
   -v ${BASEDIR:-/volume1/docker}/netbox/config:/config `# config directory volume mapping` \
   --restart unless-stopped \

lsio/readme-sync/docker-compose.yaml

@@ -0,0 +1,21 @@
+This container needs special attention. Please check https://hub.docker.com/r/linuxserver/readme-sync for details.
+---
+version: "2.1"
+services:
+  readme-sync:
+    image: ghcr.io/linuxserver/readme-sync
+    container_name: readme-sync
+    environment:
+      # for UserID
+      - PUID=${PUID:-1024}
+      # for GroupID
+      - PGID=${PGID:-100}
+      # specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
+      - TZ=${TZ:-Europe/Amsterdam}
+    volumes:
+      # Configuration files.
+      - ${BASEDIR:-/volume1/docker}/readme-sync/config:/config
+    ports:
+      # Application WebUI
+      - 80:80
+    restart: unless-stopped

lsio/readme-sync/docker-run.sh

@@ -0,0 +1,11 @@
+This container needs special attention. Please check https://hub.docker.com/r/linuxserver/readme-sync for details.
+source ./.env
+docker run -d \
+  --name=readme-sync \
+  -e PUID=${PUID:-1024} `# for UserID` \
+  -e PGID=${PGID:-100} `# for GroupID` \
+  -e TZ=${TZ:-Europe/Amsterdam} `# specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).` \
+  -p 80:80 `# Application WebUI` \
+  -v ${BASEDIR:-/volume1/docker}/readme-sync/config:/config `# Configuration files.` \
+  --restart unless-stopped \
+  ghcr.io/linuxserver/readme-sync

lsio/readme-sync/run-once.sh

@@ -0,0 +1,3 @@
+ln -s ../docker-env.cfg ./.env
+. ./.env
+mkdir -p ${BASEDIR:-/volume1/docker}/readme-sync/config

lsio/tester/docker-compose.yaml

@@ -0,0 +1,16 @@
+# This internal tool is used as a desktop sandbox in our CI process to grab a
+# screenshot of a hopefully functional endpoint
+
+---
+version: "2.1"
+services:
+  tester:
+    image: ghcr.io/linuxserver/tester
+    container_name: tester
+    environment:
+      # Specify an endpoint, the container will automatically determine the correct protocol and program to use
+      - URL=http://google.com
+    ports:
+      # WebUI
+      - 3000:3000
+    restart: unless-stopped

lsio/tester/docker-run.sh

@@ -0,0 +1,10 @@
+# This internal tool is used as a desktop sandbox in our CI process to grab a
+# screenshot of a hopefully functional endpoint
+
+source ./.env
+docker run -d \
+  --name=tester \
+  -e URL=http://google.com `# Specify an endpoint, the container will automatically determine the correct protocol and program to use` \
+  -p 3000:3000 `# WebUI` \
+  --restart unless-stopped \
+  ghcr.io/linuxserver/tester

lsio/tester/run-once.sh

@@ -0,0 +1,2 @@
+ln -s ../docker-env.cfg ./.env
+. ./.env

lsio/ubooquity/docker-compose.yaml

@@ -16,7 +16,7 @@ services:
       # specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
       - TZ=${TZ:-Europe/Amsterdam}
       # To set the maximum memory. ( ex: set '1024' for 1GB )
-      - MAXMEM=<maxmem>
+      - MAXMEM=
     volumes:
       # Config files and database for ubooquity.
       - ${BASEDIR:-/volume1/docker}/ubooquity/config:/config

lsio/ubooquity/docker-run.sh

@@ -8,7 +8,7 @@ docker run -d \
   -e PUID=${PUID:-1024} `# for UserID` \
   -e PGID=${PGID:-100} `# for GroupID` \
   -e TZ=${TZ:-Europe/Amsterdam} `# specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).` \
-  -e MAXMEM=<maxmem> `# To set the maximum memory. ( ex: set '1024' for 1GB )` \
+  -e MAXMEM= `# To set the maximum memory. ( ex: set '1024' for 1GB )` \
   -p 2202:2202 `# The library port.` \
   -p 2203:2203 `# The admin port.` \
   -v ${BASEDIR:-/volume1/docker}/ubooquity/config:/config `# Config files and database for ubooquity.` \

lsio/wikijs/docker-compose.yaml

@@ -14,6 +14,18 @@ services:
       - PGID=${PGID:-100}
       # specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
       - TZ=${TZ:-Europe/Amsterdam}
+      # Set to sqlite (default) or postgres depending on the database engine you wish to use
+      - DB_TYPE=sqlite # optional
+      # DB hostname (postgres only)
+      - DB_HOST= # optional
+      # DB port (postgres only)
+      - DB_PORT= # optional
+      # DB name (postgres only)
+      - DB_NAME= # optional
+      # DB username (postgres only)
+      - DB_USER= # optional
+      # DB password (postgres only)
+      - DB_PASS= # optional
     volumes:
       # Where Wiki.js config is stored.
       - ${BASEDIR:-/volume1/docker}/wikijs/config:/config

lsio/wikijs/docker-run.sh

@@ -7,6 +7,12 @@ docker run -d \
   -e PUID=${PUID:-1024} `# for UserID` \
   -e PGID=${PGID:-100} `# for GroupID` \
   -e TZ=${TZ:-Europe/Amsterdam} `# specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).` \
+  -e DB_TYPE=sqlite `# optional` `# Set to sqlite (default) or postgres depending on the database engine you wish to use` \
+  -e DB_HOST= `# optional` `# DB hostname (postgres only)` \
+  -e DB_PORT= `# optional` `# DB port (postgres only)` \
+  -e DB_NAME= `# optional` `# DB name (postgres only)` \
+  -e DB_USER= `# optional` `# DB username (postgres only)` \
+  -e DB_PASS= `# optional` `# DB password (postgres only)` \
   -p 3000:3000 `# Port for Wiki.js's web interface.` \
   -v ${BASEDIR:-/volume1/docker}/wikijs/config:/config `# Where Wiki.js config is stored.` \
   -v ${BASEDIR:-/volume1/docker}/wikijs/data:/data `# Where Wiki.js data is stored.` \