development.md

Development setup

NOTE: This setup is purely for local development, demonstration or testing.

Run it locally

Run a local development setup with the following commands:

$ make build
$ make start
$ make enable

This creates a local Vault installation in development mode and enables the plugin.

Configuring the plugin

Follow the configuration guide.

Mock usage

By setting the API key to mock the plugin is forced to use the mock API client, which does not communciate with the Vercel API at all. Useful for development purposes and refactoring. The returned bearer_token is hard coded to some-bearer-token.

$ vault write vercel-secrets/config api_key=mock
$ vault read vercel-secrets/token
Key                Value
---                -----
lease_id           vercel-secrets/token/BIxRweNgXNSQsnbeBBmiea8X
lease_duration     10m
lease_renewable    false
bearer_token       some-bearer-token
team_id            n/a
token_id           vault-plugin-secrets-vercel-1689595722412039000-1689595722412067000