Skip to content

Commit af06405

Browse files
committed
docs: Extend config env var example
1 parent e332799 commit af06405

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,10 +238,9 @@ subdirectories are merged like so:
238238

239239
> 💡 You can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`)
240240
>
241-
> See [examples/docker-compose-postgres-storage/config/config.yaml](.examples/docker-compose-postgres-storage/config/config.yaml) or for an example.
241+
> ⚠️ When your configuration parameter contains a `$` symbol, you have to escape `$` with `$$`.
242242
>
243-
> When your configuration parameter contains a `$` symbol, you have to escape `$` with `$$`.
244-
243+
> See [Use environment variables in config files](#use-environment-variables-in-config-files) or [examples/docker-compose-postgres-storage/config/config.yaml](.examples/docker-compose-postgres-storage/config/config.yaml) for examples.
245244

246245
| Parameter | Description | Default |
247246
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|
@@ -3295,8 +3294,9 @@ web:
32953294
port: ${PORT}
32963295
32973296
ui:
3298-
title: ${CUSTOM_TITLE}
3297+
title: $TITLE $$ Gatus Monitoring # With env var set to "Example" this will expand to "Example $ Gatus Monitoring"
32993298
```
3299+
⚠️ When your configuration parameter contains a `$` symbol, you have to escape `$` with `$$`.
33003300

33013301
### Configuring a startup delay
33023302
If, for any reason, you need Gatus to wait for a given amount of time before monitoring the endpoints on application start, you can use the `GATUS_DELAY_START_SECONDS` environment variable to make Gatus sleep on startup.

0 commit comments

Comments
 (0)