nikdoof/rustical
1
1
Fork 0
mirror of https://github.com/lennart-k/rustical.git synced 2025-12-13 22:52:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update

Browse Source
This commit is contained in:
Lennart
2025-04-17 22:11:26 +02:00
parent 2bd1c0912f
commit 2f685bbeed
2 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/installation.md
View File

@@ -12,20 +12,35 @@ cargo install --locked --git https://github.com/lennart-k/rustical
docker run \
-p 4000:4000 \
-v YOUR_DATA_DIR:/var/lib/rustical/ \
-v YOUR_CONFIG_TOML:/etc/rustical/config.toml \
-v YOUR_PRINCIPALS_TOML:/etc/rustical/principals.toml \
-v YOUR_CONFIG_TOML:/etc/rustical/config.toml \ # (1)!
-e RUSTICAL__CONFIG_OPTION="asd" \ # (2)!
ghcr.io/lennart-k/rustical
```
1. Mount config file
2. Alternatively specify configuration using environment variables
## Configuration
RustiCal can be configured using either a `config.toml` file or environent variables.
To see all configuration options available you can browse the [Cargo docs](/rustical/_crate/rustical/config/struct.Config.html).
### TOML
You can generate a default `config.toml` configuration using
```sh title="Generate default config.toml"
rustical gen-config
```
### Environment variables
The options in `config.toml` can also be configured using environment variables. Names translate the following:
The options in `config.toml` can also be configured using environment variables.
Names translate the following:
```toml title="config.toml"
```toml title="Example config.toml"
[data_store.toml]
path = "asd"
```