SimplyDDNS is a universal DDNS tool that can be used to update domain name records based on obtained IP addresses. It is designed to be flexible and easy to extend. We also privide the Chinese version of this README file, see README_ZH.md.
This tool simply monitors and updates domain name records based on obtained IP addresses. While there are similar existing projects that are already very useful, there were several points that didn't meet my personal expectations and requirements:
- I don't need a UI interface; instead, I prefer a fully functional configuration file
- Need more flexibility and freedom in configuration combinations
- As a server-side application, more detailed logging and ability to transmit required information
Since this is actually a strong requirement (everyone knows that when setting up a website, the last step is changing DNS, which is very troublesome and error-prone), this application was created. While it may have a relatively higher configuration threshold, it offers more flexibility.
Dynamic DNS registration (DDNS) behavior is abstracted into two types: how to obtain IP addresses and how to configure DNS.
Therefore, by implementing these two interfaces and matching them with configurations, you can flexibly arrange and run them. See the Extensions section for details.
For security considerations, binary executables are not provided at this time. If you need to compile the binary yourself, you can refer to the configuration in the Makefile.
Usually, make build is a very good choice. After running it (of course, requiring the Golang development environment), you can generate the corresponding executable file in the current directory.
It's recommended to run this application using containers. The program provides compose.yml and Dockerfile files for easy image building and running.
Detailed configuration file examples are in the example directory. Here's a very simple example (from basic.yml):
logfile: "/dev/stderr"
debug: True
ddns:
- source:
type: "lo"
interval: 60 # 1 minute
target:
type: "sleep"This configuration file means getting the IP address from the lo module and passing it to the sleep target for execution. The sleep target does nothing except sleep for a few seconds, but this demonstrates SimplyDDNS's working mechanism.
Extending SimplyDDNS is very easy. You can refer to the corresponding files in the source and target directories. The simplest ones are lo.go and sleep.go in the target directory, as they don't do anything practical.
lo
This module only returns the Lookup address, used for testing
static
Specifies the corresponding static address, usually used for fixed IP addresses
myip
Gets the IP address by accessing ipip.net, one of the recommended methods for obtaining IP addresses, used when the host has a public network address and can be accessed directly (such as DMZ hosts)
biturl
Another IP address acquisition service through accessing web addresses. The original ipsb service has been deprecated
sleep
Does nothing but sleep for a few seconds, can be used for testing
alidns
Uses Aliyun DNS service interface, requires backend API Key and Token application. Detailed usage is in target/alidns_test.go, and configuration example is in example/alidns.yml
namedotcom
Uses Name.com as the domain service backend. Because Name.com has whitelist verification, you can consider using a proxy if not accessing locally (see target/namedotcom_test.go)
cloudflare
Uses Cloudflare's API and SDK to provide dynamic updates for DNS deployed to Cloudflare. See related resources at https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-list-dns-records and https://github.com/cloudflare/cloudflare-go
If I only have one way to request IP addresses but multiple domains, repeating configurations makes it look bloated. Is there a better solution?
This is a common scenario. You can consider using Yaml's reference feature to reduce repeated configurations, for example:
defaults: &defaults
type: lo
interval: 60First define returning a local address from lo every minute, then configure the corresponding domain updates:
ddns:
- source:
<<: *defaults
target:
type: "sleep"
domains:
- a.com
- b.com
- source:
<<: *defaults
target:
type: "another"
domains:
- c.com
- d.comAfter configuring this way, you only need to focus on the target (domain) configuration.
WebHook can notify users of any configuration changes. You can use the following configuration:
webhook:
url: https://<your-webhook-address>After configuring like this, when the address changes, the results and changed domain results will be POSTed to the corresponding address. The result format is as follows:
{
"address": "127.0.0.1",
"domains": "a.com,b.com",
"now": "2022-07-13T15:00:10.931809+08:00"
}If there are multiple domain results, they will be separated by commas.
- eof -