From 2f685bbeed24592fdea39371ff32c8e85a7c1ef1 Mon Sep 17 00:00:00 2001 From: Lennart <18233294+lennart-k@users.noreply.github.com> Date: Thu, 17 Apr 2025 22:11:26 +0200 Subject: [PATCH] docs: Update --- docs/installation.md | 21 ++++++++++++++++++--- mkdocs.yml | 2 +- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index c17b362..dd8cb8a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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" ``` diff --git a/mkdocs.yml b/mkdocs.yml index 3f36334..f778997 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,4 +63,4 @@ nav: - developers/index.md - Relevant RFCs: developers/rfcs.md - Debugging: developers/debugging.md - - Cargo docs: _cargo/rustical/ + - Cargo docs: /rustical/_crate/rustical/