Skip to content

Commit

Permalink
docs: Add documentation for internal server
Browse files Browse the repository at this point in the history
  • Loading branch information
oxyno-zeta committed Dec 2, 2019
1 parent efd44ed commit 7f5f4fd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
5 changes: 5 additions & 0 deletions conf/config-example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ log:
# listenAddr: ""
# port: 8080

# Internal Server configurations
# internalServer:
# listenAddr: ""
# port: 9090

# Cachet configuration
cachet:
url: http://localhost
Expand Down
13 changes: 7 additions & 6 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ You can see a full example in the [Example section](#example)

## Main structure

| Key | Type | Required | Default | Description |
| ------- | --------------------------------------------- | -------- | ------- | ----------------------- |
| log | [LogConfiguration](#logconfiguration) | No | None | Log configurations |
| server | [ServerConfiguration](#serverconfiguration) | No | None | Server configurations |
| cachet | [CachetConfiguration](#cachetconfiguration) | Yes | None | CachetHQ configurations |
| targets | [[TargetConfiguration]](#targetconfiguration) | Yes | None | Targets configurations |
| Key | Type | Required | Default | Description |
| -------------- | --------------------------------------------- | -------- | ------- | ------------------------------ |
| log | [LogConfiguration](#logconfiguration) | No | None | Log configurations |
| server | [ServerConfiguration](#serverconfiguration) | No | None | Server configurations |
| internalServer | [ServerConfiguration](#serverconfiguration) | No | None | Internal Server configurations |
| cachet | [CachetConfiguration](#cachetconfiguration) | Yes | None | CachetHQ configurations |
| targets | [[TargetConfiguration]](#targetconfiguration) | Yes | None | Targets configurations |

## LogConfiguration

Expand Down

0 comments on commit 7f5f4fd

Please sign in to comment.