Skip to content

Add more configuration examples #167

@TwiN

Description

@TwiN

While I am satisfied with the verbosity of the documentation in the README.md file, I'd like to add more examples to the examples folder.

Unlike the current examples, would be configuration only (i.e. a folder with nothing except a config.yaml inside of it).

Furthermore, renaming examples to .examples as well as updating every current references to said folder in the README.md.

Here's a list of some examples I'd like to see:

So to recap:

  • Rename examples/ folder to .examples/
  • Update all old references to the examples/ folder to use .examples/
  • Rename .examples/minimal to .examples/docker-minimal
  • Create an example configuration in .examples/dns/config.yaml containing an endpoint monitored through DNS queries
  • Create an example configuration in .examples/tcp/config.yaml containing an endpoint monitored through TCP
  • Create an example configuration in .examples/alerting/config.yaml containing an endpoint with one of the providers configured (note: the webhook/tokens must be at least partially hidden)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions