Skip to content

Commit 5eba2b4

Browse files
authored
docs(readme): clarify CLI argument naming convention (#9)
1 parent 6608195 commit 5eba2b4

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,9 @@ For a detailed explanation of all configuration options, refer to the comments w
7979

8080
### Command Line Arguments
8181

82-
To override the default configuration settings, use the command line arguments using the `--key=value` (key is the YAML path) format. The YAML path is used to access the corresponding value in the configuration. For example, to override the log level, use the `--loglevel=INFO` argument. For the docker host, use the `--docker.host` argument.
82+
To override the default configuration settings, use the command line arguments using the `--key=value` format. The key is a YAML config path and is used to override the corresponding value in the configuration. The keys must be all lowercase.
83+
84+
For example, to override the log level, use the `--loglevel=INFO` argument. For the docker host, use the `--docker.host` argument. For the Traefik container name use the `--traefik.containername` argument.
8385

8486
List of available command line arguments can be found using `--help`, and explaination in the `config.yaml` file.
8587

0 commit comments

Comments
 (0)