diff --git a/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credential-form.png b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credential-form.png new file mode 100644 index 000000000..0b97be58a Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credential-form.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credentials.png b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credentials.png new file mode 100644 index 000000000..ddf245eff Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credentials.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-summary.png b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-summary.png new file mode 100644 index 000000000..95e9fe4ba Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-summary.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-workspace-select.png b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-workspace-select.png new file mode 100644 index 000000000..0c047ab1a Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-app-workspace-select.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-create-app.png b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-create-app.png new file mode 100644 index 000000000..502dbde0a Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-create-app.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-overview.png b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-overview.png new file mode 100644 index 000000000..54ad6ca6e Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/admin-slack-integration-overview.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/org-slack-integration-add-form.png b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-add-form.png new file mode 100644 index 000000000..97b38d6e4 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-add-form.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/org-slack-integration-authenticate.png b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-authenticate.png new file mode 100644 index 000000000..166e5849f Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-authenticate.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/org-slack-integration-created.png b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-created.png new file mode 100644 index 000000000..f46f61d89 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-created.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/org-slack-integration-initial-add.png b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-initial-add.png new file mode 100644 index 000000000..5bd66d932 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-initial-add.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/org-slack-integration-overview.png b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-overview.png new file mode 100644 index 000000000..1f7386559 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-overview.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/org-slack-integration-workspace.png b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-workspace.png new file mode 100644 index 000000000..042ad1b77 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/org-slack-integration-workspace.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/project-slack-integration-config.png b/docs/images/self-hosting/guides/slack-integration/project-slack-integration-config.png new file mode 100644 index 000000000..c6dd70ad7 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/project-slack-integration-config.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/project-slack-integration-overview.png b/docs/images/self-hosting/guides/slack-integration/project-slack-integration-overview.png new file mode 100644 index 000000000..944db9cca Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/project-slack-integration-overview.png differ diff --git a/docs/images/self-hosting/guides/slack-integration/project-slack-integration-select.png b/docs/images/self-hosting/guides/slack-integration/project-slack-integration-select.png new file mode 100644 index 000000000..073d3fd93 Binary files /dev/null and b/docs/images/self-hosting/guides/slack-integration/project-slack-integration-select.png differ diff --git a/docs/mint.json b/docs/mint.json index b56493e01..13599b174 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -247,7 +247,8 @@ "pages": [ "self-hosting/configuration/schema-migrations", "self-hosting/guides/mongo-to-postgres", - "self-hosting/guides/custom-certificates" + "self-hosting/guides/custom-certificates", + "self-hosting/guides/slack-integration" ] }, { diff --git a/docs/self-hosting/guides/slack-integration.mdx b/docs/self-hosting/guides/slack-integration.mdx new file mode 100644 index 000000000..791a591ad --- /dev/null +++ b/docs/self-hosting/guides/slack-integration.mdx @@ -0,0 +1,82 @@ +--- +title: "Slack integration" +description: "Learn how to setup Slack integration in your self-hosted instance." +--- + +This guide will provide step by step instructions on how to configure Slack integration for your Infisical projects. + +## Configure admin settings + +Note that this step only has to be done once for the entire instance. + + + + Before anything else, you need to setup the Slack app to be used by + your Infisical instance. Because you're self-hosting, you will need to + create this Slack application as demonstrated in the preceding step. + ![admin-settings-slack-overview](/images/self-hosting/guides/slack-integration/admin-slack-integration-overview.png) + + + Click the "Create Slack app" button. This will open up a new window with the + custom app creation flow on Slack. + ![admin-slack-create-app](/images/self-hosting/guides/slack-integration/admin-slack-integration-create-app.png) + + Select the Slack workspace you want to integrate with Infisical. + + ![admin-slack-app-workspace-select](/images/self-hosting/guides/slack-integration/admin-slack-integration-app-workspace-select.png) + + The configuration values of your custom Slack app will be pre-filled for you. You can view or edit the app manifest by clicking **Edit Configurations**. + ![admin-slack-app-summary](/images/self-hosting/guides/slack-integration/admin-slack-integration-app-summary.png) + + Once everything's confirmed, press Create. + + + + Copy the Client ID and Client Secret values from your newly created custom Slack app and add them to Infisical. + ![admin-slack-app-credentials](/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credentials.png) + ![admin-slack-app-credentials-form](/images/self-hosting/guides/slack-integration/admin-slack-integration-app-credential-form.png) + Complete the admin setup by pressing Save. + + + +## Create Slack workflow integration + + + + In order to use Slack integration in your projects, you will first have to + configure a Slack workflow integration in your organization. + ![org-slack-overview](/images/self-hosting/guides/slack-integration/org-slack-integration-overview.png) + + + Press "Add" and select "Slack" as the platform. + ![org-slack-initial-add](/images/self-hosting/guides/slack-integration/org-slack-integration-initial-add.png) + + Give your Slack integration a descriptive alias. You will use this to select the Slack integration for your project. + ![org-slack-add-form](/images/self-hosting/guides/slack-integration/org-slack-integration-add-form.png) + + Press **Connect Slack**. This opens up the Slack app installation flow. Select the Slack workspace you want to install the custom Slack app to and press **Allow**. + ![org-slack-authenticate](/images/self-hosting/guides/slack-integration/org-slack-integration-authenticate.png) + + Your Slack bot will then be added to your selected Slack workspace. This completes the workflow integration creation flow. Your projects in the organization can now use this Slack integration to send real-time updates to your Slack workspace. + ![org-slack-workspace](/images/self-hosting/guides/slack-integration/org-slack-integration-workspace.png) + ![org-slack-created](/images/self-hosting/guides/slack-integration/org-slack-integration-created.png) + + + + +## Configure project to use Slack workflow integration + + + + ![project-slack-overview](/images/self-hosting/guides/slack-integration/project-slack-integration-overview.png) + + + Your project will send notifications to the connected Slack workspace of the + selected Slack integration when the configured events are triggered. + ![project-slack-select](/images/self-hosting/guides/slack-integration/project-slack-integration-select.png) + + + ![project-slack-select](/images/self-hosting/guides/slack-integration/project-slack-integration-config.png) + You now have a working native integration with Slack! + +