From 61d56922d57e6301320a0efd6f52117c3afdc50d Mon Sep 17 00:00:00 2001 From: Nan Yu Date: Thu, 28 Oct 2021 21:44:14 -0700 Subject: [PATCH] fix: small improvements to local dev (#2699) * dont commit pem files to git * update readme ngrok instructions * quote the OIDC scope string --- .env.sample | 4 ++-- .gitignore | 1 + README.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.env.sample b/.env.sample index 14f7cedc..2d153caf 100644 --- a/.env.sample +++ b/.env.sample @@ -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 –––––––––––––––– diff --git a/.gitignore b/.gitignore index 9c279077..9e944108 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ stats.json .DS_Store fakes3/* .idea +*.pem diff --git a/README.md b/README.md index 133848bb..2b4f5da1 100644 --- a/README.md +++ b/README.md @@ -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