2017-04-28 16:59:43 +00:00
|
|
|
# smartacme
|
2018-08-12 18:58:59 +00:00
|
|
|
|
2017-04-28 16:59:43 +00:00
|
|
|
acme implementation in TypeScript
|
|
|
|
|
|
|
|
|
|
## Availabililty
|
2018-08-12 18:58:59 +00:00
|
|
|
|
2017-04-28 16:59:43 +00:00
|
|
|
[](https://www.npmjs.com/package/smartacme)
|
|
|
|
|
[](https://GitLab.com/umbrellazone/smartacme)
|
|
|
|
|
[](https://github.com/umbrellazone/smartacme)
|
|
|
|
|
[](https://umbrellazone.gitlab.io/smartacme/)
|
|
|
|
|
|
|
|
|
|
## Status for master
|
2018-08-12 18:58:59 +00:00
|
|
|
|
2017-04-28 16:59:43 +00:00
|
|
|
[](https://GitLab.com/umbrellazone/smartacme/commits/master)
|
|
|
|
|
[](https://GitLab.com/umbrellazone/smartacme/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/smartacme)
|
|
|
|
|
[](https://david-dm.org/umbrellazone/smartacme)
|
|
|
|
|
[](https://www.bithound.io/github/umbrellazone/smartacme/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/umbrellazone/smartacme)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](http://standardjs.com/)
|
|
|
|
|
|
2017-04-28 16:56:55 +00:00
|
|
|
## Usage
|
2018-08-12 18:58:59 +00:00
|
|
|
|
2017-04-28 16:56:55 +00:00
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
|
|
|
|
|
|
```javascript
|
2018-08-12 18:58:59 +00:00
|
|
|
import { SmartAcme } from 'smartacme';
|
2017-04-28 16:56:55 +00:00
|
|
|
|
2018-08-12 18:58:59 +00:00
|
|
|
let smac = new SmartAcme()(async () => {
|
|
|
|
|
// learn async/await, it'll make your life easier
|
2017-04-28 16:56:55 +00:00
|
|
|
|
2018-08-12 18:58:59 +00:00
|
|
|
// optionally accepts a filePath Arg with a stored acmeaccount.json
|
|
|
|
|
// will create an account and
|
|
|
|
|
let myAccount = await smac.createAcmeAccount();
|
2017-04-28 16:56:55 +00:00
|
|
|
|
2018-08-12 18:58:59 +00:00
|
|
|
// will return a dnsHash to set in your DNS record
|
|
|
|
|
let myCert = await myAccount.createAcmeCert('example.com');
|
2017-04-28 16:56:55 +00:00
|
|
|
|
2018-08-12 18:58:59 +00:00
|
|
|
// gets and accepts the specified challenge
|
|
|
|
|
// first argument optional, defaults to dns-01 (which is the cleanest method for production use)
|
|
|
|
|
let myChallenge = await myCert.getChallenge('dns-01');
|
2017-04-28 16:56:55 +00:00
|
|
|
|
2018-08-12 18:58:59 +00:00
|
|
|
/* ----------
|
2017-04-28 16:56:55 +00:00
|
|
|
Now you need to set the challenge in your DNS
|
|
|
|
|
myChallenge.domainNamePrefixed is the address for the record
|
|
|
|
|
myChallenge.dnsKeyHash is the ready to use txt record value expected by letsencrypt
|
|
|
|
|
-------------*/
|
2018-08-12 18:58:59 +00:00
|
|
|
})();
|
2017-04-28 16:56:55 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Other relevant npm modules
|
2018-08-12 18:58:59 +00:00
|
|
|
|
|
|
|
|
| module name | description |
|
|
|
|
|
| ----------- | ------------------------------------------------------------------- |
|
|
|
|
|
| cert | a higlevel production module that uses smartacme to manage certs |
|
|
|
|
|
| smartnginx | a highlevel production tool for docker environments to manage nginx |
|
2017-04-28 16:59:43 +00:00
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
2018-08-12 18:58:59 +00:00
|
|
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
2017-04-28 16:59:43 +00:00
|
|
|
|
2018-08-12 18:58:59 +00:00
|
|
|
[](https://umbrella.zone
|
