@tryghost/greenlock-fastly-store v0.1.4

Greenlock Fastly Store

Greenlock stores are used by Greenlock to persist certificates, private keys and ACME accounts. This store acts as an intermediary, uploading new private keys and certificates to Fastly using their Platform TLS API before passing the information on to a traditional store to persist the data.

The persistent data store can be configured at runtime, with existing libraries available for file-based and database storage.

This library is made to be used in Greenlock with configuration that looks something like this:

{
    ...
    "store": {
        "module": "@tryghost/greenlock-fastly-store",
        "fastly": {
            "apiKey": "API_KEY_HERE",
            "tlsConfigurationName": "TLS v1.3",
            "allowUntrustedRoot": false
        },
        "persistentStore": {
            "module": "greenlock-store-fs",
            "basePath": "~/.greenlock.d/"
        }
    },
    ...
}

Install

npm install @tryghost/greenlock-fastly-store --save

or

yarn add @tryghost/greenlock-fastly-store

Usage

Use within Greenlock by calling Greenlock#manager.defaults() with the store set using the example above as a template.

Develop

1. git clone this repo & cd into it as usual
2. Run yarn to install top-level dependencies.

Run

• yarn dev

Test

Tests will be implemented using the Greenlock store test suite.

As the store is incredibly simple, it has been possible to test using a simple Greenlock configuration.

• yarn lint run just eslint
• yarn test run lint and tests

Publish

• yarn ship

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.