Kit de construction pour bot Discord 🤖

[merefield (Robert)]

Objectif de ce plugin

Ce plugin effectue plusieurs tâches :

1. Il vous permet d’alimenter un bot Discord à l’aide de votre serveur Discourse pour effectuer des actions reliant les deux systèmes. Forkez ce dépôt et étendez-le avec du Ruby simple pour créer toutes sortes de fonctionnalités de bot.

2. Fonctionnalités existantes servant d’exemples et d’utilitaires utiles :

• Fournit une publication automatique bidirectionnelle de contenu répondant à certains critères.
• Commande pour copier des messages à la demande vers Discourse.
• Commande pour synchroniser l’appartenance aux groupes avec l’appartenance aux rôles de votre serveur Discord et votre instance Discourse.

Le plugin fournit un squelette extensible sur lequel vous pouvez construire des fonctionnalités supplémentaires. Les PR pour des ajouts généralement utiles sont les bienvenues.

^{ce ne sont pas les deux commandes de synchronisation, mais simplement une illustration de l’interaction possible avec le bot. La deuxième commande de la capture d’écran a été obsolète pendant le développement}

Sa configuration est nécessairement complexe, mais elle est idéale pour les fans des deux systèmes qui sont désireux de consacrer du temps à comprendre le fonctionnement de chaque système, au moins au niveau fonctionnel et conceptuel. Vous devez comprendre certains des fondamentaux de la gestion des utilisateurs de Discourse et de Discord pour tirer le meilleur parti de ce plugin.

Commandes du bot

Il existe quatre commandes :

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

Ping!

Pour vérifier si le bot répond, tapez simplement « Ping! » et le bot devrait répondre par « : Pong! » - magnifique, n’est-ce pas ? (c’est un peu un mème, au fait !)

!disckick <min_trust_level: défaut 2>

Taper cette commande expulsera tout utilisateur qui existe sur votre Discourse mais dont le niveau de confiance est inférieur à la valeur fournie. La valeur par défaut si vous ne fournissez pas de valeur est 2.

Par exemple :

!discsync <clean up: défaut false, min_visibility: défaut 0, include automated groups: défaut false>

Cette commande tentera de copier tous les groupes vers des Rôles sur Discord qui correspondent aux critères fournis (ou aux valeurs par défaut si non fournis). Elle tentera ensuite de peupler les rôles conformément à l’appartenance aux groupes sur Discourse. Il s’agit d’une synchronisation unidirectionnelle uniquement. Aucune donnée Discourse n’est jamais modifiée.

!disccopy <number_of_messages> <optional_target_category_name> <optional_target_topic_name>

Vous permet de copier l’historique des messages Discord vers votre instance Discourse depuis le chat Discord. Cela peut gérer des milliers de messages d’un coup (mais pour ce volume, cela prendra du temps).

Communication bidirectionnelle

Voici les paramètres :

• Vous pouvez désigner un canal d’annonces sur Discord dans les paramètres du plugin.
• Vous pouvez maintenant taper dans le canal d’annonces Discord assigné et cela publiera votre message dans votre sujet Discourse assigné dans les paramètres du plugin.
• Vous pouvez configurer une liste de catégories dans Discourse pour publier dans le canal d’annonces de votre Discord si quelqu’un y publie ou ajoute un nouveau sujet (l’un, l’autre ou les deux).
• Copie automatique de chat par message, par canal vers n’importe quelle catégorie identiquement nommée sur Discourse : si le nom du canal correspond au nom de la catégorie, le message sera copié dans Discourse.

De plus, j’ai ajouté un nouveau fichier pour gérer les événements Discord pris en charge par l’API discordrb, la logique des annonces étant le premier exemple (n’hésitez pas à en développer de nouveaux et à soumettre une PR si cela est utile à la communauté).

NB : Pour tout message copié dans Discourse depuis Discord, l’utilisateur s’affichera correctement si cet utilisateur s’est connecté à Discourse en utilisant la connexion Discord (ainsi, le bot Discord peut faire correspondre les utilisateurs).

État de ce plugin

C’est un plugin complexe à configurer. C’était inévitable.

Cependant, son utilisation est un jeu d’enfant une fois qu’il est entièrement opérationnel.

Considérez le code comme étant actuellement en Bêta. Il a été testé, même en production, mais contient probablement des bogues. Je recommande de le tester d’abord sur un nouveau serveur Discord avant de l’appliquer à votre serveur Discord principal « Production », sauf si vous commencez tout juste.

Tout bug est beaucoup plus susceptible de perturber votre instance Discord que votre instance Discourse, car aucune modification n’est apportée à Discourse. Cependant, je l’ai écrit de manière à ce que la plupart des choses soient récupérables et que vous puissiez généralement simplement répéter une action pour résoudre un problème. Discourse est utilisé comme maître pour les informations d’appartenance et de groupes, et ces données sont utilisées pour mettre à jour l’appartenance et les rôles sur votre serveur Discord.

Instructions de configuration

Prérequis

1. Un serveur Discord sur lequel vous êtes administrateur.
2. Une application Discord (voir ci-dessous).
3. Un bot Discord (voir ci-dessous).
4. Un accès SSH root à votre serveur Discourse.
5. Des mises à jour du fichier app.yml pour installer le plugin.
6. Tous les utilisateurs de votre Discourse devront se connecter en utilisant la connexion OAuth Discord qui apparaîtra sur votre page de connexion une fois le plugin installé.

Application Discord

Rendez-vous ici et créez une application :

Discord for Developers

Cliquez sur « New Application ».

Vous devrez créer un bot et cela ressemblera à ceci (laissez-le non ‘public’) :

Vous devrez autoriser le bot dans le navigateur, voir OAuth2 - Documentation - Discord

Une fois le bot configuré, copiez le jeton (Token). Vous devrez le saisir dans Discourse plus tard.

Modifications de app.yml

plugin

Vous n’avez besoin que d’un seul plugin maintenant que la connexion sociale Discord est native au cœur de Discourse (ouais )

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

Ensuite, à l’invite, tapez ./launcher rebuild app comme d’habitude.

Cela devrait fonctionner, pas de problème.

Vous pourriez obtenir des erreurs de console et de journal indiquant un échec du bot lors de la première construction car vous n’avez pas encore saisi les identifiants du bot dans l’interface de configuration de Discourse. (gérer cela plus élégamment est une tâche à faire, je supprimerai cette partie lorsque cela sera fait). Cela ne fera aucun mal et Discourse lui-même fonctionnera normalement.

Une fois dans votre zone d’administration Discourse, allez dans Paramètres du plugin et remplissez ces champs :

Vous obtiendrez les ID depuis l’interface Discord. Vous devrez activer le mode développeur pour vous permettre de copier ces ID. Dans Discord, allez dans vos Paramètres → Apparence → AVANCÉ et activez le mode développeur :

Vous pouvez ensuite obtenir les ID depuis l’interface, par exemple :

Vous devrez également remplir les paramètres OAuth Discord. L’ID client et le secret proviennent de votre même application Discord.

Une fois que vous avez défini ces paramètres, retournez à votre invite racine sous Linux et tapez :

./launcher restart app

Si vous avez correctement configuré vos serveurs Discord et Discourse, vous devriez voir le bot rejoindre le serveur.

Si jamais le bot plante (il passera hors ligne), vous devrez faire la même chose pour le ramener. Une indépendance améliorée du bot par rapport au serveur cœur de Discourse est une tâche à faire. Cela dit, j’ai fait fonctionner un bot en production pendant longtemps et il n’a jamais planté.

Commandes futures ?

Si vous avez une idée pour une autre commande qui exploite le lien entre Discourse et Discord et que vous pensez être utile à la communauté plus large, faites-le-moi savoir dans les réponses et nous pourrons examiner le potentiel de mise en œuvre. NB : ce bot n’est pas destiné à effectuer des tâches en dehors du cadre de Discourse.

Limitations

L’objectif principal de ce plugin était de permettre à l’utilisateur de créer un bot sur son Discord alimenté par son serveur Discourse et capable d’effectuer certaines fonctions de base de gestion des membres. Il fournit également une base pour toute interaction supplémentaire de type bot entre les deux systèmes pour le futur. Une partie de la motivation pour utiliser des bots est qu’ils sont tout simplement amusants.

Les commandes de bot sont par nature ad hoc.

Problèmes connus

• Le bot démarrera une instance de lui-même si vous accédez à une session de console Rails sur le serveur. Cela fera apparaître le bot comme répondant deux fois (mais en fait, il y a maintenant deux bots). Dans la console Rails, arrêtez simplement le bot supplémentaire en tapant : ::DiscordBot::Bot.discord_bot.stop Cela ne devrait plus être nécessaire !

• Le Robot est un peu bavard pendant les mises à niveau Discourse ‘en ligne’ car il est réactivé à plusieurs reprises pendant le processus de mise à niveau. Cela revient à trouver un bon moyen d’exécuter le bot dans un processus séparé et géré au lieu d’un thread dérivé du serveur web. Je crois que tout cela est inoffensif, et si la sortie des bots est uniquement vers votre canal d’administration sur Discord, est-ce que cela vous importe vraiment ? Cela devrait être résolu pour la plupart maintenant, le bot s’annonçant seulement deux fois lors d’une reconstruction.

Remerciements

Plusieurs contributeurs sont à remercier pour ce plugin qui m’a pris beaucoup de temps pour atteindre ce stade, notamment @Wedgebert, @FoohonPie. Merci à Jeff pour sa généreuse contribution. Merci à @angus pour tout l’encouragement et la gestion du soutien financier.

Le plugin a été inspiré par le travail de @Watercolor_Games à un stade antérieur et repose sur le plugin OAuth Discord créé par @featheredtoast.

Le plugin repose sur la bibliothèque Ruby discordrb semi-officielle soutenue par Discord et le travail fantastique de l’équipe Discord pour rendre leur système accessible. Merci à @Falco pour m’avoir aidé avec une dépendance de manière extrêmement réactive.

De plus, bien sûr, cela ne serait pas possible sans l’incroyable écosystème de plugins de Discourse (ouais !)

État de ces instructions

Elles seront améliorées avec le temps et j’accueille favorablement les commentaires. Il y a des zones qui sont susceptibles d’être obscures.

[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