@@ -1,46 +1,10 @@
 # Environment Variables

@@ -6,3 +6,2 @@
 
-Continuwuity uses a config file for the majority of the settings, but also supports
-setting individual config options via commandline.
+Continuwuity uses a config file for the majority of the settings. This is the recommended way to configure Continuwuity. Please refer to the [example config file](./reference/config.mdx) for all of those settings.

@@ -10,3 +9,1 @@
-Please refer to the [example config
-file](./reference/config.mdx) for all of those
-settings.
+The config file to use can be specified on the commandline when running Continuwuity by specifying the `-c`/ `--config` flag:

@@ -17,2 +11,2 @@
-used; see [the section on environment variables](#environment-variables) for
-more information.
+```bash
+~$ ./conduwuit -c /path/to/continuwuity.toml

@@ -24,1 +17,3 @@
-server_name=\"example.com\"`.
+## Environment variables
+
+All of the config file settings can also be specified by using environment variables. This makes it ideal for containerised deployments and infrastructure-as-code scenarios.

@@ -25,0 +18,4 @@
+
+All of the config file settings can also be specified by using environment variables. This makes it 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 the configuration file with the syntaxes as demonstrated below:

@@ -25,0 +21,4 @@
+The environment variable names is represented in all caps and prefixed with `CONTINUWUITY_`. They are mapped to the configuration file with the syntaxes as demonstrated below:
+
+```bash
+# Top-level configs (those inside the [global] section) are simply capitalized

@@ -25,0 +36,4 @@
+
+# Alternatively, you can pass a JSON object to define the entire section
+# This maps to the [global.well_known] section
+CONTINUWUITY_WELL_KNOWN={ client=https://example.com,server=example.com:443 }

@@ -25,0 +46,4 @@
+- `CONDUWUIT_*` (compatibility)
+- `CONDUIT_*` (legacy)
+
+So, for example, the environment variable `CONTINUWUITY_CONFIG` can also be expressed as `CONDUWUIT_CONFIG` or `CONDUIT_CONFIG`.

@@ -43,0 +77,4 @@
+
+## Execute startup commands
+
+Continuwuity supports running admin commands on startup using the commandline argument `--execute`. The syntax of this is a standard admin command without the `!admin` prefix. For example, to create a new user:

@@ -43,0 +80,4 @@
+Continuwuity supports running admin commands on startup using the commandline argument `--execute`. The syntax of this is a standard admin command without the `!admin` prefix. For example, to create a new user:
+
+```
+./conduwuit --execute "users create_user june"

@@ -25,0 +18,4 @@
+
+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:

@@ -25,0 +21,4 @@
+The environment variable names is represented in all caps and prefixed with `CONTINUWUITY_`. They are mapped to config options in the ways demonstrated below:
+
+```bash
+# Top-level options (those inside the [global] section) are simply capitalized

@@ -25,0 +36,4 @@
+
+# Alternatively, you can pass a quoted JSON object to define an entire section
+# This maps to the [global.well_known] section
+CONTINUWUITY_WELL_KNOWN="{ client=https://example.com,server=example.com:443 }"

@@ -37,3 +65,1 @@
-Continuwuity supports running admin commands on startup using the commandline
-argument `--execute`. The most notable use for this is to create an admin user
-on first startup.
+The above configuration methods are prioritized, in descending order, as below: