Document environment variable configuration

This commit is contained in:
Lennart
2025-02-11 16:34:52 +01:00
parent 176bd238a4
commit f7399266ca

View File

@@ -36,6 +36,8 @@ docker run \
## Configuration ## Configuration
RustiCal can either be configured using a TOML file or using environment variables.
You can generate a default `config.toml` with You can generate a default `config.toml` with
```sh ```sh
@@ -48,6 +50,24 @@ rustical gen-config
You'll have to set your database path to something like `/var/lib/rustical/db.sqlite3`. You'll have to set your database path to something like `/var/lib/rustical/db.sqlite3`.
### Environment variables
The options in `config.toml` can also be configured using environment variables. Names translate the following:
```toml
[data_store.toml]
path = "asd"
```
becomes `RUSTICAL_DATA_STORE__TOML__PATH`.
Every variable is
- uppercase
- prefixed by `RUSTICAL_`
- Dots become `__`
### Users and groups
Next, configure the principals by creating a file specified in `auth.toml.path` (by default `/etc/rustical/principals.toml`) and inserting your principals: Next, configure the principals by creating a file specified in `auth.toml.path` (by default `/etc/rustical/principals.toml`) and inserting your principals:
```toml ```toml