zhuwenbing / porkbun-ddns

A custom ddns shell script by using porkbun api v3.

Porkbun DDNS

The porkbun_ddns.sh is a command-line tool for Porkbun DDNS (Dynamic Domain Name Server). It is written in the shell and has very few dependencies.

Features:

1. Few dependencies, only need curl and dig installed.
2. Supports both IPv4 and IPv6.
3. Unlike other scripts, this script can still obtain the real IP in the proxy environment.
4. Can theoretically run on most computers or routers.
5. Execute according to IP changes, less calls to Porkbun's API.

Usage:

1. Download the shell script then upload it to a folder on your computer or router, e.g. /usr/bin.
2. Confirm that the curl and dig commands are available on your machine. Actually the script will also help to check.
3. Give the shell script executable permissions.

chmod +x /usr/bin/porkbun_ddns.sh

4. Execute the following command to get usage help information.

porkbun_ddns.sh --help

Porkbun DDNS CLI v1.0.3 (2024.2.5)
Usage: porkbun-ddns.sh <command> ... [parameters ...]
Commands:
  --help                        Show this help message.
  --version                     Show version info.
  --api-key, -ak <apikey>       Specify Porkbun API Key.
  --secret-key, -sk <secretkey> Specify Porkbun Secret Key.
  --host, -h <host>             Add a hostname.
  --config-file, -c <filepath>  The path to config file.

Example:
  # Read parameters from a config file.
  porkbun-ddns.sh \
    -c /etc/porkbun.conf

  # Pass parameters from the command line.
  porkbun-ddns.sh \
    -ak pk1_jeldvj74ql06qq81rfx7jqsaubno867q4zp3b2fi06pw2bns81innur6p0oq3n7s \
    -sk sk1_kfkcxsgne1i8qm4mr8va8t9e8f5ezpw8fsin35uh8jjqwhgsfb7571y2wq3shdgx \
    -h domain1.tld \
    -h subdomain.domain1.tld \
    -h subdomain.domain2.tld

Exit codes:
  0 Successfully updating for all host(s)
  9 Arguments error

Tips:
  Strongly recommand to refetch records or clear caches in file,
  if your DNS records have been updated by other ways.

5. Set parameters according to your actual situation, then run the shell script and view the results.
6. Please note, in this script, we specify that command-line arguments take precedence over parameters in the configuration file.
7. After confirming that it is correct, you can also add it to the crontab for automatic execution.

# e.g.
# Run every five minutes
*/5 * * * * porkbun-ddns.sh -c /etc/porkbun.conf

Changelog:

1. 2024/2/5

• Release v1.0.3 version
  • Command-line options now support configuration file parameters. You can now add essential script parameters in the configuration file, which will greatly enhance security.
  • Added a configuration sample file.

2. 2023/11/13

• Release v1.0.2 version
  • See #3.

3. 2023/6/13

• Release v1.0.1 version
  • Fix typos (Thanks to Haarolean).
  • IP_ADDR_V6: unbound variable on host w/o IPv6.

4. 2022/5/20 - Release v1.0.0 version.

Thanks:

1. Mr-Jos/namesilo_ddns_cli