cybercinch/ddns-updater
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Readme update

Browse Source
This commit is contained in:
mkelcik
2023-05-04 22:34:49 +02:00
parent c7646cbf63
commit 10a5a12b86
1 changed files with 24 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -18,9 +18,24 @@ Before run, you need configure this environment variables.
- `ON_CHANGE_COMMENT` - (optional) in the event that the ip address of the dns record changes, this comment will be added to the record - `ON_CHANGE_COMMENT` - (optional) in the event that the ip address of the dns record changes, this comment will be added to the record
- `CHECK_INTERVAL_SECONDS` - (optional) how often will the ip address of the records be checked (default: `300`) - `CHECK_INTERVAL_SECONDS` - (optional) how often will the ip address of the records be checked (default: `300`)
- `PUBLIC_IP_RESOLVER` - (optional) public ip address resolver. (default: `ifconfig.me`) Available: `ifconfig.me`, `v4.ident.me`, `1.1.1.1` - `PUBLIC_IP_RESOLVER` - (optional) public ip address resolver. (default: `ifconfig.me`) Available: `ifconfig.me`, `v4.ident.me`, `1.1.1.1`
- `NOTIFIERS` - (optional) setting the notifier in case of an update of the dns record. Multiple entries are separated by commas. (default none). Example: `webhook@http://localhost/cloudflare-notification` - `NOTIFIERS` - (optional) setting the notifier in case of an update of the dns record. Multiple entries are separated by commas. (default none). Example: `webhook@http://localhost/cloudflare-notification`
- Available
- `webhook` - Call defined webhook. Example: `webhook@http://localhost/cloudflare-notification` ### Notifications
Currently, only webhook notification is available. Webhook sends a POST request to the specified endpoint in json format.
Request body example:
```json
{
"old_ip": "xxx.xxx.xxx.xxx",
"new_ip": "xxx.xxx.xxx.xxx",
"checked_at": "2023-05-04T17:39:42.942850354+02:00",
"resolver_tag": "ifconfig.me",
"domain": "my.domain.com"
}
```
Other notification methods will be implemented later (check future plans section).
### Building from source ### Building from source
@@ -52,6 +67,7 @@ services:
environment: environment:
- CLOUDFLARE_DNS_TO_CHECK=my.testdomain.com,your.testdomain.com - CLOUDFLARE_DNS_TO_CHECK=my.testdomain.com,your.testdomain.com
- CLOUDFLARE_API_KEY=your_cloudflare_api_key - CLOUDFLARE_API_KEY=your_cloudflare_api_key
- NOTIFIERS=webhook@http://localhost/cloudflare-updated-notification
- CLOUDFLARE_ZONE=testdomain.com - CLOUDFLARE_ZONE=testdomain.com
- ON_CHANGE_COMMENT="automatically updated" - ON_CHANGE_COMMENT="automatically updated"
- CHECK_INTERVAL_SECONDS=300 - CHECK_INTERVAL_SECONDS=300
@@ -62,6 +78,11 @@ services:
docker run -e CLOUDFLARE_DNS_TO_CHECK=my.testdomain.com,your.testdomain.com -e CLOUDFLARE_API_KEY=your_cloudflare_api_key -e CLOUDFLARE_ZONE=testdomain.com -e ON_CHANGE_COMMENT="automatically updated" -e CHECK_INTERVAL_SECONDS=300 mkelcik/cloudflare-ddns-update:latest docker run -e CLOUDFLARE_DNS_TO_CHECK=my.testdomain.com,your.testdomain.com -e CLOUDFLARE_API_KEY=your_cloudflare_api_key -e CLOUDFLARE_ZONE=testdomain.com -e ON_CHANGE_COMMENT="automatically updated" -e CHECK_INTERVAL_SECONDS=300 mkelcik/cloudflare-ddns-update:latest
``` ```
### Future plans
- prometheus metrics
- mqtt and rabbitmq notifiers
### Contributing ### Contributing
Feel free to contribute and pls report bugs. Thanks Feel free to contribute and pls report bugs. Thanks