Bot Updating Templated Files

images/docker-quassel-core.md

@@ -25,7 +25,7 @@ The architectures supported by this image are:
 | :----: | --- |
 | x86-64 | amd64-latest |
 | arm64 | arm64v8-latest |
-| armhf | arm32v6-latest |
+| armhf | arm32v7-latest |
 
 
 ## Usage
@@ -40,7 +40,9 @@ docker create \
   -e PUID=1000 \
   -e PGID=1000 \
   -e TZ=Europe/London \
+  -e RUN_OPTS=--config-from-environment `#optional` \
   -p 4242:4242 \
+  -p 113:10113 `#optional` \
   -v <path to data>:/config \
   --restart unless-stopped \
   linuxserver/quassel-core
@@ -62,10 +64,13 @@ services:
       - PUID=1000
       - PGID=1000
       - TZ=Europe/London
+      - RUN_OPTS=--config-from-environment #optional
     volumes:
       - <path to data>:/config
     ports:
       - 4242:4242
+    ports:
+      - 113:10113 #optional
     restart: unless-stopped
 ```
 
@@ -78,6 +83,7 @@ Docker images are configured using parameters passed at runtime (such as those a
 | Parameter | Function |
 | :----: | --- |
 | `4242` | The port quassel-core listens for connections on. |
+| `10113` | Optional Ident Port |
 
 
 ### Environment Variables (`-e`)
@@ -87,6 +93,7 @@ Docker images are configured using parameters passed at runtime (such as those a
 | `PUID=1000` | for UserID - see below for explanation |
 | `PGID=1000` | for GroupID - see below for explanation |
 | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
+| `RUN_OPTS=--config-from-environment` | Custom CLI options for Quassel |
 
 ### Volume Mappings (`-v`)
 
@@ -119,6 +126,55 @@ Once you have the container running, fire up a quassel desktop client and connec
 
 You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.io/index.php/irc/) `#linuxserver.io` room on Freenode. Click 'File' > 'Networks' > 'Configure Networks' > 'Add' (under Networks section, not Servers) > 'Use preset' > Select 'Freenode' and then configure your identity using the tabs in the 'Network details' section. Once connected to Freenode, click `#join` and enter `#linuxserver.io`. That's it, you're done.
 
+## Stateless usage
+
+To use Quassel in stateless mode, where it needs to be configured through
+environment arguments, run it with the `--config-from-environment` RUN_OPTS environment setting.
+
+| Env | Usage |
+| :----: | --- |
+| DB_BACKEND | `SQLite` or `PostgreSQL` |
+| DB_PGSQL_USERNAME | PostgreSQL User |
+| DB_PGSQL_PASSWORD | PostgreSQL Password |
+| DB_PGSQL_HOSTNAME | PostgreSQL Host |
+| DB_PGSQL_PORT | PostgreSQL Port |
+| AUTH_AUTHENTICATOR | `Database` or `LDAP` |
+| AUTH_LDAP_HOSTNAME | LDAP Host |
+| AUTH_LDAP_PORT | LDAP Port |
+| AUTH_LDAP_BIND_DN | LDAP Bind Domain |
+| AUTH_LDAP_BIND_PASSWORD | LDAP Password |
+| AUTH_LDAP_FILTER | LDAP Authentication Filters |
+| AUTH_LDAP_UID_ATTRIBUTE | LDAP UID |
+
+Additionally you have RUN_OPTS that can be used to customize pathing and behvior.
+
+| Option | Example |
+| :----: | --- |
+| --strict-ident | strictly bool `--strict-ident` |
+| --ident-daemon | strictly bool `--ident-daemon` |
+| --ident-port | `--ident-port "10113"` |
+| --ident-listen | `--ident-listen "::,0.0.0.0"` |
+| --ssl-cert | `--ssl-cert /config/keys/cert.crt` |
+| --ssl-key | `--ssl-key /config/keys/cert.key` |
+| --require-ssl | strictly bool `--require-ssl` |
+
+Minimal example with SQLite:
+
+```
+docker create \
+  --name=quassel-core \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Europe/London \
+  -e RUN_OPTS='--config-from-environment' \
+  -e DB_BACKEND=SQLite \
+  -e AUTH_AUTHENTICATOR=Database \
+  -p 4242:4242 \
+  -v <path to data>:/config \
+  --restart unless-stopped \
+  linuxserver/quassel-core
+```
+
 
 
 ## Support Info
@@ -134,6 +190,8 @@ You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.i
 
 ## Versions
 
+* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
+* **20.03.19:** - Make stateless operation an option, with input from one of the quassel team.
 * **26.01.19:** - Add pipeline logic and multi arch.
 * **08.01.19:** - Rebase to Ubuntu Bionic and upgrade to Quassel`0.13.0` See [here.](https://quassel-irc.org/node/134).
 * **30.07.18:** - Rebase to alpine:3.8 and use buildstage.