updog/README.md

57 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2024-01-29 17:26:50 -06:00
# Updog
## What's updog?
Not much, you?
<small>(it's a simple, extensible uptime monitor)</small>
## Warning
**Extensions will be executed with no safety checks!** Make sure an extension isn't malicious before adding it.
## Docs
Docs are in the `./docs/` folder, but here's a quick overview on how to use this:
2024-01-29 17:26:50 -06:00
2024-01-30 13:35:56 -06:00
1. Clone this repository - `git clone --depth 1 https://git.askiiart.net/askiiart/updog`
2024-01-29 17:26:50 -06:00
2. Install your extensions in the appropriate folders: `./extensions/checkers`, `./extensions/alerts` (optional), and `./extensions/logging`
3. Create your `services.json` file, example below.
```json
{
2024-02-06 12:37:19 -06:00
"global-args": {
"default-checker": "CheckerTemplate",
"default-alerts": "AlertsTemplate",
"default-logging": "LoggingTemplate"
},
2024-01-29 17:26:50 -06:00
"site": {
"name": "A Website",
2024-02-06 12:37:19 -06:00
"checker": "HttpChecker",
2024-01-29 17:26:50 -06:00
"checker-args": {
2024-02-06 12:37:19 -06:00
"url": "https://example.com"
2024-01-29 17:26:50 -06:00
},
2024-02-06 12:37:19 -06:00
"rate": 1,
2024-01-29 17:26:50 -06:00
"alerts-args": {
"url": "https://example.com/webhook-url-or-whatever-goes-here",
"lol": "irrelevant, AlertsTemplate ignores these options lol"
},
"logging-args": {
"file": "/home/askiiart/Documents/updog/logs/site-log"
2024-01-29 17:26:50 -06:00
}
}
}
```
## To-do
- Add maintenance windows (optionally recurring)
2024-02-06 12:37:19 -06:00
- Add groups
2024-01-30 13:35:56 -06:00
- Add ability for checkers to have preferred alerts and logging extensions - will print a warning if the preferred extension(s) are not used
2024-02-20 12:04:52 -06:00
- Add "keywords" to be replaced in the config (for ~~current directory~~, service name, maybe some others)
- Current directory done - `%dir%`
2024-01-29 17:26:50 -06:00
---
***All specs are still a work-in-progress, breaking changes are likely!***