Local Development Usage

Local Environment Usage

The Pantheon Secrets SDK includes a CustomerSecretsFakeClient implementation that is used when the SDK runs outside of Pantheon infrastructure. This client uses a secrets JSON file to build the secrets information emulating what happens on the platform using the Secrets service.

To get this file, you should use the plugin secret:site:local-generate command and then set an environment variable into your local environment (or docker container if you are running a docker-ized environment) with name CUSTOMER_SECRETS_FAKE_FILE and use the absolute path to the file as the value.

LANDO example

1. To setup this using lando, you should modify your .lando.yml like this:

   services:
     appserver:
       overrides:
         environment:
             CUSTOMER_SECRETS_FAKE_FILE: /app/secrets.json

2. Generate the secrets file like this:

   terminus secret:site:local-generate --filepath=./secrets.json

3. And rebuild lando application:

   lando rebuild -y

Now, you will be able to use your secrets through the SDK.

DDEV example

1. CD to your ddev root directory.

2. To setup using DDEV, add the following to your ~/.ddev/config.yml

   web_environment:
   - CUSTOMER_SECRETS_FAKE_FILE=./secrets.json

3. Generate the secrets file

   terminus secret:site:local-generate --filepath=./secrets.json

4. Restart your ddev environment

   ddev restart

Restrictions

For secrets that do not have the "user" scope, the secret:site:local-generate command will set the value of the secret to "null". Edit this file and replace the null values with appropriate test values for local development.