william3johnson/dyndns

Update Gandi LiveDNS based on the current (dynamic) ip.

dyndns

Update Gandi LiveDNS based on the current (dynamic) ip.

Why

Some (most ?) providers (Orange for example) don't provide you a fix IP address: they give you a dynamic IP that changes over time. This makes it hard to self-host softwares and share them publicly via a domain because you have to constantly change the IP your domain is pointing to.

This program aims to solve that. It's intended to run on a always-on computer in your home (such as Raspberry Pi).

Highlights

• Supports both IPv4 and IPv6.
• Reports failures and successful updates on a Discord channel. /!\ This is not optional (by design).
• A faster IP finder is available if you have a Livebox v4 (may work on other models).

Install

• From GitHub releases: download the binary corresponding to your OS and architecture.
• From source (make sure $GOPATH/bin is in your $PATH):

go get go.mlcdf.fr/dyndns

Setup

dyndns requires the following environment variables to be set:

name	description
DISCORD_WEBHOOK_URL	your Discord channel webhook
GANDI_TOKEN	your Gandi API Key

Usage

Usage:
    dyndns --domain [DOMAIN] --record [RECORD]

Options:
    --livebox            Query the Livebox (router) to find the IP instead of api.ipify.org
    --ttl                Time to live in seconds. Defaults to 3600
    -V, --version        Print version

Examples:
    export DISCORD_WEBHOOK_URL='https://discord.com/api/webhooks/xxx'
    export GANDI_TOKEN='foobar'
    dyndns --domain example.com --record "*.pi"

Setup as a cron job

crontab -e
# Run every 10 minutes
*/10 * * * * /path/to/dyndns --domain example.com --record "*.pi"

Check out the example contrib/deploy.sh script.

Development

Run the app

go run main.go

Run the tests

go test ./...