Skip to content

Commit

Permalink
feat(docs): improve instructions for providing config file to auditor
Browse files Browse the repository at this point in the history
  • Loading branch information
QuantumDancer committed Apr 11, 2024
1 parent 83a47ea commit 94471c4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions media/website/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,17 @@ log_level: info
This configuration file can be passed to Auditor and will overwrite the default configuration.
If you have compiled Auditor from source, pass the configuration file as first argument (i.e. `cargo run <path-to-config>` or `./auditor <path-to-config>`)

If you run Auditor using Docker, then you first need to mount the configuration file inside the container, before you can use it.
Furthermore, you need to call the Docker container with the `auditor` command as first argument and the path to the config file (location inside the container) as second argument.

```bash
docker run -v <absolute-path-to-config>:/auditor/config.yaml aluschumacher/auditor:<version> auditor /auditor/config.yaml
```

However, you should default to using environment variables for configuration when running Auditor using Docker.

## Metrics exporter for Prometheus

Metrics for Prometheus are exposed via the `/metrics` endpoint.
Expand Down

0 comments on commit 94471c4

Please sign in to comment.