From 412b6d30a45a9b7954cd1fd22e008a30548c0ff0 Mon Sep 17 00:00:00 2001 From: Sebastian Date: Tue, 16 Sep 2025 22:29:09 +0200 Subject: [PATCH] docs: information on escaping endpoint url in config (#1242) * Update README.md with information on escaping endpoint url in configuration Clarify usage of environment variables in configuration file and provide guidance for escaping special characters. * Update README.md Move comment about escaping to the section with env variables. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index acd5d2de..fc5a370d 100644 --- a/README.md +++ b/README.md @@ -234,6 +234,8 @@ subdirectories are merged like so: > 💡 You can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`) > > See [examples/docker-compose-postgres-storage/config/config.yaml](.examples/docker-compose-postgres-storage/config/config.yaml) for an example. +> +> When your configuration parameter contains a `$` symbol, you have to escape `$` with `$$`. If you want to test it locally, see [Docker](#docker). @@ -321,7 +323,6 @@ You may use the following placeholders in the body (`endpoints[].body`): - `[LOCAL_ADDRESS]` (resolves to the local IP and port like `192.0.2.1:25` or `[2001:db8::1]:80`) - `[RANDOM_STRING_N]` (resolves to a random string of numbers and letters of length N (max: 8192)) - ### External Endpoints Unlike regular endpoints, external endpoints are not monitored by Gatus, but they are instead pushed programmatically. This allows you to monitor anything you want, even when what you want to check lives in an environment that would not normally be accessible by Gatus.