Merge pull request #957 from spotify/add-auth-backend-docs
Add required env vars for backends in README
This commit is contained in:
@@ -7,6 +7,18 @@ 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=<INSERT_CLIENT_ID_HERE>
|
||||
read -r AUTH_GOOGLE_CLIENT_SECRET
|
||||
<COPY_PASTE_CLIENT_SECRET_HERE>
|
||||
export AUTH_GOOGLE_CLIENT_SECRET
|
||||
run `yarn start` in packages/backend folder
|
||||
|
||||
## Links
|
||||
|
||||
- (The Backstage homepage)[https://backstage.io]
|
||||
|
||||
@@ -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=<INSERT_SENTRY_TOKEN_HERE>
|
||||
|
||||
Reference in New Issue
Block a user