reference-instance
an instance of a greenkeeper-keeper service that can either be deployed as is to your preferred host or used as a reference for creating your own custom instance
Configuration
config for this instance is expected through environment variables and provides the necessary details for the underlying hapi plugin as well as for ensuring the webhooks are really from GitHub
The required variables are enforced at startup by dotenv-safe
and are defined in .env.example
-
PORT
: the port that the instance should listen on (might be defined automatically by your host) -
GITHUB_TOKEN
: personal access token for the account intended to accept the greenkeeper PRsNote: the personal access token will need the
repo
andrepo:read_hooks
scopes in order to work properly -
GITHUB_WEBHOOK_SECRET
: a secret used to secure your webhooks which must match the secret used for the webhook defined for each repo