Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 2.06 KB

README.md

File metadata and controls

69 lines (49 loc) · 2.06 KB
Raw

Gandi Dynamic DNS

Dynamic DNS Update Client for Gandi's LiveDNS.

Install

Docker Hub

Pull the latest image from Docker Hub:

docker pull dustinhawkins/gandi-ddns

Manually

Clone this repository, and run make build to build an image:

git clone https://github.com/dustinhawkins/docker-gandi-ddns.git
cd gandi-ddns
make build

If you need to rebuild the image, run make clean build.

Run

Docker

Run this image with the make run shortcut, or manually with docker run. You'll need to define several environment variables for this container, and they are detailed below.

For a single entry:

docker run --name gandi-ddns \
           -e GANDI_KEY="12343123abcd" \
           -e GANDI_DOMAIN="mydomain.net" \
           --restart unless-stopped \
           dustinhawkins/gandi-ddns:latest

For multiple entries:

docker run --name gandi-ddns \
           -v ./config/config.json:/config.json
           --restart unless-stopped \
           dustinhawkins/gandi-ddns:latest

Configuration

Configuration is accomplished through the use of environment variables. The inclusive list is below.

Environment Variables

Variable Default Description
GANDI_URL https://api.gandi.net/v5/livedns/ URL of the Gandi API.
GANDI_KEY - API Key for your Gandi.net account
GANDI_DOMAIN - Your Gandi.net domain name
GANDI_RECORD @ Record to update with your IP address
UPDATE_SCHEDULE */5 * * * * Cron-style schedule for dynamic-dns updates.

License

The content of this project itself is licensed under the MIT License.