From 7da0d7589ea67aad4d2ed2fe4135e8fadf316ae9 Mon Sep 17 00:00:00 2001 From: Nan Yu Date: Mon, 30 Mar 2020 08:26:37 -0700 Subject: [PATCH 1/2] minor ergonomic updates to readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 14f52092a..4698bd7bb 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ In development you can quickly get an environment running using Docker by follow 1. Fill out the following fields: 1. `SECRET_KEY` (follow instructions in the comments of `.env`) 1. `SLACK_KEY` (this is called "Client ID" in Slack admin) - 1. `SLACK_SECRET` + 1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin) 1. Add `http://localhost:3000/auth/slack.callback` as an Oauth callback URL in Slack App settings 1. Run `make up`. This will download dependencies, build and launch a development version of Outline @@ -54,9 +54,9 @@ For a self-hosted production installation there is more flexibility, but these a 1. Build the web app with `yarn build:webpack` or `npm run build:webpack` 1. Using the `.env.sample` as a reference, set the required variables in your production environment. The following are required as a minimum: - 1. `SECRET_KEY` (follow instructions in the comments of `.env`) + 1. `SECRET_KEY` (follow instructions in the comments at the top of `.env`) 1. `SLACK_KEY` (this is called "Client ID" in Slack admin) - 1. `SLACK_SECRET` + 1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin) 1. `DATABASE_URL` (run your own local copy of Postgres, or use a cloud service) 1. `REDIS_URL` (run your own local copy of Redis, or use a cloud service) 1. `URL` (the public facing URL of your installation) From f521543b0a2fab8eca6723095d96ceff4712e11a Mon Sep 17 00:00:00 2001 From: Nan Yu Date: Mon, 30 Mar 2020 08:57:21 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4698bd7bb..a098a8e48 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,12 @@ In development you can quickly get an environment running using Docker by follow 1. Register a Slack app at https://api.slack.com/apps 1. Copy the file `.env.sample` to `.env` 1. Fill out the following fields: - 1. `SECRET_KEY` (follow instructions in the comments of `.env`) + 1. `SECRET_KEY` (follow instructions in the comments at the top of `.env`) 1. `SLACK_KEY` (this is called "Client ID" in Slack admin) 1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin) -1. Add `http://localhost:3000/auth/slack.callback` as an Oauth callback URL in Slack App settings +1. Configure your Slack app's Oauth & Permissions settings + 1. Add `http://localhost:3000/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