Skip to content

Commit 95b7e02

Browse files
🔧 chore: cleanup slack & msteams dev docs (#12235)
Co-authored-by: Alex Krawiec <[email protected]>
1 parent 29796de commit 95b7e02

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

‎develop-docs/integrations/discord/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ discord.client-secret: "<client secret>"
2828
discord.bot-token: "<bot token>"
2929
```
3030
31-
**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and add `system.url-prefix: "https://<your_subdomain>.ngrok.io"` to your `~/.sentry/config.yml`. Otherwise, installing the Discord bot won't work, as it will not be able to communicate with your local Sentry instance.
31+
**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok to expose your local Sentry instance to the internet. Otherwise, the OAuth2 Redirect URI will not work.
3232
3333
After you update the <code>config.yml</code>, restart your Sentry server to continue the setup process.
3434

‎develop-docs/integrations/slack/index.mdx‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,21 @@ After naming your app and connecting your workspace, navigate to __Basic Informa
1313

1414
Here’s where you’ll connect your self-hosted Sentry instance to your newly created Slack app.
1515

16-
Copy your Client ID, Client Secret, and Signing Secret and paste them into <code>config.yml</code>.
16+
Copy your Client ID, Client Secret, and Signing Secret and paste them into `~/.sentry/config.yml` or `~/.sentry/sentry.conf.py`.
1717

1818
```yaml
1919
slack.client-id: <client id>
2020
slack.client-secret: <client secret>
2121
slack.signing-secret: <signing secret>
2222
```
2323
24-
**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and add `system.url-prefix: "https://<your_subdomain>.ngrok.io"` to your `~/.sentry/config.yml`, otherwise, installing the Slack APP will complain because the redirect URI points to `localhost:8000`. Also, install the Slack integration from the ngrok subdomain or it will fail to install.
24+
If you're a Sentry employee, you can set the `slack.client-id` and `slack.client-secret` in `devlocal.py` inside `getsentry` instead.
2525

26-
After you update the <code>config.yml</code> you need to restart your Sentry server to continue configuring the Slack app.
26+
**NOTE**: If you're doing local Sentry development, you should usse ngrok and install the Slack integration from the ngrok subdomain or it will fail to install. Refer to [Developing with Ngrok](https://develop.sentry.dev/development-infrastructure/ngrok/) for more information.
2727

28-
<Alert title="Note" level="info">
28+
After you update the `config.yml`, `sentry.conf.py`, or `devlocal.py` you need to restart your Sentry server to continue configuring the Slack app.
29+
30+
<Alert title="Note (for self-hosted users)" level="info">
2931
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
3032
</Alert>
3133

@@ -112,8 +114,13 @@ Navigate to __Slash Commands__ under __Features__. Click __Create New Command__
112114

113115
| Setting | Value |
114116
| ------------------------------- | --------------------------------------------- |
115-
| Command | `/sentry` |
116-
| Request URL | `{YOUR_DOMAIN}/extensions/slack/commands/` |
117+
| Command | `/{yourname}-sentry` |
118+
| Request URL | `{YOUR_DOMAIN}/extensions/slack/commands/` |
119+
120+
121+
<Alert title="Note" level="info">
122+
When creating the slash command, don’t use `/sentry`. Do something like `/{your_name}-sentry`. If multiple apps are installed with the same slash command, the most recently installed one takes over.
123+
</Alert>
117124

118125
At the bottom of the page, click __Save__.
119126

0 commit comments

Comments
 (0)