Discord Bot Bausatz 🤖

[merefield (Robert)]

Zweck dieses Plugins

Dieses Plugin übernimmt mehrere Aufgaben:

1. Es ermöglicht dir, einen Discord-Bot über deinen Discourse-Server zu steuern, um verschiedene Aktionen zur Verknüpfung der beiden Systeme durchzuführen. Fork diesen Repository und erweitere ihn mit einfachem Ruby, um diverse Bot-Funktionen zu erstellen.

2. Bestehende Funktionen dienen als Beispiele und nützliche Hilfsprogramme:

• Automatisierte Zwei-Wege-Veröffentlichung von Inhalten, die bestimmte Kriterien erfüllen.
• Befehl zum manuellen Kopieren von Nachrichten nach Discourse.
• Befehl zum Synchronisieren der Gruppenmitgliedschaft mit der Rollenmitgliedschaft deines Discord-Servers und deiner Discourse-Instanz.

Das Plugin stellt ein erweiterbares Grundgerüst bereit, auf dem du weitere Funktionen aufbauen kannst. Pull Requests für allgemein nützliche Erweiterungen sind willkommen.

^{dies sind nicht die beiden Sync-Befehle, sondern nur eine Illustration der möglichen Bot-Interaktion. Der zweite Befehl im Screenshot wurde während der Entwicklung veraltet}

Die Einrichtung ist zwangsläufig komplex, aber ideal für Fans beider Systeme, die bereit sind, Zeit in das Verständnis der Funktionsweise jedes Systems zu investieren – zumindest auf funktionaler und konzeptioneller Ebene. Um das Beste aus diesem Plugin herauszuholen, musst du einige Grundlagen der Benutzerverwaltung in Discourse und Discord verstehen.

Bot-Befehle

Es gibt vier Befehle:

1. Ping!
2. !disckick
3. !discsync
4. !disccopy

Ping!

Um zu prüfen, ob der Bot antwortet, tippe einfach „Ping!" ein. Der Bot sollte dann mit „ : Pong!" antworten – großartig, oder? (das ist übrigens ein kleiner Meme!)

!disckick <min_trust_level: Standard 2>

Mit diesem Befehl werden alle Benutzer gekickt, die auf Discourse existieren, aber ein Vertrauenslevel unter dem angegebenen Wert haben. Wenn kein Wert angegeben wird, beträgt der Standardwert 2.

Beispiel:

!discsync <clean up: Standard false, min_visibility: Standard 0, include automated groups: Standard false>

Dieser Befehl versucht, alle Gruppen in Discord-Rollen zu kopieren, die den angegebenen Kriterien (oder den Standardwerten, falls keine angegeben wurden) entsprechen. Anschließend werden die Rollen entsprechend der Gruppenmitgliedschaft in Discourse aufgefüllt. Es handelt sich hierbei um eine einseitige Synchronisation. Keine Discourse-Daten werden dabei verändert.

!disccopy <number_of_messages> <optional_target_category_name> <optional_target_topic_name>

Ermöglicht das Kopieren des Discord-Nachrichtenverlaufs in deine Discourse-Instanz direkt aus dem Discord-Chat heraus. Dies kann Tausende von Nachrichten auf einmal verarbeiten (für dieses Volumen wird jedoch Zeit benötigt).

Zwei-Wege-Kommunikation

Hier sind die Einstellungen:

• Du kannst einen Ankündigungs-Kanal auf Discord in den Plugin-Einstellungen festlegen.
• Du kannst nun in den zugewiesenen Discord-Ankündigungs-Kanal schreiben, und deine Nachricht wird im zugewiesenen Discourse-Thema in den Plugin-Einstellungen veröffentlicht.
• Du kannst eine Liste von Kategorien in Discourse einrichten, um Nachrichten an den Ankündigungs-Kanal auf deinem Discord zu senden, wenn dort jemand postet oder ein neues Thema erstellt (entweder oder beides).
• Automatisierte Kopie von Chat-Nachrichten pro Kanal in eine gleichnamige Kategorie auf Discourse: Wenn der Kanalname mit dem Kategoriennamen übereinstimmt, wird die Nachricht in Discourse kopiert.

Zusätzlich habe ich eine neue Datei hinzugefügt, um Discord-Ereignisse zu verwalten, die von der discordrb-API unterstützt werden, wobei die Ankündigungslogik das erste Beispiel ist (du kannst gerne neue entwickeln und Pull Requests einreichen, wenn sie für die Gemeinschaft nützlich sind).

Hinweis: Für jede aus Discord nach Discourse kopierte Nachricht wird der Benutzer korrekt angezeigt, wenn dieser Benutzer sich über die Discord-Anmeldung bei Discourse eingeloggt hat (so kann der Discord-Bot die Benutzer zuordnen).

Status dieses Plugins

Dies ist ein komplexes Plugin zur Einrichtung. Das war leider unvermeidbar.

Sobald es jedoch eingerichtet und in Betrieb ist, ist die Bedienung ein Kinderspiel.

Betrachte den Code derzeit als Beta. Er wurde getestet, sogar in der Produktion, enthält aber wahrscheinlich noch Fehler. Ich empfehle, dies zunächst auf einem frischen Discord-Server zu testen, bevor du es auf deinen „Produktions"-Haupt-Discord-Server anwendest, es sei denn, du fängst gerade erst an.

Fehler sind viel wahrscheinlicher, um deine Discord-Instanz zu stören als deine Discourse-Instanz, da keine Änderungen an Discourse vorgenommen werden. Allerdings habe ich es so geschrieben, dass die meisten Dinge wiederherstellbar sind und du ein Problem meist einfach durch Wiederholen der Aktion beheben kannst. Discourse dient als Master für Mitgliedschafts- und Gruppeninformationen, und diese Daten werden verwendet, um die Mitgliedschaft und Rollen auf deinem Discord-Server zu aktualisieren.

Einrichtungshinweise

Voraussetzungen

1. Ein Discord-Server, auf dem du Administrator bist.
2. Eine Discord-App (siehe unten).
3. Ein Discord-Bot (siehe unten).
4. SSH-Root-Zugriff auf deinen Discourse-Server.
5. Änderungen an app.yml zur Installation des Plugins.
6. Alle Benutzer deines Discourse müssen sich mit der Discord-OAuth-Anmeldung anmelden, die auf deiner Anmeldeseite erscheint, sobald das Plugin installiert ist.

Discord-App

Gehe hierhin und erstelle eine App:

Discord for Developers

Klicke auf „New Application".

Du musst einen Bot erstellen, der ungefähr so aussieht (lass ihn nicht „öffentlich"):

Du musst den Bot im Browser autorisieren, siehe OAuth2 - Documentation - Discord

Sobald der Bot eingerichtet ist, kopiere das Token. Du musst dies später in Discourse eingeben.

Änderungen an app.yml

Plugin

Du benötigst jetzt nur noch ein Plugin, da die Discord-Social-Login-Funktion nun nativer Bestandteil des Discourse-Kerns ist (Juhu )

GitHub - merefield/discourse-discord-bot: A Discord bot that runs on your Discourse server...

Dann führe am Prompt wie üblich ./launcher rebuild app aus.

Das sollte funktionieren, kein Problem.

Möglicherweise erhältst du einige Console- und Log-Fehler, die auf einen Fehler des Bots beim ersten Build hinweisen, da du die Zugangsdaten des Bots noch nicht in der Benutzeroberfläche der Discourse-Einstellungen eingegeben hast. (Die elegantere Handhabung dessen steht noch an, ich werde diesen Teil löschen, sobald das erledigt ist). Es tut jedoch keinen Schaden, und Discourse selbst funktioniert normal.

Gehe in deinem Discourse-Admin-Bereich zu den Plugin-Einstellungen und fülle diese aus:

Die IDs erhältst du über die Discord-Oberfläche. Du musst den Entwicklermodus aktivieren, um diese IDs kopieren zu können. Gehe in Discord zu deinen Einstellungen → Erscheinungsbild → ERWEITERT und aktiviere den Entwicklermodus:

Du kannst dann IDs aus der Oberfläche abrufen, z. B.:

Du musst auch die Discord-OAuth-Einstellungen ausfüllen. Die Client-ID und das Geheimnis stammen aus derselben Discord-App.

Sobald du diese Einstellungen vorgenommen hast, gehe zurück zu deinem Root-Prompt in Linux und tippe ein:

./launcher restart app

Wenn du deine Discord- und Discourse-Server korrekt eingerichtet hast, solltest du sehen, wie der Bot dem Server beitritt.

Falls der Bot jemals abstürzt (er geht offline), musst du dasselbe erneut tun, um ihn wiederherzustellen. Eine verbesserte Unabhängigkeit des Bots vom Discourse-Kernserver steht noch an. Dennoch habe ich einen Bot längere Zeit in der Produktion betrieben, und er ist noch nie abgestürzt.

Zukünftige Befehle?

Wenn du eine Idee für einen weiteren Befehl hast, der die Verbindung zwischen Discourse und Discord nutzt und deiner Meinung nach für die breitere Gemeinschaft nützlich wäre, lass es mich in den Antworten wissen, und wir können prüfen, ob eine Implementierung möglich ist. Hinweis: Dieser Bot soll keine Aufgaben außerhalb des Discourse-Umfangs ausführen.

Einschränkungen

Das Hauptziel dieses Plugins war es, dem Benutzer die Möglichkeit zu geben, einen Bot auf seinem Discord zu erstellen, der von seinem Discourse-Server gesteuert wird und grundlegende Funktionen zur Mitgliedschaftsverwaltung ausführen kann. Es bietet auch eine Grundlage für weitere botähnliche Interaktionen zwischen den beiden Systemen für die Zukunft. Ein Teil der Motivation für die Verwendung von Bots ist, dass sie einfach Spaß machen.

Bot-Befehle sind von Natur aus manuell/ad hoc.

Bekannte Probleme

• Der Bot startet eine eigene Instanz, wenn du eine Rails-Console-Sitzung auf dem Server beginnst. Dies führt dazu, dass der Bot doppelt zu antworten scheint (tatsächlich gibt es dann zwei Bots). Stoppe im Rails-Console einfach den zusätzlichen Bot, indem du eingibst: ::DiscordBot::Bot.discord_bot.stop Dies sollte nun nicht mehr notwendig sein!

• Der Roboter ist während „online" Discourse-Upgrades etwas gesprächig, da er während des Upgrade-Prozesses ständig neu aktiviert wird. Dies führt zurück zu der Frage, wie man den Bot in einem separaten, verwalteten Prozess statt in einem vom Webserver abgezweigten Thread ausführt. Ich glaube jedoch, dass dies alles harmlos ist, und wenn die Ausgabe des Bots nur in deinen Admin-Kanal auf Discord geht, macht es dir wirklich etwas aus? Dies sollte jetzt so gut wie gelöst sein, wobei der Bot sich während eines Neubuilds nur zweimal anmeldet.

Dank

Es gibt mehrere Unterstützer, die für dieses Plugin zu danken sind, das mich eine Weile bis zu diesem Stadium gebracht hat, darunter @Wedgebert, @FoohonPie. Danke an Jeff für seinen großzügigen Beitrag. Danke an @angus für die ganze Ermutigung und die Bewältigung der finanziellen Unterstützung.

Das Plugin wurde von der Arbeit inspiriert, die @Watercolor_Games in einer früheren Phase geleistet hat, und basiert auf dem von @featheredtoast entwickelten Discord-OAuth-Plugin.

Das Plugin basiert auf der halb-offiziellen, von Discord unterstützten discordrb Ruby-Bibliothek und der fantastischen Arbeit, die das Discord-Team geleistet hat, um ihr System zugänglich zu machen. Danke an @Falco, der mir in äußerst reaktionsschneller Weise bei einer Abhängigkeit geholfen hat.

Außerdem wäre dies natürlich ohne das erstaunliche Plugin-Ökosystem von Discourse nicht möglich (Juhu!).

Status dieser Anleitung

Sie werden im Laufe der Zeit verbessert, und ich freue mich über Feedback. Es gibt Bereiche, die zweifellos unklar sein werden.

[Owen_Walters]

Hey I’m super interested in this.

@merefield

!discsync <clean up: default false, min_visibility: default 0, include automated groups: default false>

This command will attempt to copy over all groups into Roles on Discord which match provided criteria (or defaults if not provided). It will then attempt to populate the roles as per the Group membership on Discourse. It’s a one way sync only. No Discourse data is ever changed.

Would the opposite be possible? I’d love a way to be able to create a Discourse setup for my Discord server. I’m not sure if there’s a Discord API event for roles being given but you could probably check when someone logs in with Discord or with CRON.

[merefield (Robert)]

@Owen_Walters

Would the opposite be possible? I’d love a way to be able to create a Discourse setup for my Discord server. I’m not sure if there’s a Discord API event for roles being given but you could probably check when someone logs in with Discord or with CRON.

Yes, absolutely.

You could either build that as a bot command for ad hoc application, but with a repeat feature that reran the command after a period (nice but not very transparent and no way to individually manage these recurrences)

OR

As I alluded to above, have it scheduled as a job in Discourse as a sidekiq job. That might be a separate plugin (I actually started on the skeleton of that approach before moving to a bot only solution mainly because the ‘bot’ approach was kind of the Discord ‘thing’, fun and offered a unique approach and result), but if I can get Discourse to fire off bot commands then that’s moot (not yet had the chance to test that), and then we can write stuff once and have it work either way (nice!).

Both these solutions would rely on the same OAuth login though.

Whilst this is an excellent idea, it can’t be a priority for me at present because I have a lot of other client work at the moment I need to deliver, but if you wish to support such an extension, we can discuss offline on a PM and schedule it in.

[Owen_Walters]

It might be interesting to play around with, but I have nowhere near the skill level required to volunteer to develop/maintain an addon like this. I might make a messy fork at some time but I certainly don’t want my name on anything official.

[merefield (Robert)]

Absolutely get messy. It’s the only way to learn. :).

[merefield (Robert)]

Minor bug fix deployed:

fixed bot command arguments

[neemiasvf (Neemias Freitas)]

Got this during rebuild:

Bot is still offline. Triple checked everything and it’s all set up correctly. Not sure how to proceed now… Maybe I need to open a port on my server instance?

[merefield (Robert)]

Thanks for testing this out and so soon after the update. Let me try to reproduce and I will revert. I did not change anything wrt to the port config.

[merefield (Robert)]

No issues rebuilding here, Bot comes up fine … have you changed anything in your server config in between?

Your 400 Bad Request sounds like your server sent a corrupt or bad request to the Discord server and this was the response. This suggests it received it fine and was not blocked.

You can get this for:

• malformed requests
• lack of authorisation
• exceeding rate limits

Unfortunately the error message doesn’t appear to help us determine which of these was the particular issue.

Presumably your Discourse is up? Check all the plugin settings are populated correctly.

Just to rule out a temporary gremlin run ./launcher restart app when you get chance … this will take your site down for a few seconds only (sorry about that!).

[Falco]

I see it runs the bot in the after_initialize block, so it will prevent migrations (and rebuilds) if the bot is misconfigured, or if Discord is down.

Maybe try to handle this exception and just log it?

[merefield (Robert)]

@Falco

I see it runs the bot in the after_initialize block, so it will prevent migrations (and rebuilds) if the bot is misconfigured, or if Discord is down.

It runs on a separate thread? So I expect that not to be an issue?

However this callback seems to run several times in a rebuild, so the main issue will be that a misconfigured bot could actually breach rate limits if authorisation fails too many times in quick succession. If that happens the account, in worse case, could be blocked for some time.

In any case, I’ll do a quick patch to do that with the current implementation to lessen the impact. Thanks for the suggestion.

UPDATE: @falco, this is done, e.g.:

added a rescue statement around bot invocation to handle and log errors

[ransim (Ran)]

First I want to say thank you for making this, once I can get it working its going to be a huge help for us managing our discourse and discord for a volunteer community.
I am running into a 400 error when trying to run this bot. Prior to this plugin being added we have been successfully using the official discord auth plugin and webhooks via the chat integration plugin. I’ve validated that those are both still working appropriately.

I created the bot within the same discord app I’d previously created authorized the bot within the discord server, it shows up in the member list as offline. Your documentation didn’t say what permission value to apply, but given most bots I’ve encountered for discord asked for it I went ahead and set it up with a permissions value of 8 for Administrator.

Within the discord server I then copied the ID of the Role it created, which was named after my app, and the id of the channel for admin text.I added the app Role to that channel with full rights, just to be sure, then added the IDs to discourse and restarted.

Unfortunately no matter what I try I’m getting a 400, I even tried a rebuild just to be sure.

[merefield (Robert)]

@ransim

First I want to say thank you for making this, once I can get it working its going to be a huge help for us managing our discourse and discord for a volunteer community.

Thank you, kind words. It was also enabled by the generosity of funders.

@ransim

Your documentation didn’t say what permission value to apply, but given most bots I’ve encountered for discord asked for it I went ahead and set it up with a permissions value of 8 for Administrator.

Yes, that’s great. It should have Admin.

@ransim

Unfortunately no matter what I try I’m getting a 400, I even tried a rebuild just to be sure.

This is the second report of this issue.

If you intentially remove the last char of the token in settings (remember what this is) do you get a 401 instead?

Let’s move this to PM because it might get messy (we can always post the solution here).

[ransim (Ran)]

Just to post an update in case anyone else sees this, we’re actively looking into the issue but haven’t yet narrowed down the cause. I’d say if anyone else is running into this issue please say so would help to have others testing.

[merefield (Robert)]

This is now fixed. It was a weird one to track down.

Thanks to @ransim for raising and working with me to get to the bottom of it.

Huge thanks to the #ruby_discordrb gang on Discord API for their patient and instant help!

Bot launch fix

@neemiasvf

[p0nda]

@merefield no problem,Your plugin is great.But I have encountered some problems now.
such this:

Discourse Sync:  Starting.  Please be patient, I'm rate limited to respect Discord services.
Discourse Sync:  Checking if there are any eligible groups for sync ...
Discourse Sync: 1 eligible group(s) were found
Discourse Sync:  Preparing list of users who also have a registered account on Discord ...
Discourse Sync:  Preparing list of groups that users who have a registered account on Discord belong to on Discourse ...
Discourse Sync: 0 eligible group(s) were found with Discord users
Discourse Sync:  No users were found in elibigle groups for sync using provided or default criteria!

my commond is : !discsync 4

and commond changed: !discsync false 5 false

Discourse Sync:  Starting.  Please be patient, I'm rate limited to respect Discord services.
Discourse Sync:  Checking if there are any eligible groups for sync ...
Discourse Sync: 10 eligible group(s) were found
Discourse Sync:  Preparing list of users who also have a registered account on Discord ...
Discourse Sync:  Preparing list of groups that users who have a registered account on Discord belong to on Discourse ...

[merefield (Robert)]

Hey @p0nda, sorry for slow reply.

@p0nda

my commond is : !discsync 4

If you include any parameters, you need to include all of them. It might be interpreting things strangely.

[blueve.in]

Unable to get the extended bot settings to show up? I have the changes to the app.yml and plugins installed. I have the OAuth setup working, but not the bot settings. Any ideas?

[blueve.in]

The OAuth setting are there but no bot settings

[i3itCoin (James Slattery)]

These