You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
nyaundi brian f56d570e7f remove todo 4 years ago
lib remove todo 4 years ago
.gitignore initial commit 4 years ago
.prettierrc initial commit 4 years ago
AUTHORS initial commit 4 years ago
README.md initial commit 4 years ago
example.env initial commit 4 years ago
index.js initial commit 4 years ago
package.json initial commit 4 years ago
test.js initial commit 4 years ago

README.md

acme-dns-01-ovh | a Root project

OVH DNS + Let's Encrypt for Node.js

This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js. Passes acme-dns-01-test.

Install

npm install --save acme-dns-01-ovh@3.x

Usage

First you need to create API keys on the OVH portal :

Go to the page https://api.ovh.com/createToken/index.cgi?GET=/domain/zone&PUT=/domain/zone&POST=/domain/zone&DELETE=/domain/zone

Then you create an instance with your API keys

var dns01 = require('acme-dns-01-ovh').create({
	applicationKey: 'xxxx', // default
	applicationSecret: 'xxxx',
	consumerKey: 'xxxx',
	region: 'ovh-eu', // one of ovh-eu, ovh-ca, kimsufi-eu, kimsufi-ca, soyoustart-eu, soyoustart-ca, runabove-ca
});

Then you can use it with any compatible ACME module, such as Greenlock.js or ACME.js.

Greenlock.js

var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
	challenges: {
		'dns-01': dns01
		// ...
	}
});

See Greenlock™ Express and/or Greenlock.js documentation for more details.

ACME.js

// TODO

See the ACME.js for more details.

Build your own

dns01
	.set({
		identifier: { value: 'foo.example.com' },
		wildcard: false,
		dnsHost: '_acme-challenge.foo.example.com',
		dnsAuthorization: 'xxx_secret_xxx'
	})
	.then(function() {
		console.log('TXT record set');
	})
	.catch(function() {
		console.log('Failed to set TXT record');
	});

See acme-dns-01-test for more implementation details.

Tests

# node ./test.js domain-zone api-key
node ./test.js example.com xxxxxx