diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f26df737fa1937d94aa73400f67e69cb7da591f8 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# X days since last outage caused by TLS expiry + +How often does your infrastructure break because you forgot to automate TLS renewal, or because it broke? + +Find out by rolling out this tool with the domains and services! + +## Plans + +### Backend + +- Python script for backend +- check each domain's tls cert using [`ssl` library](https://docs.python.org/3/library/ssl.html) +- use file(s) to store: + - domains + - expiry status *per* domain + - log of outages +- cronjob at the start (every 1-5 minutes) + +### Frontend + +- Basic HTML + - simple CSS + - title at the top "Days since last outage caused by TLS expiry:" + - big centered number in the middle for time since last outage + - list of domains and their expiry status underneath + - log of outages underneath +- Javascript + - fetch generated JSON from "backend" (web server) + - every X seconds + - re-render the counter every second