docs: link to configuration document for overview
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: Ie9f7132d784bf0b40e562f3190782fb36a6a6964
This commit is contained in:
parent
430219ee4c
commit
951ed9c36f
1 changed files with 8 additions and 2 deletions
10
README.md
10
README.md
|
|
@ -80,6 +80,14 @@ $ ./watchdog -config config.yaml
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
[configuration reference]: docs/configuration.md
|
||||||
|
|
||||||
|
Watchdog currently supports configuration via YAML file, environment variables
|
||||||
|
or command-line flags. You may find a more complete reference in the
|
||||||
|
[configuration reference] document.
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
Create `config.yaml`:
|
Create `config.yaml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
@ -112,8 +120,6 @@ server:
|
||||||
listen_addr: "127.0.0.1:8080"
|
listen_addr: "127.0.0.1:8080"
|
||||||
```
|
```
|
||||||
|
|
||||||
See [config.example.yaml](config.example.yaml) for all options.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### JavaScript Beacon
|
### JavaScript Beacon
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue