discourse-chat-integration プラグインを使用した Slack 通知の設定

この howto では、discourse-chat-integration に含まれる Slack プロバイダーの設定方法を説明します。

これにより、Slack に通知を投稿したり、スラッシュコマンドを使用してルールを管理したり、トランスクリプトを Discourse に投稿したりできます。スラッシュコマンドの手順は、/discourse help と入力することで確認できます。トランスクリプトは、Slack の投稿のコンテキストメニューを使用して作成できます。

インストール

まだの場合、discourse-chat-integration プラグインをインストールし、サイト設定の chat integration enabled で有効になっていることを確認してください。

Slack の設定

  1. Slack API: Applications | Slack に移動し、新しいアプリを作成します。まだログインしていない場合は、ログインを求められます。(ログイン後にリダイレクトされないようなので、このリンクをもう一度クリックする必要があるかもしれません :frowning:

  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 ボットユーザーを追加します。

    • Slack クライアントページの左側のメニューから、アプリを追加したいチャンネル名を右クリックし、「View Channel Details」をクリックします。
    • ポップアップウィンドウから、「Integrations」タブを選択します。
    • Integrations ページで、「Add an App」をクリックし、Discourse Bot を選択します。
    • これで、アプリがそのチャンネルに投稿できるようになります。

トラブルシューティング

/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. Slack インスタンスではなく、Discourse サイトのドメインを使用していることを確認します。
  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