Update README.md

This commit is contained in:
Lab 8916100448256 2020-02-29 19:24:10 +00:00
parent 307d442f3b
commit 300e1d735f

View file

@ -1,9 +1,14 @@
# Gandi Dynamic DNS # Gandi Dynamic DNS
Cron job to auto update a DNS record when WAN IP changes using Gandi Live DNS API on Debian GNU/Linux Cron job to auto update DNS records when WAN IP changes using Gandi Live DNS API on Debian GNU/Linux
## To install ## Requirements
+ Debian GNU/Linux 10 (Buster)
+ curl : `apt-get install curl`
+ dig : `apt-get install dnsutils`
## Install
Fetch script from git repo, install and configure
``` ```
git clone https://gitlab.com/lab.8916100448256/gandi-dynamic-dns.git ./gandi-dynamic-dns git clone https://gitlab.com/lab.8916100448256/gandi-dynamic-dns.git ./gandi-dynamic-dns
cd ./gandi-dynamic-dns cd ./gandi-dynamic-dns
@ -12,8 +17,13 @@ sudo bash ./install.sh
Then configure DNS record info and API key in file /etc/live-dns/live-dns.conf Then configure DNS record info and API key in file /etc/live-dns/live-dns.conf
```
nano /etc/live-dns/live-dns.con
```
## How it works ## How it works
### /etc/cron.d/live-dns-update ### /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.
@ -30,7 +40,7 @@ Check this page if you don't know your APIKey : https://docs.gandi.net/en/domain
This is the script that is called by the cron job. This is the script that is called by the cron job.
+ First the WAN (external) IPV4 and IPV6 adresses are determined using http://me.gandi.net + First the WAN (external) IPV4 and IPV6 adresses are determined using http://me.gandi.net
+ Then they are compared to DNS records for the configured host and domain. + 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 + 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. Exemple :