Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clayshek/google-ddns-updater
GoLang Google Domains Dynamic DNS API Update Client
https://github.com/clayshek/google-ddns-updater
ddns ddns-client ddns-updater docker-container github-actions go golang google-api google-dns google-domain google-domains google-domains-ip-updater
Last synced: 9 days ago
JSON representation
GoLang Google Domains Dynamic DNS API Update Client
- Host: GitHub
- URL: https://github.com/clayshek/google-ddns-updater
- Owner: clayshek
- License: mit
- Created: 2018-09-27T13:36:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T20:50:47.000Z (about 4 years ago)
- Last Synced: 2023-03-06T00:18:07.130Z (over 1 year ago)
- Topics: ddns, ddns-client, ddns-updater, docker-container, github-actions, go, golang, google-api, google-dns, google-domain, google-domains, google-domains-ip-updater
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# google-ddns-updater
GoLang Google Domains Dynamic DNS Update Client## Summary
google-ddns-updater is a program, writen in Go, for updating Google Domains dynamic DNS records via the Google Domains API. See Google documentation for API usage and other details: https://support.google.com/domains/answer/6147083?hl=en
ggoogle-ddns-updater will compare the current external IP address as obtained from http://myexternalip.com, with the currently resolving IP address of the DNS record. If they are identical, no further action is taken other than logging. If they differ, an authenticated request is sent to the Google Domains API to update the record, with logging of the request response and status.
## Requirements
- An existing dynamic DNS record hosted by Google Domains
- Environment variables set for GOOG_DDNS_HOSTNAME, GOOG_DDNS_USERNAME, & GOOG_DDNS_PASSWORD## Usage
### Standalone Binary
- Clone this repository
- Build the binary from src for your architecture:go build
- Set environment variables for GOOG_DDNS_HOSTNAME, GOOG_DDNS_USERNAME, & GOOG_DDNS_PASSWORD
- Run google-ddns-updater### Container Image
- Updates in this repo are automatically built via Dockerfile and a GitHub Action into a container image (ARM architecture) located at https://github.com/users/clayshek/packages/container/package/google-ddns-updater.docker pull ghcr.io/clayshek/google-ddns-updater:latest
. Required environment variables will need to be provided to the container.### Kubernetes
- The includedddns-k8s-deployment.yml
file can be used to pull the continer image into a Kubernetes or K3s cluster, which runs as an hourly CronJob. The secrets must be populated in the deployment file to be passed as environment variables to the pod.## To-Do
- [ ] Improve logging
- [ ] Add better code comments
- [ ] Versioning
- [ ] Create Helm chart