aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntoni Sawicki <tenox@google.com>2022-03-24 03:02:59 -0700
committerAntoni Sawicki <tenox@google.com>2022-03-24 03:02:59 -0700
commit4fa02c81b6a8e53e8d10b87d24771cbcf6e2914b (patch)
tree2396559d1c3dda4a928b9325c80fde6031eadf5f
parent79d6d2fa1e660852fdf694432f48cad16129253c (diff)
downloadwfm-4fa02c81b6a8e53e8d10b87d24771cbcf6e2914b.tar.gz
readme update
-rw-r--r--README.md46
-rw-r--r--service/systemd/wfm80.service4
2 files changed, 47 insertions, 3 deletions
diff --git a/README.md b/README.md
index d932796..7356d70 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,7 @@ automatically chroot and setuid after port bind is complete.
You can specify Systemd `User=` other than root if you also use `RootDirectory=` for
chroot and use non privileged port (above 1024, eg 8080), or your binary has adequate
-capabilities set. Example [here](service/systemd/wfm80.service).
+capabilities set. Example [here](service/systemd/wfm8080.service).
### Docker
@@ -154,6 +154,50 @@ In this example WFM will serve html files from `/somedir` on / http prefix
with `/admin` as a password protected admin interface where you can edit
and manage the site.
+## Flags
+
+```text
+Usage of ./wfm:
+ -about_runtime
+ Display runtime info in About Dialog (default true)
+ -acm_addr string
+ autocert manager listen address, eg: :80
+ -acm_dir string
+ autocert cache, eg: /var/cache (affected by chroot)
+ -acm_host value
+ autocert manager allowed hostnames
+ -addr string
+ Listen address, eg: :443 (default "127.0.0.1:8080")
+ -addr_extra string
+ Extra non-TLS listener address, eg: :8081
+ -allow_root
+ allow to run as uid=0/root without setuid
+ -cache_ctl string
+ HTTP Header Cache Control (default "no-cache")
+ -chroot string
+ Directory to chroot to
+ -doc_srv string
+ Serve regular http files, fsdir:prefix, eg /var/www:/home
+ -f2b
+ ban ip addresses on user/pass failures (default true)
+ -f2b_dump string
+ enable f2b dump at this prefix, eg. /f2bdump (default no)
+ -logfile string
+ Log file name (default stdout)
+ -nopass_rw
+ allow read-write access if there is no password file
+ -passwd string
+ wfm password file, eg: /usr/local/etc/wfmpw.json
+ -prefix string
+ Default prefix for WFM access (default "/")
+ -proto string
+ tcp, tcp4, tcp6, etc (default "tcp")
+ -setuid string
+ Username to setuid to
+ -show_dot
+ show dot files and folders
+```
+
## History
WFM begun its life around 1994 as a CGI Perl script for CERN httpd server, to allow
uploading and managing customer logs by field support engineers over the web and
diff --git a/service/systemd/wfm80.service b/service/systemd/wfm80.service
index e3e7046..0dcff26 100644
--- a/service/systemd/wfm80.service
+++ b/service/systemd/wfm80.service
@@ -6,8 +6,8 @@ After=network.target
User=root
ExecStart=/usr/local/sbin/wfm \
-addr=:80 \
- -chroot=/datadir \
- -setuid=myuser
+ -chroot=/datadir \
+ -setuid=myuser
Restart=on-failure
SuccessExitStatus=3 4
RestartForceExitStatus=3 4