Skip to content

Commit 1a19799

Browse files
authored
Merge pull request #356 from liammclennan/add-environmentvariables-doc
Add environment variables doc
2 parents 6f786ea + c35500d commit 1a19799

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ To connect to Seq in a docker container on the local machine use the machine's I
3131

3232
Use Docker networks and volumes to make local files and other containers accessible to `seqcli` within its container.
3333

34+
### Environment variable overrides
35+
36+
Each setting value can be overridden at runtime by specifying an environment variable of the form `SEQCLI_<setting path>`, where <setting path> contains one element for each dotted segment of the setting name, separated by underscores.
37+
38+
For example the setting `connection.serverUrl` can overridden with the `SEQCLI_CONNECTION_SERVERURL` variable.
39+
3440
### Connecting without an API key
3541

3642
If you're automating Seq setup, chances are you won't have an API key yet for `seqcli` to use. During the initial Seq server configuration, you can specify `firstRun.adminUsername` and `firstRun.adminPasswordHash` (or the equivalent environment variables `SEQ_FIRSTRUN_ADMINUSERNAME` and `SEQ_FIRSTRUN_ADMINPASSWORDHASH`) to set an initial username and password for the administrator account. You can use these to create an API key, and then use the API key token with the remaining `seqcli` commands.

0 commit comments

Comments
 (0)