mirror of
https://github.com/SeriousBug/gandi-live-dns-rust
synced 2024-10-31 14:17:25 -05:00
105 lines
6 KiB
Markdown
105 lines
6 KiB
Markdown
## gandi-live-dns-rust
|
|
|
|
[](https://github.com/SeriousBug/gandi-live-dns-rust/actions/workflows/test.yml) [](https://github.com/SeriousBug/gandi-live-dns-rust/actions/workflows/lint.yml) [](https://github.com/SeriousBug/gandi-live-dns-rust/releases) [](https://hub.docker.com/r/seriousbug/gandi-live-dns-rust) [](https://github.com/SeriousBug/gandi-live-dns-rust/blob/master/LICENSE.txt)
|
|
|
|
A program that can set the IP addresses for configured DNS entries in
|
|
[Gandi](https://gandi.net)'s domain configuration. Thanks to Gandi's
|
|
[LiveDNS API](https://api.gandi.net/docs/livedns/),
|
|
this creates a dynamic DNS system.
|
|
|
|
If you want to host web services but you don't have a static IP address, this
|
|
tool will allow you to keep your domains pointed at the right IP address. This
|
|
program can update both IPv4 and IPv6 addresses for one or more domains and
|
|
subdomains. It's a one-shot tool that's meant to be managed with a systemd timer
|
|
or cron.
|
|
|
|
## Usage
|
|
|
|
The Gandi Live DNS API is rate limited at 30 requests per minute. This program
|
|
respects this rate limit: if you have more than 30 domains to update, the
|
|
program will pause and wait for a minute, plus a random delay to ensure it
|
|
doesn't hit the rate limit.
|
|
|
|
### System packages
|
|
|
|
Packages are available for some linux distributions.
|
|
|
|
- ArchLinux: [gandi-live-dns-rust on AUR](https://aur.archlinux.org/packages/gandi-live-dns-rust/)
|
|
|
|
> Contributions to release this for other distributions are welcome!
|
|
|
|
### Prebuilt binaries
|
|
|
|
`gandi-live-dns` provides pre-built binaries with the releases. See the
|
|
[releases page](https://github.com/SeriousBug/gandi-live-dns-rust/releases) to
|
|
get the latest version. These binaries are statically linked, and provided for
|
|
both Linux and Windows, including ARM architectures for the Linux version.
|
|
|
|
Download the latest version from the releases page, extract it from the archive, and place it somewhere in your `$PATH` to use it.
|
|
|
|
- Create a file `gandi.toml`, then copy and paste the contents of [`example.toml`](https://raw.githubusercontent.com/SeriousBug/gandi-live-dns-rust/master/example.toml)
|
|
- Follow the instructions in the example config to get your API key and put it in the config
|
|
- Follow the examples in the config to set up the entries you want to update
|
|
- Run `gandi-live-dns` inside the directory with the configration to update your DNS entries
|
|
|
|
### With docker
|
|
|
|
Use the [seriousbug/gandi-live-dns-rust](https://hub.docker.com/r/seriousbug/gandi-live-dns-rust) Docker images, which are available for x86_64,
|
|
arm64, armv6, and armv7 platforms. Follow the steps below to use these images.
|
|
|
|
- Create a file `gandi.toml`, then copy and paste the contents of [`example.toml`](https://raw.githubusercontent.com/SeriousBug/gandi-live-dns-rust/master/example.toml)
|
|
- Follow the instructions in the example config to get your API key and put it in the config
|
|
- Follow the examples in the config to set up the entries you want to update
|
|
- Run `docker run --rm -it -v $(pwd)/gandi.toml:/gandi.toml:ro seriousbug/gandi-live-dns-rust:latest`
|
|
|
|
> Docker doesn't [support IPv6](https://docs.docker.com/config/daemon/ipv6/) out
|
|
> of the box. If you need to update IPv6 addresses, check the linked page to enable IPv6 or use the prebuilt binaries directly.
|
|
|
|
> If you get [errors](https://stackoverflow.com/questions/42248198/how-to-mount-a-single-file-in-a-volume) about not finding the config file, make sure your command
|
|
> has a full path to the config file (`$(pwd)/gandi.toml` part). Otherwise
|
|
> Docker will create a directory.
|
|
|
|
## Automation
|
|
|
|
The `Packaging` folder contains a Systemd service and timer, which you can use
|
|
to automatically run this tool. By default it will update the IP addresses after
|
|
every boot up, and at least once a day. You can adjust the timer to speed this
|
|
up, but avoid unnecessarily overloading Gandi's servers.
|
|
|
|
- Place `gandi-live-dns.timer` and `gandi-live-dns.service` into `/etc/systemd/system`
|
|
- Put `gandi-live-dns` binary into `/usr/bin/`
|
|
- You can also place it in `/usr/local/bin` or some other directory, just make sure to update the path in the service file
|
|
- Create the folder `/etc/gandi-live-dns`, and place your `gandi.toml` into it
|
|
- Create a user for the service: `useradd --system gandi-live-dns --home-dir /etc/gandi-live-dns`
|
|
- Make sure only the service can access the config file: `chown gandi-live-dns: /etc/gandi-live-dns/gandi.toml && chmod 600 /etc/gandi-live-dns/gandi.toml`
|
|
- Enable the timer with `systemctl enable --now gandi-live-dns.timer`
|
|
|
|
## Development
|
|
|
|
### Local builds
|
|
|
|
`cargo build` and `cargo build --release` are sufficient for development and release builds.
|
|
No special instructions are needed.
|
|
|
|
### Making a release
|
|
|
|
To make a release, first set up `cross` and `docker`. Make sure you log into
|
|
Docker with `docker login`. Then follow these steps:
|
|
|
|
- bump up the version in `Cargo.toml` according to [semver](https://semver.org/)
|
|
- commit and push the changes
|
|
- run `./make-release.sh`
|
|
> This will build binaries, then package them into archives, as well as
|
|
> build and upload docker images.
|
|
- Create a release on Github
|
|
- Make sure to create a tag for the release version on `master`
|
|
- Upload the binary archives to the Github release
|
|
- Update the AUR version manually
|
|
|
|
## Alternatives
|
|
|
|
- [laur89's Bash based updater](https://github.com/laur89/docker-gandi-dns-update)
|
|
- [ Adam Vigneaux's Bash based updater, with a docker image](https://github.com/AdamVig/gandi-dynamic-dns)
|
|
- [Yago Riveiro's Python based updater](https://github.com/yriveiro/giu)
|
|
- [ Maxime Le Conte des Floris' Go based updater](https://github.com/mlcdf/dyndns)
|