octodns-porkbun

Porkbun DNS provider for octoDNS, powered by oinker.

Installation

pip install octodns-porkbun

Configuration

providers:
  porkbun:
    class: octodns_porkbun.PorkbunProvider
    api_key: env/PORKBUN_API_KEY
    secret_key: env/PORKBUN_SECRET_KEY

Environment Variables

If api_key or secret_key are not provided in the config, the provider will fall back to environment variables:

• PORKBUN_API_KEY
• PORKBUN_SECRET_KEY

Supported Record Types

• A
• AAAA
• ALIAS
• CAA
• CNAME
• HTTPS
• MX
• NS
• SRV
• SSHFP
• SVCB
• TLSA
• TXT

Example Usage

providers:
  porkbun:
    class: octodns_porkbun.PorkbunProvider
    api_key: env/PORKBUN_API_KEY
    secret_key: env/PORKBUN_SECRET_KEY

  config:
    class: octodns.source.YamlProvider
    directory: ./zones

zones:
  example.com.:
    sources:
      - config
    targets:
      - porkbun

Development

# Install dependencies
uv sync --dev

# Run checks
make check

# Run individual checks
make lint
make typecheck
make test

License

MIT