aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntoni Sawicki <tenox@google.com>2022-11-29 02:50:32 -0800
committerAntoni Sawicki <tenox@google.com>2022-11-29 02:50:32 -0800
commit02350c92d5b94ba672b12dc1d47fdbb8145b4c21 (patch)
tree0b948d9ab1d965c1da3522ad274f4a2ca80b156b
parenteb9b99f192ea7415023789cb027a1af40483acc8 (diff)
downloadwfm-02350c92d5b94ba672b12dc1d47fdbb8145b4c21.tar.gz
readme update
-rw-r--r--README.md20
-rw-r--r--TODO.md2
2 files changed, 18 insertions, 4 deletions
diff --git a/README.md b/README.md
index 94636e6..ba75009 100644
--- a/README.md
+++ b/README.md
@@ -77,10 +77,20 @@ $ docker run -d -p 8080:8080 --user 1234:1234 -v /some/host/dir:/data tenox7/wfm
WFM docker container expects the data directory to be mounted in `/data` inside the
container. This can be overridden with `--prefix` flag if necessary.
-TODO(tenox): password file in docker
+To supply json password file to the docker container you can mount it:
-You may also need add `--nopass_rw` if running without password file and `--allow_root`
-if you don't specify `--user` in Docker run.
+```shell
+$ docker run -d -p 8080:8080 \
+ --user 1234:1234 \
+ -v /some/host/dir:/data \
+ -v /some/dir/wfmpasswd.json:/etc/wfmusers.json
+ tenox7/wfm -passwd=/etc/wfmusers.json
+```
+
+If not using password file you may also need add `--nopass_rw`.
+
+If you don't specify `--user` in Docker run you may also need `--allow_root` since the
+wfm will be running as user id 0 inside the container.
## SSL / TLS / Auto Cert Manager
@@ -92,7 +102,7 @@ Example deployment with SSL:
```text
ExecStart=/usr/local/sbin/wfm \
-passwd=/usr/local/etc/wfmpasswd.json \
- -chroot=/home/user \
+ -chroot=/var/www/html \
-setuid=user \
-addr=:443 \
-acm_addr=:80 \
@@ -104,6 +114,8 @@ The flag `-addr=:443` makes WFM listen on port 443 for https requests.
Flag `-acm_addr=:80` is used for Auto Cert Manager to obtain the cert
and then redirect to port 443/https. `-acm_dir=/.certs` is where the
certificate and key are stored. This directory is inside chroot jail.
+You may want to use `--prefix` inside chroot to hide it.
+
The `-acm_host=` is a repeated flag that adds specific host to a whitelist.
ACM will only obtain certificates for whitelisted hosts. If your WFM
site has multiple names in DNS you need to add them to the whitelist.
diff --git a/TODO.md b/TODO.md
index 3f74520..d551198 100644
--- a/TODO.md
+++ b/TODO.md
@@ -2,6 +2,8 @@
## Interfaces
+* Multiple --prefix instances, this should be possible with map of afero.FS
+ indexed by prefix name so it can be looked up inside wfmMain
* WebDAV server
* FastCGI Interface
* Caddy module