diff --git a/slackme/README.md b/slackme/README.md index 1106b25..57a5de2 100644 --- a/slackme/README.md +++ b/slackme/README.md @@ -19,49 +19,49 @@ slackme npm run long-build 1. Navigate to [Create a Slack App](https://api.slack.com/apps?new_app=1) and select "From an app manifest". Select a workspace and paste in the following manifest, adjusting the redirect URL to your Coder deployment: - ```json - { - "display_information": { - "name": "Command Notify", - "description": "Notify developers when commands finish running inside Coder!", - "background_color": "#1b1b1c" - }, - "features": { - "bot_user": { - "display_name": "Command Notify" - } - }, - "oauth_config": { - "redirect_urls": [ - "https:///external-auth/slack/callback" - ], - "scopes": { - "bot": ["chat:write"] - } - } - } - ``` + ```json + { + "display_information": { + "name": "Command Notify", + "description": "Notify developers when commands finish running inside Coder!", + "background_color": "#1b1b1c" + }, + "features": { + "bot_user": { + "display_name": "Command Notify" + } + }, + "oauth_config": { + "redirect_urls": [ + "https:///external-auth/slack/callback" + ], + "scopes": { + "bot": ["chat:write"] + } + } + } + ``` 2. In the "Basic Information" tab on the left after creating your app, scroll down to the "App Credentials" section. Set the following environment variables in your Coder deployment: - ```env - CODER_EXTERNAL_AUTH_1_TYPE=slack - CODER_EXTERNAL_AUTH_1_SCOPES="chat:write" - CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="Slack Me" - CODER_EXTERNAL_AUTH_1_CLIENT_ID=" - CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="" - ``` + ```env + CODER_EXTERNAL_AUTH_1_TYPE=slack + CODER_EXTERNAL_AUTH_1_SCOPES="chat:write" + CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="Slack Me" + CODER_EXTERNAL_AUTH_1_CLIENT_ID=" + CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="" + ``` 3. Restart your Coder deployment. Any Template can now import the Slack Me module, and `slackme` will be available on the `$PATH`: - ```hcl - module "slackme" { - source = "registry.coder.com/modules/slackme" - version = "1.0.0" - agent_id = coder_agent.example.id - auth_provider_id = "slack" - } - ``` + ```hcl + module "slackme" { + source = "registry.coder.com/modules/slackme" + version = "1.0.0" + agent_id = coder_agent.example.id + auth_provider_id = "slack" + } + ``` ## Examples