oneuptime/GlManager
Nawaz Dhandala e5b1beb731
fix
2022-04-17 14:52:16 +01:00
..
manager.ts fix 2022-04-17 14:52:16 +01:00
package-lock.json fix 2022-04-10 22:54:23 +01:00
package.json fix 2022-04-10 22:54:23 +01:00
README.md fix 2022-04-10 22:54:23 +01:00
tsconfig.json fix 2022-04-10 22:54:23 +01:00

oneuptime-gl-manager

Manages SSL Certificate issuance and renewal for Greenlock on OneUptime platform.

Saves global and per-site config to a local File Sytem (current).

Install

npm install --save oneuptime-gl-manager

Usage

Initialize the Manager

Greenlock.create({
    ...
    manager: "oneuptime-gl-manager",
    configDir: "./greenlock.d",
    packageRoot: __dirname
    ...
});

Site Management

By "site" we mean a primary domain and, optionally, secondary domains, to be listed on an ssl certificate, along with any configuration that is necessary for getting and renewing those certificates.

Add a sites - domains and SSL certificates

greenlock.add({
    subject: 'example.com',
    altnames: ['example.com', 'www.example.com'],
});

View site config

greenlock.get({
    servername: 'www.example.com',
    wildname: '*.example.com',
});

Update site config

greenlock.update({
    subject: 'www.example.com',
    challenges: {
        'dns-01': {
            module: 'acme-dns-01-ovh',
            token: 'xxxx',
        },
    },
});

Remove a site

To stop automatic renewal of SSL certificates for a particular site. You to restart renewal you must use add().

greenlock.remove({
    subject: 'example.com',
});