Gandi-ddns

This is a simple python program that updated A and AAAA records using GANDI API. I made this for use on my linux machine, but should run on anything can can run python3.

Requirements

Installation

Download the repository

git clone https://gitlab.com/benmi/gandi-ddns.git

create a .venv

cd gandi-ddns
python3 -m venv .venv

add requirements to venv

.venv/bin/python3 -m pip install -r requirements.txt

Config file

create a "config.ini" file and use this template

[section1]
# gandi.net API key
apikey = s3cr3t4p1k3y
# Domain
domain = example.com
# record name
rrset_name = @
# record type
rrset_type = A
# rrset_ttl value 300 ~ 2592000
rrset_ttl = 320

or you can run the program once and it will create one for you

.venv/bin/python3 gandi-ddns.py

usage

for easy to understand reference to cron first set up a crontab

sudo crontab -e

if you have none, you might be prompted a to create one

no crontab for root - using an empty one

Select an editor.  To change later, run 'select-editor'.
  1. /bin/nano        <---- easiest
  2. /usr/bin/vim.basic
  3. /usr/bin/vim.tiny
  4. /bin/ed

Choose 1-4 [1]:

if you dont know what this is, just press 1 then enter. this will open up a text editor with an example page

create a new line with this to have your pc run the script at boot

@reboot /path/to/gandi-ddns/.venv/bin/python3 /path/to/gandi-ddns/gandi-ddns.py &

create a new line with this to have it run the script every 15 minutes

*/15 * * * * /path/to/gandi-ddns/.venv/bin/python3 /path/to/gandi-ddns/gandi-ddns.py

if you used text editor 1, nano you can now press ctrl+x, then press y, then press enter to save and exit the file

Then to start the crontab run

sudo /etc/init.d/cron start
sudo /etc/init.d/cron reload

Problems

if you have any problems with the script feel free to open an issue. I will later add a FAQ for often seen problems.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

References

License

MIT License Copyright (c) 2023 Benjamin Jorgensen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

benmi3 / gandi-ddns