Environment variables docs

This commit is contained in:
DarkCat09 2023-09-01 16:45:16 +04:00
parent 2750ec3a27
commit 9e7d87d7af
Signed by: DarkCat09
GPG key ID: 0A26CD5B3345D6E3

26
docs/env.md Normal file
View file

@ -0,0 +1,26 @@
# Configuring
txtdot can be configured either with environment variables
or with the `.env` file in the working directory which has higher priority.
For sample config, see [`.env.example`](https://github.com/TxtDot/txtdot/blob/main/.env.example).
## HOST
Default: `0.0.0.0`
Host where HTTP server should listen for connections.
Set it to `127.0.0.1` if your txtdot instance is behind reverse proxy,
`0.0.0.0` otherwise.
## PORT
Default: `8080`
Port where HTTP server should listen for connections.
## REVERSE_PROXY
Default: `false`
Set it to `true` only if your txtdot instance runs behind reverse proxy.
Needed for processing X-Forwarded headers.