mietzen/porkbun-ddns

porkbun-ddns Docker镜像文档

镜像概述

porkbun-ddns是一个非官方的Porkbun域名DDNS（动态域名系统）客户端。该工具用于动态更新Porkbun域名的DNS记录，仅在公网IP发生变更或记录不存在时执行更新操作，同时支持设置和更新A记录（IPv4）与AAAA记录（IPv6）。

免责声明：本工具与Porkbun无任何关联或开发关系。所有商标、徽标和品牌名称均为其各自所有者的财产。本工具中使用的所有公司、产品和服务名称仅用于识别目的，不表示认可。

核心功能与特性

• 智能更新机制：仅在公网IP发生变更或DNS记录不存在时执行更新操作，减少不必要的API请求
• 双协议支持：同时支持A记录（IPv4）和AAAA记录（IPv6）的更新
• 灵活的IP获取方式：
  • 手动指定静态公网IP
  • 通过Fritz!BOX设备自动获取公网IP
• 可配置更新间隔：自定义DNS记录检查和更新的时间间隔（秒）
• 多子域名支持：可同时管理多个子域名（含多级子域名）的DNS记录

使用场景

适用于需要将Porkbun域名动态解析到当前公网IP的场景，特别是：

• 家庭网络或小型办公网络，使用动态公网IP
• 需要通过域名访问本地服务（如NAS、服务器），但IP频繁变化
• 同时需要IPv4和IPv6解析支持的环境

使用方法与配置说明

基本部署方式

推荐使用Docker Compose进行部署，以下是完整配置示例：

yaml
version: "3"
services:
  porkbun-ddns:
    image: "mietzen/porkbun-ddns:latest"
    container_name: porkbun-ddns
    environment:
      DOMAIN: "domain.com" # 你的Porkbun主域名
      SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # 子域名，多个用逗号分隔
      SECRETAPIKEY: "<YOUR-SECRETAPIKEY>" # 你的Porkbun Secret-API-Key
      APIKEY: "<YOUR-APIKEY>" # 你的Porkbun API-Key
      # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # 可选，静态公网IP，IPv4和IPv6用逗号分隔
      # FRITZBOX: "192.168.178.1" # 可选，Fritz!BOX路由器IP，用于获取公网IP
      # SLEEP: "300" # 可选，更新间隔（秒），默认300秒
      # IPV4_ONLY: "FALSE" # 可选，是否仅更新IPv4记录，默认FALSE
      # IPV6_ONLY: "FALSE" # 可选，是否仅更新IPv6记录，默认FALSE
      # DEBUG: "FALSE" # 可选，是否启用调试日志，默认FALSE
    restart: unless-stopped

环境变量配置说明

注意事项

1. API密钥获取：需从Porkbun账户控制台生成API Key和Secret API Key，确保该密钥具有域名DNS管理权限。
2. IP获取优先级：若同时配置PUBLIC_IPS和FRITZBOX，则PUBLIC_IPS优先生效。
3. 子域名格式：子域名无需包含主域名，如主域为example.com，子域名sub将生成sub.example.com记录。
4. 重启策略：推荐使用unless-stopped确保容器在后台持续运行，实现DNS自动更新。

示例配置场景

场景1：基本动态IP配置

yaml
environment:
  DOMAIN: "home.example.com"
  SUBDOMAINS: "server,nas"
  SECRETAPIKEY: "sk1234567890abcdef"
  APIKEY: "pk1234567890abcdef"
  SLEEP: "600" # 每10分钟检查一次

场景2：通过Fritz!BOX获取IP

yaml
environment:
  DOMAIN: "example.com"
  SUBDOMAINS: "router"
  SECRETAPIKEY: "sk1234567890abcdef"
  APIKEY: "pk1234567890abcdef"
  FRITZBOX: "192.168.178.1" # Fritz!BOX路由器IP

场景3：静态IP配置

yaml
environment:
  DOMAIN: "example.com"
  SUBDOMAINS: "static"
  SECRETAPIKEY: "sk1234567890abcdef"
  APIKEY: "pk1234567890abcdef"
  PUBLIC_IPS: "192.0.2.1,2001:db8::1" # 静态IPv4和IPv6地址

相关链接

• https://github.com/mietzen/porkbun-ddns