commit 3685706f79db42b2af2914ca7e850a5086834e15
parent b5423d16bf3bff775eeb2f2a40e6b148fa4d2933
Author: FIGBERT <figbert@figbert.com>
Date: Thu, 19 May 2022 14:18:43 -0700
Add README.md with documentation
Diffstat:
| A | README.md | | | 53 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 53 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# dockerfiles
+
+Various Dockerfiles for projects that don't have them.
+
+## alps
+
+The `CMD` value is passed to an `alps` binary. By default this is `-h`,
+but this will need to be customized for your setup. For example:
+```yaml
+command: ["-addr", ":80", "-login-key", "${ALPS_LOGIN_KEY}", "-theme", "sourcehut", "${ALPS_IMAP}", "${ALPS_SMTP}"]
+```
+
+## soju
+
+The `CMD` value is passed to a `soju` binary. By default this is
+`-config /soju/config`. This expects a config file mounted at
+`/soju/config`. Depending on your config file, you will need to mount
+various other volumes into the container. For example:
+
+```
+soju config
+-----------
+listen :6697
+hostname example.com
+tls /soju/certs/fullchain.pem /soju/certs/privkey.pem
+db sqlite3 /soju/soju.db
+log fs /soju/log
+
+
+docker-compose.yml
+------------------
+soju:
+ ...
+ volumes:
+ - ./soju/config:/soju/config
+ - ./soju/log:/soju/log
+ - ./soju/soju.db:/soju/soju.db
+ - ./soju/certs:/soju/certs
+```
+
+## stagit
+
+Generates and serves static HTML pages from a directory of git
+repositories with `stagit` and `nginx`.
+
+Requirements:
+- directory mounted at `/git` with your repositories as subdirectories
+- clone url prefix in the `GIT_BASE_URL` environment variable (example:
+ `https://git.example.com`)
+- files mounted in the nginx folder (`/usr/share/nginx/html`)
+ - `favicon.png` -> favicon image
+ - `logo.png` -> 32x32 logo
+ - `style.css` -> CSS stylesheet
