Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
clayoster committed Oct 13, 2024
1 parent 7c88f19 commit ee8f0f4
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@

This is a self-hosted DDNS service for receiving public IP updates from a router or other local source and updating a DNS record in Cloudflare.

Container builds are available for these platforms: linux/amd64, linux/arm64, linux/arm/v6, linux/arm/v7

---

The primary purposes for building yet another DDNS tool for updating Cloudflare records:
- Many other solutions depend upon using a `Global` API token which is unacceptable for this singular purpose. This solution allows the use of a API token scoped with privileges to edit a single DNS zone.
- Unforunately Cloudflare does not allow limiting the edit privileges to a single DNS record in a zone at this point.
- Self-hosted option for receving DDNS updates from a router or other local source rather than depending on querying an external API for public IP address changes

---

Valid response codes were gathered from here:\
https://help.dyn.com/remote-access-api \
https://github.com/troglobit/inadyn/blob/master/plugins/common.c
Expand All @@ -25,7 +31,7 @@ Example information that will be used below:
- Hostname: `home.example.com`
- Username: `ddns-user`
- Password: `ddns-password`
- Server: `ddns.example.com/update?hostname=%h&myip=%i`
- Server: `ddns.example.com/nic/update?hostname=%h&myip=%i`

### Manual updates can be sent to this service with a GET request in the following format:

Expand All @@ -40,7 +46,6 @@ curl http://ddns-user:[email protected]:8080/nic/update?hostname=ho
#### Example docker-compose.yml file

```
version: '3.4'
services:
ddns-cloudflare:
container_name: ddns-cloudflare
Expand Down

0 comments on commit ee8f0f4

Please sign in to comment.