From 878c9c8290f7bec5fd5b2f16b144ba057f2cc411 Mon Sep 17 00:00:00 2001 From: Raj Joshi Date: Wed, 1 Jan 2025 21:26:28 -0500 Subject: [PATCH 1/4] :wrench: chore: cleanup slackd dev docs --- develop-docs/integrations/slack/index.mdx | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/develop-docs/integrations/slack/index.mdx b/develop-docs/integrations/slack/index.mdx index 4ce6f9fdaf8ab..c3d78cd34da1c 100644 --- a/develop-docs/integrations/slack/index.mdx +++ b/develop-docs/integrations/slack/index.mdx @@ -21,11 +21,13 @@ slack.client-secret: slack.signing-secret: ``` -**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and add `system.url-prefix: "https://.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. +If you a Sentry employee, you can set the `slack.client-id` and `slack.client-secret` in `devlocal.py` inside `getsentry` instead. -After you update the config.yml you need to restart your Sentry server to continue configuring the Slack app. +**NOTE**: If you're doing local Sentry development, you should use 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. - +After you update the config.yml or devlocal.py you need to restart your Sentry server to continue configuring the Slack app. + + After changing configuration files, re-run the ./install.sh script, to rebuild and restart the containers. See the configuration section for more information. @@ -112,8 +114,13 @@ Navigate to __Slash Commands__ under __Features__. Click __Create New Command__ | Setting | Value | | ------------------------------- | --------------------------------------------- | -| Command | `/sentry` | -| Request URL | `{YOUR_DOMAIN}/extensions/slack/commands/` | +| Command | `/{yourname}-sentry` | +| Request URL | `{YOUR_DOMAIN}/extensions/slack/commands/` | + + + + 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. + At the bottom of the page, click __Save__. From 39065cc17e5ee52c59e1e7bc5bfb7c3c9429c88c Mon Sep 17 00:00:00 2001 From: Raj Joshi Date: Wed, 1 Jan 2025 21:56:33 -0500 Subject: [PATCH 2/4] :wrench: chore: cleanup discord dev docs --- develop-docs/integrations/discord/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/integrations/discord/index.mdx b/develop-docs/integrations/discord/index.mdx index e5d586f918ddc..dd08ed551144c 100644 --- a/develop-docs/integrations/discord/index.mdx +++ b/develop-docs/integrations/discord/index.mdx @@ -28,7 +28,7 @@ discord.client-secret: "" discord.bot-token: "" ``` -**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and add `system.url-prefix: "https://.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. +**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and use `getsentry` repo when starting your Sentry server. Otherwise, installing the Discord bot won't work, as it will not be able to communicate with your local Sentry instance. After you update the config.yml, restart your Sentry server to continue the setup process. From c306f2f1da6f5e906c9efa502cd491eb4d50d804 Mon Sep 17 00:00:00 2001 From: Raj Joshi Date: Mon, 6 Jan 2025 13:59:35 -0500 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Alex Krawiec --- develop-docs/integrations/slack/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/integrations/slack/index.mdx b/develop-docs/integrations/slack/index.mdx index c3d78cd34da1c..05ad9175c16bc 100644 --- a/develop-docs/integrations/slack/index.mdx +++ b/develop-docs/integrations/slack/index.mdx @@ -21,7 +21,7 @@ slack.client-secret: slack.signing-secret: ``` -If you a Sentry employee, you can set the `slack.client-id` and `slack.client-secret` in `devlocal.py` inside `getsentry` instead. +If you're a Sentry employee, you can set the `slack.client-id` and `slack.client-secret` in `devlocal.py` inside `getsentry` instead. **NOTE**: If you're doing local Sentry development, you should use 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. From 4e7114ee4b9e7beb0e13453a144127ee4b62418a Mon Sep 17 00:00:00 2001 From: Raj Joshi Date: Mon, 6 Jan 2025 11:03:55 -0800 Subject: [PATCH 4/4] :wrench: chore: update the docs based on new ngrok setup --- develop-docs/integrations/discord/index.mdx | 2 +- develop-docs/integrations/slack/index.mdx | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/develop-docs/integrations/discord/index.mdx b/develop-docs/integrations/discord/index.mdx index dd08ed551144c..4dc07cbad7f48 100644 --- a/develop-docs/integrations/discord/index.mdx +++ b/develop-docs/integrations/discord/index.mdx @@ -28,7 +28,7 @@ discord.client-secret: "" discord.bot-token: "" ``` -**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and use `getsentry` repo when starting your Sentry server. Otherwise, installing the Discord bot won't work, as it will not be able to communicate with your local Sentry instance. +**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. After you update the config.yml, restart your Sentry server to continue the setup process. diff --git a/develop-docs/integrations/slack/index.mdx b/develop-docs/integrations/slack/index.mdx index 05ad9175c16bc..34c2e94290238 100644 --- a/develop-docs/integrations/slack/index.mdx +++ b/develop-docs/integrations/slack/index.mdx @@ -13,7 +13,7 @@ After naming your app and connecting your workspace, navigate to __Basic Informa Here’s where you’ll connect your self-hosted Sentry instance to your newly created Slack app. -Copy your Client ID, Client Secret, and Signing Secret and paste them into config.yml. +Copy your Client ID, Client Secret, and Signing Secret and paste them into `~/.sentry/config.yml` or `~/.sentry/sentry.conf.py`. ```yaml slack.client-id: @@ -23,9 +23,9 @@ slack.signing-secret: If you're a Sentry employee, you can set the `slack.client-id` and `slack.client-secret` in `devlocal.py` inside `getsentry` instead. -**NOTE**: If you're doing local Sentry development, you should use 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. +**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. -After you update the config.yml or devlocal.py you need to restart your Sentry server to continue configuring the Slack app. +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. After changing configuration files, re-run the ./install.sh script, to rebuild and restart the containers. See the configuration section for more information.