docs: add domains.json
example and explanation
This commit is contained in:
parent
450090ceb5
commit
7b8cd520ef
2 changed files with 27 additions and 0 deletions
19
README.md
19
README.md
|
@ -25,3 +25,22 @@ apikey:
|
|||
|
||||
...
|
||||
```
|
||||
|
||||
### Adding target domains
|
||||
|
||||
Add every domain you want to send an update for to the file `domains.json`.
|
||||
The file should list each domain whose global DNS record should point to the local host's public IP.
|
||||
The file must have the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"domains": [
|
||||
"example.com",
|
||||
"subdomain1.example.com",
|
||||
"subdomain2.example.com",
|
||||
],
|
||||
"description": "My dynamic DNS."
|
||||
}
|
||||
```
|
||||
|
||||
The description can have any string as a value, but it must be present.
|
||||
|
|
8
domains.json
Normal file
8
domains.json
Normal file
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"domains": [
|
||||
"example.com",
|
||||
"subdomain1.example.com",
|
||||
"subdomain2.example.com",
|
||||
],
|
||||
"description": "My dynamic DNS."
|
||||
}
|
Loading…
Add table
Reference in a new issue