smartcert/README.md
2016-06-18 16:14:57 +02:00

1.3 KiB

Cert

Easily obain SSL certificates from LetsEncrypt. Supports DNS-01 challenge. TypeScript ready.

Note: this package is in pre-alpha stage and will be ready soon.

Usage

import {Cert} from "cert";

let myCert = new Cert({
    cfEmail: "some@cloudflare.email",
    cfKey: "someCloudflareApiKey",
    sslDir: "someOutputPath", // NOTE: if you already have certificates, make sure you put them in here, so cert only requires the missing ones
    gitOriginRepo: "git@githhub.com/someuser/somereopo" // good for persistence in highly volatile environments like docker
});

myCert.getDomainCert("example.com");

sslDir

to use the certificates it is important to understand what the structure of the ssl directory looks like.

using a git origin repo.

Often times you want to keep track of certificates in order to keep them even if the point of initial certificate request is gone. Imagine you have a dockerenvironement and you keep starting new container versions for the same domain. YOu ideally want to use a proxy that handles SSL managemet for you. But even the proxy needs to be updated from time to time.

So you need some kind of persistence between versions. This is why you can sync up all certificates to a git repo over ssh Just make sure your id_rsa is in place for the node user and is allowed for the origin repo.