studio/tuwunel
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Enhanced docu for configuration

Browse Source 
Include that more than one config file can be named.
Describe the relevance of ordering for setting the value.
This commit is contained in:
ObiomaAtWanagu
2025-07-05 11:46:08 +02:00
committed by Jason Volk
parent 9dd2b28605
commit fd080914c2
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/configuration.md
View File

@@ -7,14 +7,15 @@ This chapter describes various ways to configure Tuwunel.
Tuwunel uses a config file for the majority of the settings, but also supports Tuwunel uses a config file for the majority of the settings, but also supports
setting individual config options via commandline. setting individual config options via commandline.
Please refer to the [example config Please refer to the [example config file](./configuration/examples.md#example-configuration) for all of those settings.
file](./configuration/examples.md#example-configuration) for all of those
settings.
The config file to use can be specified on the commandline when running The config file to use can be specified on the commandline when running
Tuwunel by specifying the `-c`, `--config` flag. Alternatively, you can use Tuwunel by specifying the `-c`, `--config` flag. It is also possible to specify
the environment variable `TUWUNEL_CONFIG` to specify the config file to used. more than one config file.
Conduit's environment variables are supported for backwards compatibility.
Alternatively, you can use the environment variable `TUWUNEL_CONFIG` to specify
the config file to used. Conduit's environment variables are supported for
backwards compatibility.
## Option commandline flag ## Option commandline flag
@@ -31,6 +32,20 @@ string. This does not apply to options that take booleans or numbers:
- `--option log=\"debug\"` works ✅ - `--option log=\"debug\"` works ✅
- `--option server_name='"example.com'"` works ✅ - `--option server_name='"example.com'"` works ✅
## Relevance of configuration settings
There is a specific sequence for reading and overwriting the settings. The
latest setting takes precedence and defines the configuration.
1. Set in `CONDUIT_CONFIG`.
2. Set in `CONDUWUIT_CONFIG`.
3. Set in `TUWUNEL_CONFIG`.
4. Set in the first config file on the command line (e.g. `-c config_file_1.toml`).
5. Set in the second config file on the command line (e.g. `-c config_file_2.toml`).
6. Set in any additional config file on the command line (e.g. `-c config_file_n.toml`).
7. Set within the options (again, the latest option in the list overrides).
## Execute commandline flag ## Execute commandline flag
Tuwunel supports running admin commands on startup using the commandline Tuwunel supports running admin commands on startup using the commandline