65 lines
3.3 KiB
Markdown
65 lines
3.3 KiB
Markdown
# @push.rocks/smartacme
|
|
acme with an easy yet powerful interface in TypeScript
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartacme)
|
|
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartacme)
|
|
* [github.com (source mirror)](https://github.com/push.rocks/smartacme)
|
|
* [docs (typedoc)](https://push.rocks.gitlab.io/smartacme/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```javascript
|
|
import { SmartAcme } from 'smartacme';
|
|
|
|
const run = async () => {
|
|
smartAcmeInstance = new smartacme.SmartAcme({
|
|
accountEmail: 'domains@lossless.org',
|
|
accountPrivateKey: null,
|
|
mongoDescriptor: {
|
|
mongoDbName: testQenv.getEnvVarRequired('MONGODB_DATABASE'),
|
|
mongoDbPass: testQenv.getEnvVarRequired('MONGODB_PASSWORD'),
|
|
mongoDbUrl: testQenv.getEnvVarRequired('MONGODB_URL'),
|
|
},
|
|
removeChallenge: async (dnsChallenge) => {
|
|
// somehow provide a function that is able to remove the dns challenge
|
|
},
|
|
setChallenge: async (dnsChallenge) => {
|
|
// somehow provide a function that is able to the dns challenge
|
|
},
|
|
environment: 'integration',
|
|
});
|
|
await smartAcmeInstance.init();
|
|
|
|
// myCert has properties for public/private keys and csr ;)
|
|
const myCert = await smartAcmeInstance.getCertificateForDomain('bleu.de');
|
|
};
|
|
```
|
|
|
|
## Contribution
|
|
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
## Legal
|
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|