Skip to content

Commit ddf2ebd

Browse files
committed
Document further restrictions on pgBackRest options
Issue: [sc-13325]
1 parent 8e1f1e2 commit ddf2ebd

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

internal/pgbackrest/config.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,15 @@ the option occurs twice on the command-line or twice in a file:
150150
ERROR: [031]: option 'io-timeout' cannot be set multiple times
151151
```
152152

153+
A few options are only allowed in certain places. Credentials, for example,
154+
cannot be passed as command-line arguments (see `PARSE_RULE_OPTION_SECURE` in [parse.auto.c][]).
155+
Some others cannot be in INI files (see `cfgSectionCommandLine` in [parse.auto.c][]).
156+
Notably, these must be environment variables or command-line arguments:
157+
158+
- `--repo` and `--stanza`
159+
- restore `--target` and `--target-action`
160+
- backup and restore `--type`
161+
153162
pgBackRest looks for and loads multiple INI files from multiple places according
154163
to the `config`, `config-include-path`, and/or `config-path` options. The order
155164
is a [little complicated][file-precedence]. When none of these options are set:

0 commit comments

Comments
 (0)