diff --git a/README.md b/README.md index cb4c7a5..7f98441 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,13 @@ nano /etc/live-dns/live-dns.conf ## How it works ### /etc/cron.d/live-dns-update -Cron job definition to check for WAN IP change and call Live DNS API to update the DNS record if necessary. By default runs the check/update script 2 times per hour, at every hour past 12 and 42 minutes. +Cron job definition to check for WAN IP change and call Live DNS API to update the DNS record if necessary. + +By default runs the check/update script 2 times per hour, at every hour past 12 and 42 minutes. ### /etc/live-dns/live-dns.conf -Configuration file for the check/update script +Configuration file for the check/update script. + Needs to contains 3 environment variable definitions + DOMAIN="domain.tld" : Replace domain.tld with your domain name + RECORD="host" : Replace host with the sub domain you want to update when WAN IP changes @@ -43,7 +46,10 @@ This is the script that is called by the cron job. + Then they are compared to the A and AAAA DNS records for the configured host and domain. + In case of mismatch Gandi live DNS API is called to update the DNS records -Information logs are written to system log. Exemple : +Information logs are written to system log. + +For Example : + ``` Feb 29 20:12:02 passerelle root: WAN IPv4 : 1.2.3.4 Feb 29 20:12:02 passerelle root: WAN IPv6 : 1111:2222:3333:4444:5555:6666:7777:8888