aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2023-02-24 13:27:34 +0100
committermetamuffin <metamuffin@disroot.org>2023-02-24 13:27:34 +0100
commit7818e729c78e79cf80edd3e22eda098f52fb6c45 (patch)
tree7e7094b8a8407be9595516ee7e8e483e848cc7bc /readme.md
parent3ed98e04da0917e790063549676729c7051d67f7 (diff)
downloadgnix-7818e729c78e79cf80edd3e22eda098f52fb6c45.tar
gnix-7818e729c78e79cf80edd3e22eda098f52fb6c45.tar.bz2
gnix-7818e729c78e79cf80edd3e22eda098f52fb6c45.tar.zst
"document" fileserver
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 67150c8..3d4eb28 100644
--- a/readme.md
+++ b/readme.md
@@ -29,8 +29,15 @@ tls_key = "ssl/key.pem" # only accepts pkcs8 for now
[hosts]
"testdomain.local" = { backend = "127.0.0.1:3000" }
"secondomain.local" = { backend = "1.2.3.4:5678" }
+"static.testdomain.local" = { files = { root = "/srv/http", index = true } }
```
+The configuration can either be specify a backend to forward to or the `files`
+key. In that case, static files are served from `root` and directory listings
+will be generated if `index` is true (default). If a directory contains
+`index.html` the listing is replace with that file. If `index.banner.html`, it's
+content is inserted before the listing.
+
# License
AGPL-3.0-only; see [COPYING](./COPYING)