2
0
mirror of https://git.coolaj86.com/coolaj86/acme-dns-01-vultr.js.git synced 2025-07-19 19:36:31 +00:00

78 lines
1.6 KiB
Markdown
Raw Normal View History

2019-07-03 22:34:54 -06:00
# [acme-dns-01-vultr](https://git.rootprojects.org/root/acme-dns-01-vultr.js) | a [Root](https://rootprojects.org) project
2019-06-10 16:54:39 +03:00
2019-06-13 13:51:01 -06:00
Vultr DNS + Let's Encrypt for Node.js
2019-06-10 16:54:39 +03:00
2019-06-13 13:51:01 -06:00
This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js.
Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js).
# Install
```bash
npm install --save acme-dns-01-vultr@3.x
```
# Usage
2019-07-16 11:59:48 -06:00
First you create an instance with your API token:
2019-06-13 13:51:01 -06:00
```js
var dns01 = require('acme-dns-01-vultr').create({
baseUrl: 'https://api.vultr.com/v1/dns', // default
2019-07-16 11:59:48 -06:00
token: 'xxxx'
2019-06-13 13:51:01 -06:00
});
```
Then you can use it with any compatible ACME module,
such as Greenlock.js or ACME.js.
### Greenlock.js
```js
var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
challenges: {
'dns-01': dns01
// ...
}
});
```
See [Greenlock™ Express](https://git.rootprojects.org/root/greenlock-express.js)
and/or [Greenlock.js](https://git.rootprojects.org/root/greenlock.js) documentation for more details.
### ACME.js
2019-06-10 16:54:39 +03:00
2019-06-13 13:51:01 -06:00
```js
// TODO
2019-06-10 16:54:39 +03:00
```
2019-06-13 13:51:01 -06:00
See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details.
### Build your own
```js
dns01
2019-07-16 11:59:48 -06:00
.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');
});
2019-06-13 13:51:01 -06:00
```
See [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js)
for more implementation details.
# Tests
```bash
# node ./test.js domain-zone api-key
2019-06-10 16:54:39 +03:00
node ./test.js example.com xxxxxx
```