update Readme
This commit is contained in:
parent
bbee7923e4
commit
d5b5e8d612
@ -1,15 +1,18 @@
|
||||
# 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
|
||||
|
||||
```typescript
|
||||
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
|
||||
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 pesistence in highly volatile environments like docker
|
||||
});
|
||||
|
||||
myCert.getDomainCert("example.com");
|
||||
|
2
dist/cert.paths.d.ts
vendored
2
dist/cert.paths.d.ts
vendored
@ -0,0 +1,2 @@
|
||||
import "typings-global";
|
||||
export import path = require("path");
|
6
dist/cert.paths.js
vendored
6
dist/cert.paths.js
vendored
@ -1,3 +1,5 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.path = require("path");
|
||||
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJjZXJ0LnBhdGhzLmpzIiwic291cmNlc0NvbnRlbnQiOltdfQ==
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImNlcnQucGF0aHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQyIsImZpbGUiOiJjZXJ0LnBhdGhzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFwidHlwaW5ncy1nbG9iYWxcIjtcbmV4cG9ydCBpbXBvcnQgcGF0aCA9IHJlcXVpcmUoXCJwYXRoXCIpO1xuXG4iXX0=
|
||||
|
0
dist/cert.plugins.d.ts
vendored
Normal file
0
dist/cert.plugins.d.ts
vendored
Normal file
3
dist/cert.plugins.js
vendored
Normal file
3
dist/cert.plugins.js
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJjZXJ0LnBsdWdpbnMuanMiLCJzb3VyY2VzQ29udGVudCI6W119
|
18
dist/index.d.ts
vendored
18
dist/index.d.ts
vendored
@ -0,0 +1,18 @@
|
||||
export declare class Cert {
|
||||
cfEmail: string;
|
||||
cfKey: string;
|
||||
sslDir: string;
|
||||
certificatesPresent: any;
|
||||
certificatesValid: any;
|
||||
gitOriginRepo: any;
|
||||
constructor(optionsArg: {
|
||||
cfEmail: string;
|
||||
cfKey: string;
|
||||
sslDir: string;
|
||||
gitOriginRepo: string;
|
||||
});
|
||||
getDomainCert(): void;
|
||||
}
|
||||
export declare class Certificate {
|
||||
constructor();
|
||||
}
|
24
dist/index.js
vendored
24
dist/index.js
vendored
@ -1,3 +1,23 @@
|
||||
"use strict";
|
||||
var Cert = (function () {
|
||||
function Cert(optionsArg) {
|
||||
this.cfEmail = optionsArg.cfEmail;
|
||||
this.cfKey = optionsArg.cfKey;
|
||||
this.sslDir = optionsArg.sslDir;
|
||||
this.gitOriginRepo = optionsArg.gitOriginRepo;
|
||||
}
|
||||
;
|
||||
Cert.prototype.getDomainCert = function () { };
|
||||
;
|
||||
return Cert;
|
||||
}());
|
||||
exports.Cert = Cert;
|
||||
var Certificate = (function () {
|
||||
function Certificate() {
|
||||
}
|
||||
;
|
||||
return Certificate;
|
||||
}());
|
||||
exports.Certificate = Certificate;
|
||||
|
||||
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJpbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbXX0=
|
||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFFQTtJQU9JLGNBQVksVUFLWDtRQUNHLElBQUksQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDLE9BQU8sQ0FBQztRQUNsQyxJQUFJLENBQUMsS0FBSyxHQUFHLFVBQVUsQ0FBQyxLQUFLLENBQUM7UUFDOUIsSUFBSSxDQUFDLE1BQU0sR0FBRyxVQUFVLENBQUMsTUFBTSxDQUFDO1FBQ2hDLElBQUksQ0FBQyxhQUFhLEdBQUcsVUFBVSxDQUFDLGFBQWEsQ0FBQztJQUNsRCxDQUFDOztJQUNELDRCQUFhLEdBQWIsY0FBZ0IsQ0FBQzs7SUFDckIsV0FBQztBQUFELENBbkJBLEFBbUJDLElBQUE7QUFuQlksWUFBSSxPQW1CaEIsQ0FBQTtBQUVEO0lBQ0k7SUFFQSxDQUFDOztJQUNMLGtCQUFDO0FBQUQsQ0FKQSxBQUlDLElBQUE7QUFKWSxtQkFBVyxjQUl2QixDQUFBIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aHMgZnJvbSBcIi4vY2VydC5wYXRoc1wiO1xuXG5leHBvcnQgY2xhc3MgQ2VydCB7XG4gICAgY2ZFbWFpbDpzdHJpbmc7XG4gICAgY2ZLZXk6c3RyaW5nO1xuICAgIHNzbERpcjpzdHJpbmc7XG4gICAgY2VydGlmaWNhdGVzUHJlc2VudDtcbiAgICBjZXJ0aWZpY2F0ZXNWYWxpZDtcbiAgICBnaXRPcmlnaW5SZXBvO1xuICAgIGNvbnN0cnVjdG9yKG9wdGlvbnNBcmc6e1xuICAgICAgICBjZkVtYWlsOnN0cmluZyxcbiAgICAgICAgY2ZLZXk6c3RyaW5nLFxuICAgICAgICBzc2xEaXI6c3RyaW5nLFxuICAgICAgICBnaXRPcmlnaW5SZXBvOnN0cmluZ1xuICAgIH0pe1xuICAgICAgICB0aGlzLmNmRW1haWwgPSBvcHRpb25zQXJnLmNmRW1haWw7XG4gICAgICAgIHRoaXMuY2ZLZXkgPSBvcHRpb25zQXJnLmNmS2V5O1xuICAgICAgICB0aGlzLnNzbERpciA9IG9wdGlvbnNBcmcuc3NsRGlyO1xuICAgICAgICB0aGlzLmdpdE9yaWdpblJlcG8gPSBvcHRpb25zQXJnLmdpdE9yaWdpblJlcG87XG4gICAgfTtcbiAgICBnZXREb21haW5DZXJ0KCl7fTtcbn1cblxuZXhwb3J0IGNsYXNzIENlcnRpZmljYXRlIHtcbiAgICBjb25zdHJ1Y3Rvcigpe1xuXG4gICAgfTtcbn0iXX0=
|
||||
|
Loading…
Reference in New Issue
Block a user