Development
In development you can quickly get an environment running using Docker by following these steps:
Install these dependencies if you don't already have them
Docker for Desktop
Node.js (v12 LTS preferred)
Yarn
Clone this repo
Register a Slack app at https://api.slack.com/apps
Copy the file .env.sample to .env
Fill out the following fields:
SECRET_KEY (follow instructions in the comments at the top of .env)
SLACK_KEY (this is called "Client ID" in Slack admin)
SLACK_SECRET (this is called "Client Secret" in Slack admin)
Configure your Slack app's Oauth & Permissions settings
Add http://localhost:3000/auth/slack.callback as an Oauth redirect URL
Ensure that the bot token scope contains at least users:read
Run make up. This will download dependencies, build and launch a development version of Outline