From e0fb76cb63102749d172f5477ecc36a988949176 Mon Sep 17 00:00:00 2001 From: Yao Wang Date: Tue, 8 Jun 2021 09:11:45 +0800 Subject: [PATCH] documentation: Instructions for local development (#2180) * Fix the instruction for local development * update readme for Slack OAuth in local development * Fix the callback URL setting instruction --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 48759a9d..d9b0b8fe 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,8 @@ For contributing features and fixes you can quickly get an environment running u 1. `SLACK_KEY` (this is called "Client ID" in Slack admin) 1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin) 1. Configure your Slack app's Oauth & Permissions settings - 1. Add `http://localhost:3000/auth/slack.callback` as an Oauth redirect URL + 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. 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