From 236bbd72a187110a9e4f5ced6162f85d48f661d2 Mon Sep 17 00:00:00 2001 From: Raghunandan Date: Fri, 22 May 2020 00:00:07 +0200 Subject: [PATCH] Add required env vars for backends in README --- plugins/auth-backend/README.md | 10 ++++++++++ plugins/sentry/README.md | 4 ++++ 2 files changed, 14 insertions(+) diff --git a/plugins/auth-backend/README.md b/plugins/auth-backend/README.md index f450332e8d..c2b0684c7e 100644 --- a/plugins/auth-backend/README.md +++ b/plugins/auth-backend/README.md @@ -7,6 +7,16 @@ This is the backend part of the auth plugin. It responds to auth requests from the frontend, and fulfills them by delegating to the appropriate provider in the backend. +## Requirements + +Needs AUTH_GOOGLE_CLIENT_ID and AUTH_GOOGLE_CLIENT_SECRET set in the environment for the backend to startup + +## Local development + +export AUTH_GOOGLE_CLIENT_ID= +read -r AUTH_GOOGLE_CLIENT_SECRET= +run `yarn start` in packages/backend folder + ## Links - (The Backstage homepage)[https://backstage.io] diff --git a/plugins/sentry/README.md b/plugins/sentry/README.md index 9004fd91c7..cce2228094 100644 --- a/plugins/sentry/README.md +++ b/plugins/sentry/README.md @@ -11,3 +11,7 @@ Your plugin has been added to the example app in this repository, meaning you'll You can also serve the plugin in isolation by running `yarn start` in the plugin directory. This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. + +Needs SENTRY_TOKEN set in the environment for the backend to startup + +export SENTRY_TOKEN=