Skip to content

Commit

Permalink
Updated README and config PAT notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Danamir committed Apr 22, 2024
1 parent ffd1237 commit a3b4e88
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ Use Gandi LiveDNS API to update DNS records with a dynamic IP.

#### Prequisites

- Go to your Gandi account security page: https://account.gandi.net/en/users/USER/security (where USER is your username)
- Generate your API key, to be copied into your configuration file
- Generate a Gandi Personal Access Token (PAT) via either https://account.gandi.net/en/users/USER/security (where USER is your username), or Gandi Dashboard > Organizations > Manage > Create a token :
- Choose a mandatory duration (Gandi allows one year max)
- Give access at least to the resource `DNS configuration`
- Python 3.x

##### Note

I recommend creating a repeating alarm in a calendar to be sure to renew the PAT before it is revoked.

#### Installation

Expand Down Expand Up @@ -52,7 +56,7 @@ records = @,www
```

#### Running
_Note: `dyn_gandi` can be substituted with `python dyn_gandi.py` if the former does'nt work._
_Note: `dyn_gandi` can be substituted with `python dyn_gandi.py` if the former doesn't work._

Display help :
```shell
Expand Down
4 changes: 3 additions & 1 deletion config.ini-dist
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[api]
url = https://api.gandi.net/v5/livedns/
; Generate your Gandi Personal Access Token via Gandi Dashboard > Organizations > Manage > Create a token
; Generate a Gandi Personal Access Token (PAT) via either :
; - URL : https://account.gandi.net/en/users/<user>/security
; - Gandi Dashboard : Organizations > Manage > Create a token
key =

[dns]
Expand Down

0 comments on commit a3b4e88

Please sign in to comment.