https://github.com/caddy-dns/template

Template for new DNS provider modules
https://github.com/caddy-dns/template

Last synced: 3 months ago
JSON representation

Template for new DNS provider modules

• Host: GitHub
• URL: https://github.com/caddy-dns/template
• Owner: caddy-dns
• License: mit
• Created: 2021-02-24T16:43:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T14:14:12.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T13:34:36.162Z (5 months ago)
• Language: Go
• Size: 83 KB
• Stars: 10
• Watchers: 2
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - caddy-dns/template - Template for new DNS provider modules (others)

README

        
**DEVELOPER INSTRUCTIONS:**

- Update module name in go.mod

- Update dependencies to latest versions

- Update name and year in license

- Customize configuration and Caddyfile parsing

- Update godocs / comments (especially provider name and nuances)

- Update README and remove this section

---

\ module for Caddy

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

This package contains a DNS provider module for [Caddy](https://github.com/caddyserver/caddy). It can be used to manage DNS records with \.

## Caddy module name

```

dns.providers.provider_name

```

## 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": "provider_name",

				"api_token": "YOUR_PROVIDER_API_TOKEN"

			}

		}

	}

}

```

or with the Caddyfile:

```

# globally

{

	acme_dns provider_name ...

}

```

```

# one site

tls {

	dns provider_name ...

}

```