LibrePages/librepages
4
0
Fork 0
Code Issues 6 Pull requests 10 Projects Releases Packages Wiki Activity

docs: configuration through environment variables

Browse source
This commit is contained in:
Aravinth Manivannan 2022-03-29 19:08:36 +05:30
parent 1fe29fd9b2
commit fc8f86a2af
Signed by: realaravinth
GPG key ID: AD9F0F08E855ED88
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/CONFIGURATION.md Normal file
View file

@ -0,0 +1,37 @@
# Configuration
Pages is highly configurable. Configuration is applied/merged in the
following order:
1. `/etc/static-pages/config.toml`
2. `./config/default.toml`
3. path to configuration file passed in via `PAGES_CONFIG`
4. environment variables.
So if `/etc/static-pages/config.toml` says Pages must listen on port
`4000` and environment variable or `PAGES_CONFIG` file say it should
listen on port `5000`, Pages will listen on `5000`.
## Setup
### Environment variables
Setting environment variables are optional. The configuration files have
all the necessary parameters listed. By setting environment variables,
you will be overriding the values set in the configuration files.
### General
| Name | Value |
| --------------------- | ---------------------------------------- |
| `PAGES_CONFIG` | Path to configuration file |
| `PAGES__SOURCE__CODE` | Link to the source code of this instance |
#### Server
| Name | Value |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PAGES__SERVER__PORT` | The port on which you want Pages to listen to |
| `PORT`(overrides `PAGES__SERVER__PORT`) | The port on which you want Pages to listen to |
| `PAGES__SERVER__IP` | The IP address on which you want Pages to listen to |
| `PAGES__SERVER__WORKERS` | The number of worker threads that must be spun up by the Pages server. Minimum of two threads are advisable for top async performance but can work with one also. |