twins-upstream/CONFIGURATION.md

32 lines
839 B
Markdown
Raw Normal View History

Paths may be defined as fixed strings or regular expressions (starting with `^`).
Fixed string paths will match with and without a trailing slash.
2020-10-30 01:17:23 +01:00
Serve entries have either a `root` path or `proxy` URL. When a `root` path is
provided static files and directories are served from that location. When a
`proxy` URL is provided requests are forwarded to the Gemini server at that URL.
When accessing a directory `index.gemini` or `index.gmi` is served.
2020-10-29 21:35:48 +01:00
# config.yaml
```yaml
# Path to certificate and private key
cert: /home/twins/data/certfile.crt
key: /home/twins/data/keyfile.key
2020-10-30 01:17:23 +01:00
# Server paths
2020-10-29 21:35:48 +01:00
serve:
-
path: /sites
2020-10-29 21:35:48 +01:00
root: /home/twins/data/sites
-
path: ^/(help|info)$
2020-10-29 21:35:48 +01:00
root: /home/twins/data/help
2020-10-30 01:17:23 +01:00
-
path: ^/proxy-example$
proxy: gemini://gemini.rocks
2020-10-29 21:35:48 +01:00
-
path: /
2020-10-29 21:35:48 +01:00
root: /home/twins/data/home
```