Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlcdf/dyndns
Update Gandi LiveDNS based on the current (dynamic) ip.
https://github.com/mlcdf/dyndns
discord dyndns dyndns-updater gandi gandi-livedns self-hosted
Last synced: about 1 month ago
JSON representation
Update Gandi LiveDNS based on the current (dynamic) ip.
- Host: GitHub
- URL: https://github.com/mlcdf/dyndns
- Owner: mlcdf
- License: mit
- Created: 2021-04-13T18:47:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-27T01:19:25.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T13:55:59.721Z (5 months ago)
- Topics: discord, dyndns, dyndns-updater, gandi, gandi-livedns, self-hosted
- Language: Go
- Homepage:
- Size: 94.7 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dyndns
[](https://github.com/mlcdf/dyndns/actions/workflows/test.yml)
[](https://mlcdf.github.io/dyndns/report.html)
Update Gandi LiveDNS based on the current (dynamic) ip.
## Why
Some (most ?) providers ([Orange](https://orange.fr/) for example) don't provide you with a fix IP address: they give you a dynamic IP that changes over time. This makes it hard to self-host software and share them publicly via a domain because you have to constantly
change the IP your domain is pointing to.
This program aims to solve that. It's intended to run on a always-on computer in your home (such as Raspberry Pi).
## Highlights
- Supports both IPv4 and IPv6.
- Ship as single binary with no OS dependencies.
- Reports failures and successful updates on a Discord channel. /!\ This is not optional (by design).
## Install
- From [GitHub releases](https://go.mlcdf.fr/dyndns/releases): download the binary corresponding to your OS and architecture.
- From source (make sure `$GOPATH/bin` is in your `$PATH`):
```sh
go install go.mlcdf.fr/dyndns
```
## Setup
`dyndns` requires the following environment variables to be set:
| name | description |
|-----------------------|-----------------------------------------------------------------------------------------------------------|
| `DISCORD_WEBHOOK_URL` | your [Discord channel webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
| `GANDI_TOKEN` | your [Gandi API Key](https://docs.gandi.net/en/domain_names/advanced_users/api.html) |
## Usage
```
Usage:
dyndns --domain [DOMAIN] --record [RECORD]
Options:
--ttl Time to live in seconds. Defaults to 3600
--always-notify Always notify the Discord channel (even when nothing changes)
-V, --version Print version
Examples:
export DISCORD_WEBHOOK_URL='https://discord.com/api/webhooks/xxx'
export GANDI_TOKEN='foobar'
dyndns --domain example.com --record "*.pi"
```
Setup as a `cron` job
```bash
crontab -e
# Run every 10 minutes
*/10 * * * * /path/to/dyndns --domain example.com --record "*.pi"
```
Check out the example [contrib/deploy.sh](./contrib/deploy.sh) script.
## Development
Requirements:
- go version > 1.19+
- docker
Run the app
```sh
go run main.go
```
Run the tests
```sh
go test ./...
```
Force `go test` to run all the tests (by disabling caching)
```sh
./scrits/test.sh
```
## License
[MIT](https://choosealicense.com/licenses/mit/)