Say that a config file's env: section overrides the environment (closes #128)
check / check (push) Successful in 3m22s

A variable named in the config file's env: section is set while the
file loads, so it overrides both the environment the process was started
with and the file's own key. README.md and the config.example.yml header
said only that a variable wins over the file; they now state this
exception where the precedence is given.

Model: opus-5-5
This commit is contained in:
2026-09-28 11:10:23 +00:00
parent a7947da6f1
commit 9b49a9d5b3
2 changed files with 11 additions and 5 deletions
+7 -4
View File
@@ -128,10 +128,13 @@ For the same image at quality 40 with fit `contain`, the input ends in
Every setting can be given as an environment variable, in a YAML config Every setting can be given as an environment variable, in a YAML config
file (`--config`), or both. A variable present in the environment wins over file (`--config`), or both. A variable present in the environment wins over
the file, even when it is empty, and the file wins over the built-in the file, even when it is empty, and the file wins over the built-in
default. A variable's value is parsed as the same text in the file would default. The one exception is a variable named in the file's `env:` section:
be. The three lists take comma-separated entries, with the spaces around it is set while the file loads, so it overrides both the environment the
each trimmed; an empty variable is an empty list. A value that does not process was started with and the file's own key. A variable's value is
parse or is invalid aborts startup, naming the variable. parsed as the same text in the file would be. The three lists take
comma-separated entries, with the spaces around each trimmed; an empty
variable is an empty list. A value that does not parse or is invalid aborts
startup, naming the variable.
| Variable | Config key | Meaning | | Variable | Config key | Meaning |
| ------------------------------------ | ------------------------------- | ---------------------------------------------------------------------------- | | ------------------------------------ | ------------------------------- | ---------------------------------------------------------------------------- |
+4 -1
View File
@@ -4,7 +4,10 @@
# this file: PIXA_ plus the key in upper case, with "." written as "_" # this file: PIXA_ plus the key in upper case, with "." written as "_"
# (state_dir is PIXA_STATE_DIR, metrics.username is # (state_dir is PIXA_STATE_DIR, metrics.username is
# PIXA_METRICS_USERNAME). The one exception is port, which is set by # PIXA_METRICS_USERNAME). The one exception is port, which is set by
# PORT. In a variable, a list is comma-separated. # PORT. In a variable, a list is comma-separated. A variable named in
# this file's env: section is set while the file loads, so it overrides
# both the environment the process was started with and this file's own
# key.
# Server settings # Server settings
port: 8080 port: 8080