diff --git a/README.md b/README.md index 22d9df1..a6492ba 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ I could simply run `certbot renew` with additional hooks but I have to update th - The Rust compiler installed on your system to build the software - A working NTFY server, see [NTFY Homepage](https://ntfy.sh) - You will need the ntfy app on your Android based mobile device. I do not know - if something like ntfy is available on iOS. + if something like ntfy is available on iOS. - Of course you need to subscribe to the topic you choose, see below. - A Linux based server including systemd but since Rust is available on BSD it should be able get it up and running there too. Windows is not supported, there is Powershell ;) @@ -44,14 +44,14 @@ Once LetsEncrypt switches to 45 days lifetime in February 2028 as described [her To test your settings just execute `systemctl start cert_check.service` Check your syslog with `journalctl -xf` while doing so. If none of your certs are due for renewal the program will log something like -``` +``` Certificate OK for CN=$HOSTNAME$. Expires after $TIMESTAMP$ which is in $x day(s) ``` -On the other hand, if one of your certificates expires in less then $THRESHOLD_DAYS it will log a `Certificate Warning` instead and it will also log the push notification like so: +On the other hand, if one of your certificates expires in less then $THRESHOLD_DAYS it will log a `Certificate Warning` instead and it will also log the push notification like so: -``` -Certificate Warning for CN=$HOSTNAME$. Expires after $TIMESTAMP$ which is in $x day(s) +``` +Certificate Warning for CN=$HOSTNAME$. Expires after $TIMESTAMP$ which is in $x day(s) Push notification sent to $NOTIFY_URL$ ``` @@ -61,3 +61,7 @@ And if all went well you should receive a nice push message on your Android devi - I have not tested certcheckntfy on certificates with SubjectAltNames. i.e. certs with multiple CN's. It should work but I do not know... - The ntfy service should not need a username/password, although this can easily be implemented + +## License + +- [WTFPL](https://en.wikipedia.org/wiki/WTFPL)