diff --git a/README.md b/README.md index f3889ed..61867a6 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@ It is also possible to define a path to a file with the API key written in it. T ## Usage First, get your Personal Access Token (PAT) from https://account.gandi.net/en/users/USER/security where `USER` is your Gandi username. +The token need the following permissions: + +* **Manage domain name technical configurations** The script looks for a config file at `$HOME/.config/dyn-gandi/config.log` or `/etc/dyn-gandi.conf` in that order. So create a file at one of these locations according to the schema below. @@ -49,7 +52,6 @@ Add this to the modules. ```nix inputs = { - nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05"; dyn-gandi.url = "git+https://git.krsnik.at/Kristian/dyn-gandi"; }; @@ -88,17 +90,19 @@ Use `dyn-gandi.nixosModules.default` for a NixOs module and `dyn-gandi.homeManag `dyn-gandi.timer` specifies a timer in seconds when the script should be repeated. - ## Features + * Support for arbitrarily many domains and subdomains through a nested data structure. * Small codebase * Logging * NixOS and home-manager modules ## Limitations + * Only IPv4 addresses are supported ## TODO + * Testing * Command line options controlling: dry-run, config, log, verbosity, force * Support IPv6