使用 discourse-chat-integration 插件设置 Slack 通知

howto 描述了如何设置 discourse-chat-integration 中包含的 Slack provider。

它允许向 Slack 发帖通知,使用斜杠命令(Slash Commands)管理规则,并将记录(transcripts)发布回 Discourse。斜杠命令的说明可以通过输入 /discourse help 找到。记录可以通过 Slack 帖子上的上下文菜单创建。

安装

如果您还没有安装,请安装 discourse-chat-integration 插件,并确保通过 chat integration enabled 站点设置启用它。

设置 Slack

  1. 前往 Slack API: Applications | Slack 并创建一个新的应用。如果您尚未登录,系统会提示您登录。(您可能需要再次点击此链接,因为它在登录后似乎不会重定向 :()

  2. 点击 Create New App

  3. 选择一个名称(可以是任何名称),然后选择您希望它所属的 Slack 团队

  4. 在左侧菜单的“Features”下,点击“OAuth & Permissions”。

  5. 向下滚动到“Scopes / Bot Token Scopes”,并添加以下每一项以允许插件向您的 Slack 工作区发布消息:

    • chat:write
    • chat:write.customize
  1. 转到设置 > Install App 页面,点击 Install to Workspace,并授权应用使用您的团队

  2. 复制 Bot User OAuth Token,并将其粘贴到 Discourse 站点设置中的 chat_integration_slack_access_token

  3. 转到 Basic Information 页面,复制 Verification Token,并将其粘贴到 Discourse 站点设置中的 chat_integration_slack_incoming_webhook_token

  4. Basic Information 页面的底部,您可以设置机器人的图标、名称和描述。

  5. 根据 discourse-chat-integration 的说明设置一些频道的“规则”,或者在频道内使用斜杠命令开始设置。

  6. 将 Discourse 机器人用户添加到它能发布到的频道:

故障排除

/discourse 斜杠命令返回 dispatch_failed 错误

症状

配置 Slack 集成后,您尝试使用 /discourse 斜杠命令并在 Slack 中看到以下错误:

/discourse failed with the error "dispatch_failed"

原因

这很可能是由于配置错误。请验证您为 Request URL 配置的值是否正确。它应该采用以下格式:

\u003cyour-discourse-url\u003e/chat-integration/slack/command

修复

更新您的 Request URL,并特别注意以下几点:

  1. 确保它以正确的协议开头(例如 https://
  2. 确保它使用的是您的 Discourse 站点的域名(而不是您的 Slack 实例)
  3. 确保它具有正确的路径 /chat-integration/slack/command
33 个赞

I’m very excited to try this plugin. I gave installing it a shot by following these instructions carefully, but when I go to test a slash command on slack I get:

slackbot Darn - that slash command didn't work (error message: `403_client_error`). Manage the command at Discourse Integration.

This would suggest that it’s an issue with the authentication of slack to your Discourse instance. Can you double check that the incoming webhook token has been copied across correctly? (step 12 above) Make sure there’s nothing weird being copied before/after (e.g. spaces)

Also, it seems Slack’s App config tools are subject to refinement as a details in this howto have changed.

  1. in step 4:
  • was “Under features and Functionality” select “Permissions”
  • now is “Under Features” select “OAuth & Permissions”
  1. in step 6: would be good to clarify “Under Features, select ‘Slash Commands’”, same with step 8 “Under Features, select ‘Interactive Messages’”

Thanks for building and sharing this plugin!

Ugh, I went through the instructions twice, and realized I copied the verification token incorrectly. My issue was completely PEBKAC :(- thanks for the (immediate) help!

1 个赞

Thanks - I’ve updated the two things you mentioned, and converted the first post to a wiki. Please feel free to update if you notice anything else.

No problem - glad it’s working :smiley:

3 个赞

re: rule generation. The help doc states:


New rule: /discourse [watch|follow|mute] [category] [tag:name]
(you must specify a rule type and at least one category or tag)

  • watch – notify this channel for new topics and new replies
  • follow – notify this channel for new topics
  • mute – block notifications to this channel

The integration doesn’t seem to be able to find tags.
edit: Ugh… I just saw the docs that the syntax for tags is [tag:name] :facepalm: … sorry I missed that…

I noticed that the help files are hard coded to the slash command “/discourse”… I pulled down the source and got as far as finding the strings in the locale files and where they’re invoked in the helper. I would like to issue a PR to allow the slash command in help files to be configurable (my integration uses my sitename as the command…) but I’m not sure how persistence works with Discourse plugins. If I submitted a partially complete PR would you be able to provide some pointers or would that be a waste of time ?

Also, where would be the best place to add feature requests ?

2 个赞

The easiest way to change this to a different command is to go to your discourse admin panel, Customize Text Content, then type chat_integration.provider.slack into the search bar. You’ll find the “help” string in this list. Changes to this should persist across discourse/plugin updates

I think slack-specific ones in this topic, and general ones for the plugin in the main topic :slight_smile:

1 个赞

Wow. That’s pretty sweet - no code changes necessary. (I’m pretty new to Discourse but it seems pretty badass!)

2 个赞

What am I missing? When I try that, I get

“Sorry, this integration isn’t setup to support posting transcripts.”

Did I miss something? Is the feature available only to some Slack communities and not the free ones?

You need to use the “OAUTH Token” method of authentication to slack, not the “Webhook” method. The instructions above should walk you through setting up the oauth method.

4 个赞

That did it. I think I broke it by foolishly trying to migrate the settings from the other slack plugin.

One thing I don’t understand is who can use the slack App I created. It is just me? If so, that’s a little sucky. If not, wait, anyone can control what categories get watched? I see “collaborators” in the slack API page. If I add a collaborator can they too control the rules?

Also, it seems that rules established in the Discourse web interface don’t show up in slack if you do a /discourse status. Is that right?

1 个赞

When you create slack apps, they are private to you. Only you can edit the settings of the app, and only you can install it onto an organisation. Notice the “Not Distributed” status:
51
You can then install your app onto your Slack organisation. If you have slash commands set up, anyone in that organisation can control the ‘rules’ for any channel they have access to, and so you should make sure to set the chat integration discourse username appropriately.

‘Collaborators’ of the Slack app means that they can edit the app’s settings (things like callback URLs, auth secrets etc.). It has absolutely nothing to do with who can configure ‘rules’ using slash commands.

/discourse status should list all of the rules for the current channel. So if you have set up rules for #general using the discourse admin interface, they should show up when you run /discourse status in #general. If that’s not working, it’s a bug.

7 个赞

Thanks, @david, that’s a huge help. It still seems a bit wild that any slack user can change what Discourse stuff gets posted to a channel, but I suspect that’s because I don’t understand slack.

I think it depends what kind of community you have in Slack. In my mind there are three main scenarios:

  • If any member of the public can join your Slack organisation, Slash commands probably aren’t a good idea. In this case it’s probably easiest to just manage the rules from the discourse admin panel.

  • If you have a fairly open forum, but a closed slack organisation (like I believe the discourse team do), then having slash commands is a nice convenience without any real issue (everyone in slack is trusted).

  • If you have a roughly 1:1 mapping between forum members and slack members (e.g. a corporate environment), it can be useful to allow individuals to manage the rules in their own slack channel. For example, the dev team might want to watch dev, and the support team support. Rather than forcing all this to be done by a discourse admin, they can do it themselves with slash commands. I think this is how @mcwumbly uses slack integration.

10 个赞

We’re starting to see some healthy adoption of Slack threads in some channels. I was a big skeptic at first, but as people find good patterns for using them, I can see their value. Does the transcript feature work with threads at all?

4 个赞

That’s great to hear - I was a little skeptical how useful it would be as well, so glad to hear people like it :slight_smile:

Sadly not. I don’t know if the slack API allows loading messages from a specific thread, so we might need to do the filtering on the Discourse end.

8 个赞

Should transcript export work with Direct Messages? I just tried with two different ones and it’ll say Loading the transcript... but nothing happens after that.

2 个赞

I’m getting the same thing, and have checked my access and webhook tokes very carefully. Other things to try?

Also - is it possible to connect Discourse to multiple Slack orgs?

3 个赞