A TypeScript-based ACME client with an easy yet powerful interface for LetsEncrypt certificate management.
Go to file
2024-01-28 16:08:32 +01:00
.gitea/workflows fix(core): update 2024-01-28 02:50:41 +01:00
.vscode fix(core): update 2023-07-21 18:49:18 +02:00
test fix(core): update 2023-07-21 19:01:26 +02:00
ts fix(core): update 2024-01-28 16:08:32 +01:00
.gitignore fix(core): update 2020-05-17 16:21:25 +00:00
.npmignore update validation 2017-01-22 21:50:04 +01:00
LICENSE switch to acme core 2016-11-11 14:17:50 +01:00
npmextra.json fix(core): update 2023-07-21 18:49:18 +02:00
package.json fix(core): update 2024-01-28 16:08:32 +01:00
pnpm-lock.yaml fix(core): update 2024-01-28 16:08:32 +01:00
qenv.yml fix(core): update 2020-08-13 03:10:37 +00:00
readme.md fix(core): update 2023-07-21 18:49:18 +02:00
tsconfig.json fix(core): update 2023-07-21 18:49:18 +02:00

@push.rocks/smartacme

acme with an easy yet powerful interface in TypeScript

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia

Usage

Use TypeScript for best in class instellisense.

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 or contribute monthly. :)

For further information read the linked docs at the top of this readme.

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