Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marvinruder/hetzner-dyndns
A proxy server for updating DNS records on Hetzner DNS using the DynDNS protocol
https://github.com/marvinruder/hetzner-dyndns
Last synced: 27 days ago
JSON representation
A proxy server for updating DNS records on Hetzner DNS using the DynDNS protocol
- Host: GitHub
- URL: https://github.com/marvinruder/hetzner-dyndns
- Owner: marvinruder
- License: mit
- Created: 2023-09-09T19:43:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T19:47:44.000Z (6 months ago)
- Last Synced: 2024-05-22T20:50:55.020Z (6 months ago)
- Language: Go
- Size: 76.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-hcloud - hetzner-dyndns
README
| **Release** | [](/LICENSE) [](https://github.com/marvinruder/hetzner-dyndns/releases/latest) [](https://hub.docker.com/r/marvinruder/hetzner-dyndns/tags) [](https://hub.docker.com/r/marvinruder/hetzner-dyndns/tags) [](https://github.com/marvinruder/hetzner-dyndns/releases/latest) [](https://github.com/marvinruder/hetzner-dyndns/commits) |
:-:|:-:
| **Quality** | [](https://github.com/marvinruder/rating-tracker/actions) [](https://goreportcard.com/report/github.com/marvinruder/hetzner-dyndns) [](https://app.codacy.com/gh/marvinruder/hetzner-dyndns/dashboard) [](https://app.codacy.com/gh/marvinruder/hetzner-dyndns/coverage/dashboard) [](https://jenkins.internal.mruder.dev/job/hetzner-dyndns-multibranch) |
| **Repository** | [](https://github.com/marvinruder/hetzner-dyndns/graphs/contributors) [](https://github.com/marvinruder/hetzner-dyndns/graphs/commit-activity) [](https://github.com/marvinruder/hetzner-dyndns/commits/main) [](https://github.com/marvinruder/hetzner-dyndns/issues) [](https://github.com/marvinruder/hetzner-dyndns/issues?q=is%3Aopen+is%3Aissue+label%3Abug) [](https://github.com/marvinruder/hetzner-dyndns/pulls) |
| **Reference** | [](https://pkg.go.dev/github.com/marvinruder/hetzner-dyndns) |
---
# hetzner-dyndns
A proxy server for updating DNS records on Hetzner DNS using the DynDNS protocol.
## Usage
### Prerequisites
* A DNS zone managed by Hetzner DNS
* An API token for the Hetzner DNS API (obtainable from the [Hetzner DNS Console](https://dns.hetzner.com/settings/api-token))
* A DynDNS client (e.g. a router) that supports the DynDNS protocol
* A server with a static IP address that is reachable from the internet to run the proxy server on
### Set up the server
Start the server by running the provided binary from the [latest release](https://github.com/marvinruder/hetzner-dyndns/releases/latest) or using the Docker image `marvinruder/hetzner-dyndns`:
```bash
docker run -p 8245:8245 -e ZONE=example.com -e TOKEN=eWVzLCBpIGFtIGEgdG9rZW4= marvinruder/hetzner-dyndns:latest
```
A Docker Compose setup could look like this:
```
services:
hetzner-dyndns:
image: marvinruder/hetzner-dyndns:latest
ports:
- 8245:8245
environment:
ZONE: example.com
TOKEN: eWVzLCBpIGFtIGEgdG9rZW4=
```
The server uses plain HTTP on port 8245. It is recommended to use a reverse proxy like nginx to add HTTPS support. A different port can also be configured using the reverse proxy or Docker.
The following environment variables are supported, none of which are required:
| Variable | Description |
| --- | --- |
| `COLOR` | Whether the log output should be colored. Set to `true` to enforce colored output, or `false` to enforce plain output. If not provided, the output will be colored if the output is a terminal. |
| `ZONE` | The DNS zone to use. The zone must still be provided as the username in every client request, but only those with the configured zone will be forwarded to Hetzner DNS API. If not provided, requests with any zone will be accepted. |
| `TOKEN` | The token to use for authentication against the Hetzner DNS API. The token must still be provided as the password in every client request, but only those with the configured token will be forwarded to Hetzner DNS API. If not provided, requests with any token will be accepted. |
### Configure a client
To update a DNS record, configure your DynDNS client (e.g. a router) to use
* the DNS zone (e.g. `example.com`) as the username,
* the token (e.g. `eWVzLCBpIGFtIGEgdG9rZW4=`) as the password,
* the desired dynamic hostname (e.g. `home.example.com`) as the hostname,
* the hostname or public IP address of the server (e.g. `dyndns.example.com`) as the update server address,
* the port of the server (default: `8245`) as the update server port, and
* `HTTP` as the update protocol (or `HTTPS` if you use a reverse proxy with HTTPS support, which is recommended).
Your client will take care of identifying changes in its public IP address and sending the appropriate requests to the server, keeping the DNS record up to date.
## Documentation
A detailed description of the DynDNS protocol is published by Oracle [here](https://help.dyn.com/remote-access-api/).
### Limitations of this implementation
* Only the HTTP `GET` method is implemented.
* Query parameters other than `hostname` and `myip` are not implemented.
* Only one hostname can be updated per request.
* It is not checked whether a request contains a valid User-Agent header.
## Contribute
Contributions are welcome!
## License
This software is provided under the conditions of the [MIT License](/LICENSE).
## Authors
- [Marvin A. Ruder (he/him)](https://github.com/marvinruder)