https://github.com/jadolg/porkbun-ddns

Keep your Porkbun DNS records updated with your current IP address
https://github.com/jadolg/porkbun-ddns

ddns hacktoberfest porkbun snap

Last synced: about 2 months ago
JSON representation

Keep your Porkbun DNS records updated with your current IP address

• Host: GitHub
• URL: https://github.com/jadolg/porkbun-ddns
• Owner: jadolg
• License: mit
• Created: 2023-07-22T15:42:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-07T09:43:51.000Z (3 months ago)
• Last Synced: 2024-10-11T22:25:04.905Z (2 months ago)
• Topics: ddns, hacktoberfest, porkbun, snap
• Language: Go
• Homepage:
• Size: 181 KB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# porkbun-ddns

This project updates your DNS records at [Porkbun](https://porkbun.com/) with your current public IP address.

Your IP address is determined using https://wtfismyip.com/

## Install

### Snapcraft

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/porkbun-ddns)

- Run `snap install porkbun-ddns`

- Place your configuration at `/var/snap/porkbun-ddns/common/config.yaml`

- An example configuration can be found at https://raw.githubusercontent.com/jadolg/porkbun-ddns/main/example.config.yaml

- Restart the service `snap restart porkbun-ddns.porkbun-ddns-daemon`

### Docker

Modify the following command to match your specific requirements (path to the config file):

```

docker run -d --restart always --network host -v $PWD/config.yaml:/config.yaml ghcr.io/jadolg/porkbun-ddns:latest

```

*note:* I'm using `--network host` to avoid setting up IPv6 in Docker.

### Direct download

Not a fan of running snaps or docker? Not a problem!

Grab the binary for your system/architecture directly from the [release](https://github.com/jadolg/porkbun-ddns/releases) page and start using it.

### From source

You can also just install from GitHub using Go directly `go install github.com/jadolg/porkbun-ddns@latest`

## Metrics

To enable the collection of metrics, change the config file and set a valid port.

The current metrics are:

- porkbun_update_errors_total

- porkbun_credentials_errors_total

- porkbun_connection_errors_total

- porkbun_resolve_errors_total

- porkbun_update_success_total