zdravko/README.md

51 lines
1.5 KiB
Markdown
Raw Normal View History

2024-02-10 08:11:28 +00:00
# `zdravko`
Golang selfhosted Status/Healthcheck monitoring app.
Mostly just a project to test [temporal.io](https://temporal.io/).
2024-02-15 11:24:10 +00:00
### Roadmap
- [x] SSO Support for authentication.
2024-02-15 11:24:35 +00:00
- [x] SQLite for database.
2024-02-15 11:24:10 +00:00
- This means for main app db as well as temporal db.
2024-02-18 21:41:40 +00:00
- [x] Single binary.
2024-02-15 11:24:10 +00:00
- One binary to run worker, server and temporal all together.
- [x] Abbility for multiple workers.
2024-02-15 11:24:10 +00:00
- Spread workers across regions to monitor latency from different locations.
2024-02-21 22:19:19 +00:00
- [x] Use [k6](https://github.com/grafana/k6) for checks, so that they can be written in javascript.
2024-03-01 10:11:02 +00:00
- [x] History and working home page.
- Kinda working atm. ~But look if all the data could be stored/fetched from temporal.~
- [x] Edit/Delete operations for healthchecks and workers.
2024-02-15 11:24:10 +00:00
- [ ] CronJob Healthchecks (via webhooks).
2024-02-22 16:29:17 +00:00
- [ ] Notifications (webhooks, slack, etc).
2024-03-01 10:11:02 +00:00
- [ ] Incidents (based on script that is triggered by monitors/crobjobs).
- [ ] Prepare i18n.
- [ ] Alpha Version (1H 2024)
- [ ] ??
- [ ] Beta Version (2H 2024)
- [ ] ??
- [ ] Stable Release (2025)
2024-02-10 17:05:11 +00:00
![Screenshot](docs/screenshot.png)
2024-02-19 19:09:27 +00:00
Demo is available at https://zdravko.mnts.dev.
2024-02-10 17:05:11 +00:00
# Development
### Dependencies
* [devbox](https://www.jetpack.io/devbox)
2024-02-18 09:49:28 +00:00
* [justfile](https://github.com/casey/just) (optional, `devbox run -- just` can be used instead)
```sh
# Configure
cp example.env .env
# Generate JWT key
just generate-jwt-key
# Start development environment
just run
```
2024-02-11 21:21:40 +00:00
### License
Under AGPL, see [LICENSE](LICENSE) file.