https://github.com/caddy-dns/porkbun
https://github.com/caddy-dns/porkbun
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/caddy-dns/porkbun
- Owner: caddy-dns
- License: mit
- Created: 2022-03-01T21:35:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T22:00:44.000Z (5 months ago)
- Last Synced: 2024-11-05T23:17:10.419Z (5 months ago)
- Language: Go
- Size: 63.5 KB
- Stars: 31
- Watchers: 4
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - caddy-dns/porkbun - (Go)
README
# 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](https://github.com/caddyserver/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](https://caddyserver.com/docs/json/apps/tls/automation/policies/issuer/acme/) like so:
```json
{
"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}
}
}
```