Skip to content

Commit e332799

Browse files
docs: Move config infos to config section
1 parent 503a363 commit e332799

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
@@ -222,6 +222,9 @@ This example would look similar to this:
222222
223223
![Simple example](.github/assets/example.jpg)
224224
225+
If you want to test it locally, see [Docker](#docker).
226+
227+
## Configuration
225228
By default, the configuration file is expected to be at `config/config.yaml`.
226229

227230
You can specify a custom path by setting the `GATUS_CONFIG_PATH` environment variable.
@@ -235,14 +238,11 @@ subdirectories are merged like so:
235238

236239
> 💡 You can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`)
237240
>
238-
> See [examples/docker-compose-postgres-storage/config/config.yaml](.examples/docker-compose-postgres-storage/config/config.yaml) for an example.
241+
> See [examples/docker-compose-postgres-storage/config/config.yaml](.examples/docker-compose-postgres-storage/config/config.yaml) or for an example.
239242
>
240243
> When your configuration parameter contains a `$` symbol, you have to escape `$` with `$$`.
241244

242-
If you want to test it locally, see [Docker](#docker).
243-
244245

245-
## Configuration
246246
| Parameter | Description | Default |
247247
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|
248248
| `metrics` | Whether to expose metrics at `/metrics`. | `false` |

0 commit comments

Comments
 (0)