Updating the readme to explain the basics

Signed-off-by: Alarig Le Lay <alarig@swordarmor.fr>
This commit is contained in:
Alarig Le Lay 2024-07-27 13:39:47 +02:00
parent dbce4db147
commit 5a3f7686f0
Signed by: alarig
GPG key ID: 7AFE62C6DF8BCDEC

View file

@ -1,5 +1,7 @@
Script intented to check a domain expiration with a query to the corresponding Script intented to check a domain expiration with a query to the corresponding
RDAP server. RDAP server. The RDAP server for the TLD is extracted from the IANA JSON RDAP.
If the expiration field isnt found on the TLD server, the script falls back to
the registrar server.
This script is inspired from This script is inspired from
https://raw.githubusercontent.com/buanzo/check_expiration_rdap/main/src/nagios_check_domain_expiration_rdap/nagios_check_domain_expiration_rdap.py https://raw.githubusercontent.com/buanzo/check_expiration_rdap/main/src/nagios_check_domain_expiration_rdap/nagios_check_domain_expiration_rdap.py
@ -8,10 +10,10 @@ and `/usr/lib/python3.11/site-packages/nagiosplugin/examples/`
The script assumes that the TLD has only one label while looking for the RDAP The script assumes that the TLD has only one label while looking for the RDAP
server from the IANA JSON. If its not the case it will fail. server from the IANA JSON. If its not the case it will fail.
I dont understand half of what I wrote
Have fun. Have fun.
For all the options, run `./check_domain_expiration_rdap.py -h`
Here are the tested cases: Here are the tested cases:
```shell ```shell
# expired domain # expired domain