README.md

DDNS Porkbun Script

This script allows you to automatically update DNS records for your domain/subdomains on Porkbun using their API. It ensures your records are always in sync with your current public IP.

Install & Upgrade

bash <(curl -Ls "https://raw.githubusercontent.com/StafLoker/ddns-porkbun-script/main/install.sh")

Install legacy Version (we don't recommend)

To install your desired version, use following installation command. e.g., version v1.0.1:

VERSION=v1.0.1 && bash <(curl -Ls "https://raw.githubusercontent.com/StafLoker/ddns-porkbun-script/main/install.sh") $VERSION

Manual Install

Prerequisites

1. Install jq:
   jq is a lightweight and flexible command-line JSON processor, required to parse API responses.

   sudo apt install jq

2. Create keys.env file:
   Store your API keys securely in an environment file. Replace pk and sk with your actual API and Secret API keys from Porkbun.

   echo 'PORKBUN_API_KEY="pk"' > keys.env
   echo 'PORKBUN_SECRET_API_KEY="sk"' >> keys.env

   Make sure to secure this file:

   chmod 600 keys.env

3. Configure your domain and subdomains:
   Create the data.json file to include your domain and subdomains. Example format:

   {
       "domain": "example.com",
       "concurrency": true,
       "ipv4": true,
       "subdomains_type_a": [
           "sub1",
           "sub2"
       ],
       "ipv6": false,
       "subdomains_type_aaaa": [
           "sub3",
           "sub4"
       ]
   }

4. Make the script executable:
   Ensure the script has executable permissions:

   chmod +x ddns-porkbun-script.sh

---

Automating with Cron

To automate the script, use cron to schedule periodic and system startup executions:

1. Open crontab for editing:

   crontab -e

2. Add the following entries:

   • Run every hour: Updates DNS records every hour.
   • Run on system reboot: Ensures DNS updates upon system startup.

   # Every 1 hour
   0 * * * * /path/to/ddns-porkbun-script.sh
   
   # At system reboot
   @reboot /path/to/ddns-porkbun-script.sh

3. Save and exit the crontab editor.

4. Updating ddns-porkbun-script.sh for Cron Compatibility Here is the updated snippet of the ddns-porkbun-script.sh file:

   # Load keys
   source /absolute/path/to/keys.env
   
   # Load JSON
   DATA_FILE="/absolute/path/to/data.json"

   Verifying:

   1. Edit your Cron job to point to the updated ddns-porkbun-script.sh file.
   2. Execute the script manually to confirm it works without errors:

      /absolute/path/to/ddns-porkbun-script.sh

---

Security Notes

• Environment File: Ensure the keys.env file is not accessible to other users on the system. Use chmod 600 to restrict permissions.
• Avoid Hardcoding Keys: Use the source command to load environment variables securely.

---

Testing

To test the script manually, run:

./ddns-porkbun-script.sh

Verify that the DNS records on Porkbun are updated to match your current public IP.

---

Logging

Check logs

journalctl -t ddns-porkbun | tail

License

This project is released under the MIT License. See the LICENSE file for more details.