documentation/docs/env.md

40 lines
868 B
Markdown
Raw Normal View History

2023-09-01 15:45:16 +03:00
# 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.
2023-09-25 12:00:24 +03:00
## PROXY_RES
Default: `true`
Whether to allow proxying images, video, audio
and everything else through your txtdot instance.
## SWAGGER
Default: `false`
Whether to add `/doc` route for Swagger API docs.