Skip to content

Commit 2c2dc25

Browse files
authored
Merge pull request #407 from databacker/config-file-flag
update docs to show correct usage of --config-file and DB_DUMP_CONFIG Bypassed CI rules because it is just doc changes
2 parents ce48dae + e01c4d6 commit 2c2dc25

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If using environment variables with any credentials in a container, you should c
5151
If using CLI flags with any credentials, you should consider using a config file instead of directly
5252
placing credentials in the flags, where they may be kept in shell history.
5353

54-
There is **no** default configuration file. To use a configuration file, you **must** specify it with the `--config` flag.
54+
There is **no** default configuration file. To use a configuration file, you **must** specify it with the `--config-file` flag.
5555

5656
## Sample Configuration Files
5757

@@ -63,7 +63,7 @@ The following are the environment variables, CLI flags and configuration file op
6363

6464
| Purpose | Backup / Restore / Prune | CLI Flag | Env Var | Config Key | Default |
6565
| --- | --- | --- | --- | --- | --- |
66-
| config file path | BRP | `config` | `DB_DUMP_CONFIG` | | |
66+
| config file path | BRP | `--config-file` | `DB_CONFIG_FILE` | | |
6767
| hostname or unix domain socket path (starting with a slash) to connect to database. Required. | BR | `server` | `DB_SERVER` | `database.server` | |
6868
| port to use to connect to database. Optional. | BR | `port` | `DB_PORT` | `database.port` | 3306 |
6969
| username for the database | BR | `user` | `DB_USER` | `database.credentials.username` | |
@@ -190,6 +190,6 @@ and so on, ad infinitum. In practice, remote service will avoid this.
190190

191191
As of version 1.0 of `mysql-backup`, there is support only for one config file. This means:
192192

193-
* The `--config` flag can be used only once.
193+
* The `--config-file` flag can be used only once.
194194
* The config file does not support [multiple yaml documents in a single file](https://yaml.org/spec/1.2.2/). If you ask it to read a yaml file with multiple documents sepaarted by `---`, it will read only the first one.
195195
* You can have chaining, as described in the [remote configuration](#remote-configuration) section, where one file of kind `remote` references another, which itself is `remote`, etc. But only the final one will be used. It is not merging.

0 commit comments

Comments
 (0)