Kristian/dyn-gandi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated README

Browse Source
This commit is contained in:
Kristian Krsnik 2024-09-01 20:13:51 +02:00
parent fc0d163192
commit 310d4bef8b
Signed by: Kristian
GPG Key ID: FD1330AC9F909E85
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -19,6 +19,9 @@ It is also possible to define a path to a file with the API key written in it. T
## Usage ## Usage
First, get your Personal Access Token (PAT) from https://account.gandi.net/en/users/USER/security where `USER` is your Gandi username. 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. 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 ```nix
inputs = { inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05";
dyn-gandi.url = "git+https://git.krsnik.at/Kristian/dyn-gandi"; 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. `dyn-gandi.timer` specifies a timer in seconds when the script should be repeated.
## Features ## Features
* Support for arbitrarily many domains and subdomains through a nested data structure. * Support for arbitrarily many domains and subdomains through a nested data structure.
* Small codebase * Small codebase
* Logging * Logging
* NixOS and home-manager modules * NixOS and home-manager modules
## Limitations ## Limitations
* Only IPv4 addresses are supported * Only IPv4 addresses are supported
## TODO ## TODO
* Testing * Testing
* Command line options controlling: dry-run, config, log, verbosity, force * Command line options controlling: dry-run, config, log, verbosity, force
* Support IPv6 * Support IPv6