Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickrobison/go-cddns
Golang client for dynamically updating cloudflare DNS records
https://github.com/nickrobison/go-cddns
cloudflare debian dns docker golang-client ubuntu
Last synced: 2 months ago
JSON representation
Golang client for dynamically updating cloudflare DNS records
- Host: GitHub
- URL: https://github.com/nickrobison/go-cddns
- Owner: nickrobison
- License: mit
- Created: 2016-10-18T06:44:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-18T00:47:00.000Z (almost 6 years ago)
- Last Synced: 2024-10-09T06:00:03.743Z (2 months ago)
- Topics: cloudflare, debian, dns, docker, golang-client, ubuntu
- Language: Go
- Size: 25.4 KB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://travis-ci.org/nickrobison/go-cddns)
[  ](https://bintray.com/nickrobison/debian/go-cddns/_latestVersion)
# go-cddns
Golang client for dynamically updating cloudflare DNS records on a specified interval. Useful if you're using Cloudflare to point to a device with a dynamic IP Address
## Installation
### Go package
```bash
go get -u github.com/nickrobison/go-cddns
```
### Debian repository
We also now have a debian (and Ubuntu) repository with builds for both amd64 and arm architectures.
Since we require systemd, the builds only support debian jessie and newer, and ubuntu xenial (16.04) and later.
The repository is hosted on bintray, so there are some special setup instructions.
```bash
sudo apt-get install apt-transport-https # Bintray only supports https connections
echo "deb https://dl.bintray.com/nickrobison/debian {xenial|jessie|stretch} main" | sudo tee -a /etc/apt/sources.list
apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 379CE192D401AB61 # We need to import the Bintray public key
sudo apt-get update && apt-get install go-cddns
```
The package installation will create a config file in ```/etc/go-cddns/config.json```, which is where you should set your configuration options.
## Usage
Create a config.json with the following structure:
```json
{
"UpdateInterval": "{interval (in minutes) to check for an updated IP Address}",
"Key": "{Cloudflare API Key}",
"Email": "{Cloudflare Email Address}",
"DomainName": "{Cloudflare domain to modify}",
"RecordName": "{Array of DNS records to update}",
"Remove": "{Boolean of whether or not to remove the records on shutdown}"
}
```
Run the application, optionally specifying the path to the config file.
```bash
go-cddns -config=/path/to/file
```
## Docker Image
go-cddns is also provided as a Docker image.
The application automatically starts when the container boots, but it lacks a functioning config file.
You'll need to add the path to the desired config as a volume.
```bash
docker run -v /{path/to/config}/config.json:/etc/config.json nickrobison/go-cddns
```
The container can be controlled by systemd via a custom unit file, such as this:
```ini
[Unit]
Description=Go-cddns container
Requires=docker.service
After=docker.service
[Service]
TimeoutStartSec=0
Restart=always
ExecStartPre=-/usr/bin/docker kill nickrobison/go-cddns
ExecStartPre=-/usr/bin/docker rm nickrobison/go-cddns
ExecStartPre=/usr/bin/docker pull nickrobison/go-cddns
ExecStart=/usr/bin/docker run --rm -v /etc/go-cddns/config.json:/etc/config.json nickrobison/go-cddns
ExecStop=/usr/bin/docker stop nickrobison/go-cddns
[Install]
WantedBy=local.target
```
Save this file as `go-cddns.service` within the `systemd/system` directory.
You can start immediately and at boot, by running: `systemctl enable --now go-cddns`.
## Notes
* The update interval must be more than 5 minutes, per the WhatIsMyIP API [rules](http://whatismyipaddress.com/api).
* The records names must be FQDNs, even though they don't appear in the cloudflare dashboard as such.
* If the Remove field is set to true, the listed DNS records will be removed when the program exits.