README.md

Porkbun module for Caddy

===========================

⚠️ Porkbun API hostname change ⚠️

This module has been swapped to the updated API hostname as of V0.20. Versions prior to this will cease to function when the old endpoint is disabled on 01/12/2024.

About

This package contains a DNS provider module for Caddy. It can be used to manage DNS records with Porkbun.

Caddy module name

dns.providers.porkbun

Config examples

To use this module for the ACME DNS challenge, configure the ACME issuer in your Caddy JSON like so:

{
	"module": "acme",
	"challenges": {
		"dns": {
			"provider": {
				"name": "porkbun",
				"api_key": "{env.PORKBUN_API_KEY}",
        		"api_secret_key": "{env.PORKBUN_API_SECRET_KEY}"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns porkbun {
			api_key {env.PORKBUN_API_KEY}
			api_secret_key {env.PORKBUN_API_SECRET_KEY}
	}
}

# one site
tls {
	dns porkbun {
			api_key {env.PORKBUN_API_KEY}
			api_secret_key {env.PORKBUN_API_SECRET_KEY}
	}
}