Update docs for v3 #1

New Issue

coolaj86 · 2019-11-02T17:58:02Z

coolaj86 commented

2019-11-02 17:58:02 +00:00

Copy, Paste, Pull Request

For all of the repositories in this list:

Type	Service	Plugin
dns-01	CloudFlare	acme-dns-01-cloudflare
dns-01	Digital Ocean	acme-dns-01-digitalocean
dns-01	DNSimple	acme-dns-01-dnsimple
dns-01	DuckDNS	acme-dns-01-duckdns
http-01	File System / Web Root	acme-http-01-webroot
dns-01	GoDaddy	acme-dns-01-godaddy
dns-01	Gandi	acme-dns-01-gandi
dns-01	NameCheap	acme-dns-01-namecheap
dns-01	Name.com	acme-dns-01-namedotcom
dns-01	Route53 (AWS)	acme-dns-01-route53
http-01	S3 (AWS, Digital Ocean, Scaleway)	acme-http-01-s3
dns-01	Vultr	acme-dns-01-vultr
dns-01	Build your own	acme-dns-01-test
http-01	Build your own	acme-http-01-test
tls-alpn-01	Contact us	-

(should be all of these:)

I need the old Greenlock v2 examples to be replaced with Greenlock v3 examples, in this form:

https://git.coolaj86.com/coolaj86/acme-dns-01-test.js#using-a-lets-encrypt-dns-plugin

# Copy, Paste, Pull Request For all of the repositories in this list: | Type | Service | Plugin | | ----------- | ----------------------------------------------------------------------------------- | ------------------------ | | dns-01 | CloudFlare | acme-dns-01-cloudflare | | dns-01 | [Digital Ocean](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js) | acme-dns-01-digitalocean | | dns-01 | [DNSimple](https://git.rootprojects.org/root/acme-dns-01-dnsimple.js) | acme-dns-01-dnsimple | | dns-01 | [DuckDNS](https://git.rootprojects.org/root/acme-dns-01-duckdns.js) | acme-dns-01-duckdns | | http-01 | File System / [Web Root](https://git.rootprojects.org/root/acme-http-01-webroot.js) | acme-http-01-webroot | | dns-01 | [GoDaddy](https://git.rootprojects.org/root/acme-dns-01-godaddy.js) | acme-dns-01-godaddy | | dns-01 | [Gandi](https://git.rootprojects.org/root/acme-dns-01-gandi.js) | acme-dns-01-gandi | | dns-01 | [NameCheap](https://git.rootprojects.org/root/acme-dns-01-namecheap.js) | acme-dns-01-namecheap | | dns-01 | [Name.com](https://git.rootprojects.org/root/acme-dns-01-namedotcom.js) | acme-dns-01-namedotcom | | dns-01 | Route53 (AWS) | acme-dns-01-route53 | | http-01 | S3 (AWS, Digital Ocean, Scaleway) | acme-http-01-s3 | | dns-01 | [Vultr](https://git.rootprojects.org/root/acme-dns-01-vultr.js) | acme-dns-01-vultr | | dns-01 | [Build your own](https://git.rootprojects.org/root/acme-dns-01-test.js) | acme-dns-01-test | | http-01 | [Build your own](https://git.rootprojects.org/root/acme-http-01-test.js) | acme-http-01-test | | tls-alpn-01 | [Contact us](mailto:support@therootcompany.com) | - | (should be all of these:) * https://git.coolaj86.com/coolaj86?q=acme-dns-01&tab=&sort=recentupdate * https://git.coolaj86.com/coolaj86?q=acme-http-01&tab=&sort=recentupdate I need the old Greenlock v2 examples to be replaced with Greenlock v3 examples, in this form: * https://git.coolaj86.com/coolaj86/acme-dns-01-test.js#using-a-lets-encrypt-dns-plugin

coolaj86 commented

2019-11-02 17:59:12 +00:00

ACME.js + Let's Encrypt DNS-01

This is how an ACME challenge module is with ACME.js:

acme.certificates.create({
	accountKey,
	csr,
	domains,
	challenges: {
		'dns-01': require('acme-dns-01-MODULE_NAME').create({
			fooUser: 'A_PLUGIN_SPECIFIC_OPTION',
			barToken: 'A_PLUGIN_SPECIFIC_OPTION'
		})
	}
});

Greenlock + Let's Encrypt DNS-01

This is how modules are used with Greenlock / Greenlock Express

Global default:

greenlock.manager.defaults({
	challenges: {
		'dns-01': {
			module: 'acme-dns-01-_MODULE_NAME',
			fooUser: 'A_PLUGIN_SPECIFIC_OPTION',
			barToken: 'A_PLUGIN_SPECIFIC_OPTION'
		}
	}
});

Per-Site config:

greenlock.add({
	subject: 'example.com',
	altnames: ['example.com', '*.example.com', 'foo.bar.example.com'],
	challenges: {
		'dns-01': {
			module: 'acme-dns-01-YOUR_MODULE_NAME',
			fooUser: 'A_PLUGIN_SPECIFIC_OPTION',
			barToken: 'A_PLUGIN_SPECIFIC_OPTION'
		}
	}
});

## ACME.js + Let's Encrypt DNS-01 This is how an ACME challenge module is with ACME.js: ```js acme.certificates.create({ accountKey, csr, domains, challenges: { 'dns-01': require('acme-dns-01-MODULE_NAME').create({ fooUser: 'A_PLUGIN_SPECIFIC_OPTION', barToken: 'A_PLUGIN_SPECIFIC_OPTION' }) } }); ``` ## Greenlock + Let's Encrypt DNS-01 This is how modules are used with Greenlock / Greenlock Express **Global** default: ```js greenlock.manager.defaults({ challenges: { 'dns-01': { module: 'acme-dns-01-_MODULE_NAME', fooUser: 'A_PLUGIN_SPECIFIC_OPTION', barToken: 'A_PLUGIN_SPECIFIC_OPTION' } } }); ``` **Per-Site** config: ```js greenlock.add({ subject: 'example.com', altnames: ['example.com', '*.example.com', 'foo.bar.example.com'], challenges: { 'dns-01': { module: 'acme-dns-01-YOUR_MODULE_NAME', fooUser: 'A_PLUGIN_SPECIFIC_OPTION', barToken: 'A_PLUGIN_SPECIFIC_OPTION' } } }); ```

Sign in to join this conversation.

No Label

No Milestone

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: coolaj86/acme-http-01-test.js#1