Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kiarn committed May 7, 2023
1 parent 0a85bc9 commit 4409c78
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions plugins/dns_api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Ajenti plugin template
# Ajenti plugin DNS API

This is the plugin template used by ajenti-dev-multitool
This plugin is attented to give an access to an external registrar API, like Gandi or GoDaddy, and manage the DNS entries.
Currently, there's only one [provider for the Gandi API](https://github.com/ajenti/ajenti/blob/master/plugins/dns_api/providers/gandi.py), but feel free to write your own provider for your registrar API.
The code should be enough commented to understand how it works.

## Configuration for the Gandi API

Just add the following entries in `/etc/ajenti/config.yml`:

```
dns_api:
provider: gandi
apikey: YOUR_API_KEY
```

and then restart `Ajenti`.

0 comments on commit 4409c78

Please sign in to comment.