| ... | ... | @@ -5,6 +5,7 @@ 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:
|
|
|
|
|
|
|
|
```jsonc
|
|
|
|
{
|
|
|
|
"<option>": "<value>",
|
| ... | ... | @@ -41,7 +42,7 @@ The basic structure of the config file is: |
|
|
|
All of these options are optional and have default values that can be overwritten by setting the options.
|
|
|
|
|
|
|
|
| Option | Default value |
|
|
|
|
|----------------------|---------------------|
|
|
|
|
|--------|---------------|
|
|
|
|
| `"host"` | `0.0.0.0:3002` |
|
|
|
|
| `"db_path"` | `/db.sqlite` |
|
|
|
|
| `"check_interval"` | `120` |
|
| ... | ... | @@ -51,27 +52,11 @@ All of these options are optional and have default values that can be overwritte |
|
|
|
|
|
|
|
The `"no_frontend"` option is used to prevent the backend to serve any HTML. This can be useful if you want to build your own frontend on top of the API.
|
|
|
|
|
|
|
|
The `"allowed_api_keys"` option is used to specify keys to authenticate to the [Messages API](API Docs/Messages API) 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!
|
|
|
|
|
|
|
|
|
|
|
|
# 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)
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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"`).
|
|
|
|
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.
|
|
|
|
|
| ... | ... | @@ -79,8 +64,8 @@ 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](Protocol Modules/HTTP)
|
|
|
|
- [Teamspeak SSH authless](Protocol Modules/Teamspeak SSH authless)
|
|
|
|
- [Minecraft](Protocol Modules/Minecraft) |
|
|
\ No newline at end of file |
|
|
|
|
|
|
|
- [HTTP](Protocol%20Modules/HTTP)
|
|
|
|
- [Teamspeak SSH authless](Protocol%20Modules/Teamspeak%20SSH%20authless)
|
|
|
|
- [Minecraft](Protocol%20Modules/Minecraft) |
|
|
\ No newline at end of file |
