Slack-Benachrichtigungen mit dem Plugin discourse-chat-integration einrichten

Diese howto beschreibt, wie der in discourse-chat-integration enthaltene Slack-Anbieter eingerichtet wird.

Er ermöglicht das Posten von Benachrichtigungen in Slack, die Verwaltung von Regeln über Slash-Befehle und das Zurückposten von Transkripten an Discourse. Anweisungen für Slash-Befehle finden Sie, indem Sie /discourse help eingeben. Transkripte können über die Kontextmenüs in Slack-Beiträgen erstellt werden.

Installieren

Falls noch nicht geschehen, installieren Sie das Plugin discourse-chat-integration und stellen Sie sicher, dass es über die Site-Einstellung chat integration enabled aktiviert ist.

Slack einrichten

  1. Gehen Sie zu Slack API: Applications | Slack und erstellen Sie eine neue App. Wenn Sie noch nicht angemeldet sind, werden Sie dazu aufgefordert. (Möglicherweise müssen Sie erneut auf diesen Link klicken, da er nach dem Anmelden scheinbar nicht weiterleitet :frowning: )

  2. Klicken Sie auf Create New App

  3. Wählen Sie einen Namen (kann beliebig sein) und wählen Sie das Slack-Team aus, zu dem es gehören soll

  4. Klicken Sie im linken Menü unter „Features“ auf „OAuth & Permissions“.

  5. Scrollen Sie zu „Scopes / Bot Token Scopes“ und fügen Sie jeden der folgenden hinzu, um dem Plugin das Senden von Nachrichten an Ihren Slack-Workspace zu ermöglichen:

    • chat:write
    • chat:write.customize
  1. Gehen Sie zur Seite Einstellungen → Install App, klicken Sie auf Install to Workspace und autorisieren Sie die App für Ihr Team

  2. Kopieren Sie das Bot User OAuth Token und fügen Sie es in Ihren Discourse-Site-Einstellungen unter chat_integration_slack_access_token ein

  3. Gehen Sie zur Seite Basic Information, kopieren Sie das Verification Token und fügen Sie es in Ihren Discourse-Site-Einstellungen unter chat_integration_slack_incoming_webhook_token ein

  4. Unten auf der Seite Basic Information können Sie das Icon, den Namen und die Beschreibung Ihres Bots festlegen.

  5. Richten Sie einige „Rules“ für Ihre Kanäle ein, gemäß den Anweisungen zu discourse-chat-integration, oder verwenden Sie alternativ die Slash-Befehle in einem Kanal, um loszulegen.

  6. Fügen Sie den Discourse-Bot-Benutzer zu den Kanälen hinzu, in die er posten soll:

Fehlerbehebung

/discourse Slash-Befehl gibt dispatch_failed-Fehler zurück

Symptom

Nach der Konfiguration der Slack-Integration versuchen Sie den Slash-Befehl /discourse und sehen die folgende Fehlermeldung in Slack:

/discourse failed with the error "dispatch_failed"

Ursache

Dies liegt wahrscheinlich an einem Konfigurationsfehler. Überprüfen Sie, ob der von Ihnen konfigurierte Wert für Request URL korrekt ist. Er sollte in dieser Form vorliegen:

<your-discourse-url>/chat-integration/slack/command

Behebung

Aktualisieren Sie Ihre Request URL und achten Sie besonders auf Folgendes:

  1. Stellen Sie sicher, dass sie mit dem korrekten Protokoll beginnt (z. B. https://)
  2. Stellen Sie sicher, dass sie die Domain Ihrer Discourse-Site verwendet (nicht Ihre Slack-Instanz)
  3. Stellen Sie sicher, dass sie den korrekten Pfad /chat-integration/slack/command hat
33 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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

2 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“

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 „Gefällt mir“