diff --git a/README.md b/README.md index 4b47b45..c62ea18 100644 --- a/README.md +++ b/README.md @@ -52,19 +52,26 @@ Also check the config for other values, like your homeserver domain. ## How to get Slack app credentials -### Legacy Token +### Option 1. Legacy Token Get a legacy token from https://api.slack.com/custom-integrations/legacy-tokens and then chat with the bot user (`@_slackpuppet_bot:domain.tld` unless you changed the config): ``` link ``` -### OAuth -To use OAuth set up a slack app and fill in `oauth` block in your config. Be sure to forward the `oauth.redirectUri` to the bridge. Then just run: -``` -link -``` - -### xoxs token +### Option 2. OAuth +To use OAuth +1. Set up a Slack app at https://api.slack.com/apps. You do not need to setup any + of the additional features or functionality that Slack prompts you to enable when you + create a new Slack app. +2. Go to the "OAuth & Permissions" tab in the sidebar +3. Add your redirect URL. +4. Fill in the `oauth` block in your `config.yaml` file. Be sure to forward the `oauth.redirectUri` to the bridge. +5. Start a chat with the bot user (`@_slackpuppet_bot:domain.tld` unless you changed the config) +6. Tell the bot: `link` +7. Click the link it gives and allow access +8. Copy the token given and send the bot that token with: `link TOKEN_YOU_COPIED` + +### Option 3. xoxs token **Warning:**: Linking your `xoxs` account's token is against Slack's Terms of Service. First you must retrieve your `xoxs` token: Go to your slack customization page, e.g. https://my.slack.com/customize, and then open the debugging console @@ -76,7 +83,8 @@ After that, run: link ``` -### xoxc token + +### Option 4. xoxc token **Warning**: Linking your `xoxc` account's token is against Slack's Terms of Service. First you must retrieve your `xoxc` token: In the network manager, filter for type WS/WebSocket, and the `xoxc` token is there as URL parameter of that request. diff --git a/sample.config.yaml b/sample.config.yaml index 0b7b229..d626d89 100644 --- a/sample.config.yaml +++ b/sample.config.yaml @@ -12,7 +12,7 @@ bridge: # Reachable URL of the Matrix homeserver homeserverUrl: https://matrix.org -# Slack OAuth settings. Create a slack app at https://api.slack.com/apps +# Slack OAuth settings. See README.md for info on how to configure. oauth: enabled: false # Slack app credentials.