smartacme/README.md
2019-01-06 20:41:21 +01:00

3.2 KiB

smartacme

acme implementation in TypeScript

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import { SmartAcme } from 'smartacme';

let smac = new SmartAcme()(async () => {
  // learn async/await, it'll make your life easier

  // optionally accepts a filePath Arg with a stored acmeaccount.json
  // will create an account and
  let myAccount = await smac.createAcmeAccount();

  // will return a dnsHash to set in your DNS record
  let myCert = await myAccount.createAcmeCert('example.com');

  // 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');

  /* ----------
    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
    -------------*/
})();

Other relevant npm modules

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

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

[repo-footer](https://umbrella.zone