Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.47 KB

README.md

File metadata and controls

66 lines (44 loc) · 2.47 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 wastrachan/gandi-ddns

Github Container Registry

Or, pull from the GitHub Container Registry:

docker pull ghcr.io/wastrachan/gandi-ddns

Build From Source

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

git clone https://github.com/wastrachan/docker-gandi-ddns.git
cd gandi-ddns
make 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.

docker run --name gandi-ddns \
           --rm \
           -e GANDI_KEY="12343123abcd" \
           -e GANDI_DOMAIN="mydomain.net" \
           wastrachan/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://dns.api.gandi.net/api/v5/ 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.