docs(config): use CONTINUWUITY_ environment prefix
This commit is contained in:
parent
1fd6056f3f
commit
d6c5484c3a
1 changed files with 8 additions and 6 deletions
|
|
@ -13,8 +13,8 @@ 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
|
||||||
Continuwuity by specifying the `-c`, `--config` flag. Alternatively, you can use
|
Continuwuity by specifying the `-c`, `--config` flag. Alternatively, you can use
|
||||||
the environment variable `CONDUWUIT_CONFIG` to specify the config file to used.
|
the environment variable `CONTINUWUITY_CONFIG` to specify the config file to
|
||||||
Conduit's environment variables are supported for backwards compatibility.
|
used. Conduit's environment variables are supported for backwards compatibility.
|
||||||
|
|
||||||
## Option commandline flag
|
## Option commandline flag
|
||||||
|
|
||||||
|
|
@ -52,13 +52,15 @@ This commandline argument can be paired with the `--option` flag.
|
||||||
|
|
||||||
All of the settings that are found in the config file can be specified by using
|
All of the settings that are found in the config file can be specified by using
|
||||||
environment variables. The environment variable names should be all caps and
|
environment variables. The environment variable names should be all caps and
|
||||||
prefixed with `CONDUWUIT_`.
|
prefixed with `CONTINUWUITY_`.
|
||||||
|
|
||||||
For example, if the setting you are changing is `max_request_size`, then the
|
For example, if the setting you are changing is `max_request_size`, then the
|
||||||
environment variable to set is `CONDUWUIT_MAX_REQUEST_SIZE`.
|
environment variable to set is `CONTINUWUITY_MAX_REQUEST_SIZE`.
|
||||||
|
|
||||||
To modify config options not in the `[global]` context such as
|
To modify config options not in the `[global]` context such as
|
||||||
`[global.well_known]`, use the `__` suffix split: `CONDUWUIT_WELL_KNOWN__SERVER`
|
`[global.well_known]`, use the `__` suffix split:
|
||||||
|
`CONTINUWUITY_WELL_KNOWN__SERVER`
|
||||||
|
|
||||||
Conduit's environment variables are supported for backwards compatibility (e.g.
|
Conduit and conduwuit's environment variables are also supported for backwards
|
||||||
|
compatibility, via the `CONDUIT_` and `CONDUWUIT_` prefixes respectively (e.g.
|
||||||
`CONDUIT_SERVER_NAME`).
|
`CONDUIT_SERVER_NAME`).
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue