acme-dns-01-namecheap.js/README.md

81 lines
1.8 KiB
Markdown
Raw Normal View History

# [acme-dns-01-namecheap](https://git.rootprojects.org/root/acme-dns-01-namecheap) | a [Root](https://rootrpojects.org) project
2019-07-23 07:54:22 +00:00
NameCheap DNS + Let's Encrypt
2019-06-15 23:15:15 +00:00
2019-07-16 15:05:09 +00: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).
2019-06-15 23:15:15 +00:00
2019-07-16 15:05:09 +00:00
# Install
```bash
npm install --save acme-dns-01-namecheap@3.x
```
# Usage
First you create an instance with your credentials:
```js
var dns01 = require('acme-dns-01-namecheap').create({
2019-07-23 07:54:22 +00:00
apiUser: 'username',
apiKey: 'xxxx',
clientIp: 'public ip',
username: 'api user',
baseUrl: 'sandbox or production' // default production
2019-07-16 15:05:09 +00: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
// ...
}
});
```
2019-07-16 15:05:09 +00:00
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
```js
// TODO
```
See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details.
### Build your own
```js
dns01
2019-07-23 07:54:22 +00: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-07-16 15:05:09 +00: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-user api-key client-ip username [username is optional if similar to api-user]
2019-07-23 07:54:22 +00:00
node ./test.js example.com demo d41474b94e7d4536baabb074a09c96bd 45.77.4.126
```