| ... | ... | @@ -5,11 +5,19 @@ The Status-API server is configured via a single JSON file. It must be mounted a |
|
|
|
# Structure
|
|
|
|
|
|
|
|
The basic structure of the config file is:
|
|
|
|
```json
|
|
|
|
```jsonc
|
|
|
|
{
|
|
|
|
"<option>": "<value>",
|
|
|
|
"<option>": "<value>",
|
|
|
|
...
|
|
|
|
"notifiers": {
|
|
|
|
"<notifier-name>": {}, // non-configurable notifier
|
|
|
|
"<notifier-name>": { // configurable notifier
|
|
|
|
"<notifier-config>": "<value>",
|
|
|
|
...
|
|
|
|
},
|
|
|
|
...
|
|
|
|
},
|
|
|
|
"services": {
|
|
|
|
"<service name>": {
|
|
|
|
"friendly_url": "https://some-website.de",
|
| ... | ... | @@ -21,12 +29,9 @@ The basic structure of the config file is: |
|
|
|
},
|
|
|
|
"<service name>": {
|
|
|
|
"friendly_url": "https://some-other-website.de/something",
|
|
|
|
"protocol": {
|
|
|
|
"type": "<some type>",
|
|
|
|
"config": {...}
|
|
|
|
}
|
|
|
|
"protocol": "http"
|
|
|
|
}
|
|
|
|
....
|
|
|
|
...
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
| ... | ... | @@ -43,9 +48,23 @@ All of these options are optional and have default values that can be overwritte |
|
|
|
| `"no_frontend"` | `false` |
|
|
|
|
| `"frontend_path"` | `../frontend/build` |
|
|
|
|
|
|
|
|
# Notifiers
|
|
|
|
|
|
|
|
Notifiers are functions to notify a user if a service goes offline and when it goes online again. There are several methods to receive notifications (see below).
|
|
|
|
|
|
|
|
There are two types of notifiers: configurable and non-configurable.
|
|
|
|
|
|
|
|
The keys under the `"notifiers"` object are the notifiers names. They must be explicitly specified to be activated. Non-configurable notifiers do not require a configuration, so specifying `{}` as value is sufficient. To provide configuration to configurable notifiers, please consult the notifier-specific documentation (see below).
|
|
|
|
|
|
|
|
|
|
|
|
### Notifier list
|
|
|
|
- [Log](Notifiers/Log)
|
|
|
|
- [Gotify](Notifiers/Gotify)
|
|
|
|
|
|
|
|
|
|
|
|
# Services
|
|
|
|
|
|
|
|
The keys under the `"services"` object are the service names. They can be choosen freely and are displayed in the API response.
|
|
|
|
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"`).
|
|
|
|
|
|
|
|
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.
|
| ... | ... | @@ -55,7 +74,7 @@ Keep in mind that it is not checked whether the contents of `"protocol_config"` |
|
|
|
The protocol specific options can be looked up below.
|
|
|
|
|
|
|
|
|
|
|
|
# Protocol module list
|
|
|
|
- [HTTP Config](Protocol Modules/HTTP)
|
|
|
|
- [Teamspeak Config](Protocol Modules/Teamspeak)
|
|
|
|
- [Minecraft Config](Protocol Modules/Minecraft) |
|
|
\ No newline at end of file |
|
|
|
### Protocol module list
|
|
|
|
- [HTTP](Protocol Modules/HTTP)
|
|
|
|
- [Teamspeak SSH authless](Protocol Modules/Teamspeak SSH authless)
|
|
|
|
- [Minecraft](Protocol Modules/Minecraft) |
|
|
\ No newline at end of file |
