Mirrors/continuwuity
1
0
Fork 0
mirror of https://forgejo.ellis.link/continuwuation/continuwuity.git synced 2026-05-26 20:49:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): Apply more changes to improve clarity and grammar

Browse Source 
* CONTINUWUITY_WELL_KNOWN requires a "Struct", not a JSON array
* Fix all instances of Intl English to English English
* Typo/grammar nits fixings
This commit is contained in:
stratself
2026-04-15 13:18:59 +00:00
committed by Ellis Git
parent 1fe13b927d
commit ed76f50e71
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration.mdx
+4 -4
View File
@@ -18,10 +18,10 @@ Alternatively, you can use the environment variable `CONTINUWUITY_CONFIG` to spe
All of the options in the config file can also be specified by using environment variables. This is ideal for containerised deployments and infrastructure-as-code scenarios. All of the options in the config file can also be specified by using environment variables. This is ideal for containerised deployments and infrastructure-as-code scenarios.
The environment variable names is represented in all caps and prefixed with `CONTINUWUITY_`. They are mapped to config options in the ways demonstrated below: The environment variable names are represented in all caps and prefixed with `CONTINUWUITY_`. They are mapped to config options in the ways demonstrated below:
```bash ```bash
# Top-level options (those inside the [global] section) are simply capitalized # Top-level options (those inside the [global] section) are simply capitalised
CONTINUWUITY_SERVER_NAME="matrix.example.com" CONTINUWUITY_SERVER_NAME="matrix.example.com"
CONTINUWUITY_PORT="8008" CONTINUWUITY_PORT="8008"
CONTINUWUITY_DATABASE_PATH="/var/lib/continuwuity" CONTINUWUITY_DATABASE_PATH="/var/lib/continuwuity"
@@ -34,7 +34,7 @@ CONTINUWUITY_WELL_KNOWN__SERVER="example.com:443"
# This maps to the `base_url` field of the `[global.antispam.draupnir]` section in TOML # This maps to the `base_url` field of the `[global.antispam.draupnir]` section in TOML
CONTINUWUITY_ANTISPAM__DRAUPNIR__BASE_URL="https://draupnir.example.com" CONTINUWUITY_ANTISPAM__DRAUPNIR__BASE_URL="https://draupnir.example.com"
# Alternatively, you can pass a quoted JSON object to define an entire section # Alternatively, you can pass a (quoted) struct to define an entire section
# This maps to the [global.well_known] section # This maps to the [global.well_known] section
CONTINUWUITY_WELL_KNOWN="{ client=https://example.com,server=example.com:443 }" CONTINUWUITY_WELL_KNOWN="{ client=https://example.com,server=example.com:443 }"
``` ```
@@ -62,7 +62,7 @@ Note that the config is parsed as TOML, and shells like `bash` will remove quote
## Order of priority ## Order of priority
The above configuration methods are prioritized, in descending order, as below: The above configuration methods are prioritised, in descending order, as below:
- Command-line `-o`/`--option` flags - Command-line `-o`/`--option` flags
- Environment variables - Environment variables