fix: small improvements to local dev (#2699)

* dont commit pem files to git
* update readme ngrok instructions
* quote the OIDC scope string
This commit is contained in:
Nan Yu 2021-10-28 21:44:14 -07:00 committed by GitHub
parent 9a1c5c187e
commit 61d56922d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 3 deletions

View File

@ -94,10 +94,10 @@ OIDC_USERINFO_URI=
OIDC_USERNAME_CLAIM=preferred_username
# Display name for OIDC authentication
OIDC_DISPLAY_NAME=OpenID Connect
OIDC_DISPLAY_NAME=OpenID
# Space separated auth scopes.
OIDC_SCOPES=openid profile email
OIDC_SCOPES="openid profile email"
# OPTIONAL

1
.gitignore vendored
View File

@ -8,3 +8,4 @@ stats.json
.DS_Store
fakes3/*
.idea
*.pem

View File

@ -97,7 +97,7 @@ For contributing features and fixes you can quickly get an environment running u
1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin)
1. Configure your Slack app's Oauth & Permissions settings
1. Slack recently prevented the use of `http` protocol for localhost. For local development, you can use a tool like [ngrok](https://ngrok.com) or a package like `mkcert`. ([How to use HTTPS for local development](https://web.dev/how-to-use-local-https/))
1. Add `https://my_ngrok_address/auth/slack.callback` as an Oauth redirect URL
1. Add `https://my_ngrok_address/auth/slack.callback` as an Oauth redirect URL and update the `URL` env var to match
1. Ensure that the bot token scope contains at least `users:read`
1. Run `make up`. This will download dependencies, build and launch a development version of Outline