Update the README

This commit is contained in:
Alexis Métaireau 2023-10-18 02:26:22 +02:00
parent 75a8af37f0
commit 85e73e0869

View file

@ -1,17 +1,15 @@
# Argos
🚧 This is mainly a work in progress for now. It's not working, don't try to install it ! 🚧
Argos is an HTTP monitoring service. It's meant to be simple to configure and simple to use.
Argos is an HTTP monitoring service. It allows you to define a list of websites to monitor, and a list of checks to run on these websites. It will then run these checks periodically, and alert you if something goes wrong.
Todo:
- [ ] Use Postgresql as a database
- [x] Use Postgresql as a database
- [x] Expose a simple read-only website.
- [ ] Use background tasks for alerting
- [ ] Add a command to generate new authentication tokens
- [ ] Task for database cleanup (to run periodically)
- [ ] Handles multiple alerting backends (email, sms, gotify)
- [ ] Expose a simple read-only website.
- [ ] Add a way to specify the severity of the alerts in the config
- [ ] Do not send "expected" and "got" values in case check-status and body-contains suceeded