Przeglądaj źródła

Update and rename setting-up-slack-locally.md to slack-integration.md

abelanger5 4 lat temu
rodzic
commit
e4b62475cc

+ 0 - 25
docs/guides/setting-up-slack-locally.md

@@ -1,25 +0,0 @@
-# Setting Up Slack Locally
-
-For local versions of porter, one might want to have a slack notification bot running locally.
-This tutorial will run you through the steps of setting up a bot with these capabilities:
-
-## Step 1: Create Application and environment variables
-
-Navigate to [https://api.slack.com/apps](), and click "Create New App" in the to right. On the modal that pops up, select
-"from scratch" and then enter in your app name and workspace you want to develop in. On the page for the application
-scroll down to "App Credentials" and take note of the following two values:
-
-<img width="689" alt="Screen Shot 2021-08-09 at 10 25 41 AM" src="https://user-images.githubusercontent.com/25856165/128722685-28bd99c5-3a28-43cb-b002-356f6963a682.png">
-
-Copy these values into the following environment variables in your local installation:
-```
-SLACK_CLIENT_ID=<client-id-above>
-SLACK_CLIENT_SECRET=<client-secret-above>
-```
-
-## Step 2: Setting up oauth
-
-The app also needs to be able to perform the oauth flow with the right callback link. To do this, 
-navigate to "OAuth & Permissions" and add the url `https://yourdomain.com/api/oauth/slack/callback` to the list of 
-redirect URLs:
-![image](https://user-images.githubusercontent.com/25856165/128723683-c4fb2ac4-e0df-4989-9224-08806aadcb26.png)

+ 25 - 0
docs/guides/slack-integration.md

@@ -0,0 +1,25 @@
+# Enabling Slack Integrations
+
+For order to set up a Slack integration on a self-hosted version of Porter, you must create a new Slack app in your workspace for sending Porter notifications. 
+
+## Step 1: Create Application and Environment Variables
+
+Navigate to [https://api.slack.com/apps](https://api.slack.com/apps), and click **Create New App**. On the modal that pops up, select **From Scratch** and then enter your app name and workspace you want to develop in. On the page for the application, scroll down to **App Credentials** and take note of the following two values:
+
+<img width="689" alt="Screen Shot 2021-08-09 at 10 25 41 AM" src="https://user-images.githubusercontent.com/25856165/128722685-28bd99c5-3a28-43cb-b002-356f6963a682.png">
+
+Copy these values into the following environment variables in your installation:
+
+```
+SLACK_CLIENT_ID=<client-id-above>
+SLACK_CLIENT_SECRET=<client-secret-above>
+```
+
+## Step 2: Setting up OAuth
+
+The app also needs to be able to perform the OAuth flow with the right callback link. To do this, 
+navigate to **OAuth & Permissions** in the Slack developer settings and add the url `https://yourdomain.com/api/oauth/slack/callback` to the list of redirect URLs:
+
+![image](https://user-images.githubusercontent.com/25856165/128723683-c4fb2ac4-e0df-4989-9224-08806aadcb26.png)
+
+That's it! You can now follow [this guide](https://docs.porter.run/docs/setting-up-slack-notifications) for setting up Slack notifications in Porter.