update usage instructions

This commit is contained in:
Kaan Genc 2022-01-23 22:35:29 -05:00
parent 31d7d2e9ce
commit 601ae869ef
2 changed files with 8 additions and 2 deletions

View file

@ -6,6 +6,12 @@ Thanks to Gandi's [LiveDNS API](https://api.gandi.net/docs/livedns/), this creat
Inspired by [cavebeat's similar tool](https://github.com/cavebeat/gandi-live-dns),
which seems to be unmaintained at the time I'm writing this. I decided to rewrite it in Rust as a learning project.
This tool can update both IPv4 and IPv6 addresses for one or more domains and subdomains.
It's a "one-shot" tool that's then orchestrated with a systemd timer or cron.
## Usage
- Copy `example.toml` to
- Copy `example.toml` to `gandi.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 which entries you want to update
- Use `cargo run` to build and run the program

View file

@ -16,7 +16,7 @@ api_key = "xxxxxxxxxxxxxxxxxxxxxxxx"
name = "@"
[[entry]]
# Updates both A (IPv4) and AAA (IPv6) entries for other.example.com
# Updates both A (IPv4) and AAAA (IPv6) entries for other.example.com
name = "other"
types = ["A", "AAAA"]