Skip to content
/ Oink Public

A lightweight DDNS client for Porkbun

License

Notifications You must be signed in to change notification settings

RLado/Oink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oink!

A lightweight DDNS client for Porkbun

NOTE: Oink! is in BETA. If you encounter any bugs please report them at https://github.com/RLado/Oink!

Oink! is an unofficial DDNS client for porkbun.com built in Go. Oink! only depends on Go's standard library.


How to install

You can install Oink! using an official package or by using make.

On distributions supporting .deb files (Debian, Ubuntu, ...)

dpkg -i <oink_pkg>.deb

Or you can build from source and install using make

Requires make and go

make
sudo make install

You may uninstall using sudo make uninstall to remove all configuration files and binaries


How to setup

The setup process is simple:

  • If installed correctly you should find Oink!'s configuration file in /etc/oink_ddns/config.json. Open the file with your text editor of choice.
  • In the configuration file you should find the following contents that must be filled in:

⚠️ In case you do not already have an API key, you will need to request one at: https://porkbun.com/account/api

{
    "secretapikey": "<your secret api key here>",
    "apikey": "<your api key here>",
    "domain": "<your domain here>",
    "subdomain": "<your subdomain here>",
    "ttl": 600,
    "priority": 0,
    "interval": 300
}
  • Enable and start the service using systemd

⚠️ Make sure to enable API ACCESS in your porkbun domain's control panel

systemctl enable oink_ddns
systemctl start oink_ddns
  • You are done! Your domain DNS record should update automatically