| ... | ... | @@ -54,18 +54,9 @@ The `"no_frontend"` option is used to prevent the backend to serve any HTML. Thi |
|
|
|
|
|
|
|
The `"allowed_api_keys"` option is used to specify keys to authenticate to the [Messages API](API%20Docs/Messages%20API) using the `X-API-Key` header. If it is left empty, a random one will be generated during startup and will be shown in the console. Keep in mind, that is changes on every startup!
|
|
|
|
|
|
|
|
# Services
|
|
|
|
# Other configuration
|
|
|
|
|
|
|
|
The keys under the `"services"` object are the service names. They can be chosen freely and are displayed in the API response. Under every service, there must be another JSON object containing the `"friendy_url"` and `"protocol"` keys. The friendly URL is always displayed in the API response. The protocol must be set to one of the registered checkers (e.g. `"http"`).
|
|
|
|
To configure the protocol checkers, see [Protocol Modules](Protocol Modules).
|
|
|
|
|
|
|
|
Some protocols allow setting protocol specific options via the `"protocol_config"` key. This key is also optional and will be populated with the protocols defaults if not provided.
|
|
|
|
To configure the notifieres, see [Notifiers](Notifiers).
|
|
|
|
|
|
|
|
Keep in mind that it is not checked whether the contents of `"protocol_config"` are well-formed and have the correct types. Please read the protocol specific options carefully to prevent unexpected behavior!
|
|
|
|
|
|
|
|
The protocol specific options can be looked up below.
|
|
|
|
|
|
|
|
### Protocol module list
|
|
|
|
|
|
|
|
- [HTTP](Protocol%20Modules/HTTP)
|
|
|
|
- [Teamspeak SSH authless](Protocol%20Modules/Teamspeak%20SSH%20authless)
|
|
|
|
- [Minecraft](Protocol%20Modules/Minecraft) |
|
|
\ No newline at end of file |
