Slack

In this guide docs.mycompany.com will be used to represent the location you’re hosting Outline, it should be replaced with the correct value. This guide only covers setting up Slack for authentication – if you are looking to setup Slack commands / posting see the integrations page.

Register an application

  • Go to https://api.slack.com/apps

  • Click the “Create New App” button

  • Give your app a recognizable name, icon, description etc.

  • Save the new app

OAuth & Permissions

  • Go to “OAuth & Permissions” in the left sidebar

  • For the Redirect URL add the following: https://docs.mycompany.com/auth/slack.callback – Note that Slack requires this url is HTTPS. If you are locally developing the software a valid certificate can be generated easily with mkcert.

  • Under “Scopes” the following are required:

    • identity.avatar

    • identity.basic

    • identity.email

    • identity.team

Configure Outline

In your Outline environment set the following variables, the values can be found under “Basic information” in the Slack interface, restart the server to see the Slack sign-in option.

Environment variable

SLACK_CLIENT_ID

Find value under “Basic information” in Slack

SLACK_CLIENT_SECRET

Find value under “Basic information” in Slack