aidd-discord-bot

Sauvegarde incrémentale des canaux texte et threads de serveur Discord.

Déclaration du bot et ajout de celui-ci au serveur Discord

• Se rendre dans l'espace développeur de Discord à l'adresse https://discord.com/developers/applications (Attention, l'application ne peut pas contenir le mot discord)
• Se connecter
• Cliquer sur "Nouvelle application" en haut à droite
• Dans l'onglet des "Informations générales"
  • Personaliser l'application' (nom, image, etc.) si besoin. C'est juste pour distinguer tes différentes applications
• Se rendre dans l'onget "Bot"
  • Personaliser le bot : nom, avatar, etc.
  • Cliquer sur le bouton "Reset token"
  • Copier le token généré dans le fichier .env du projet, à la clé DISCORD_TOKEN. Il s'agit du token de connexion du bot et doit absolument rester secret
  • Désactiver l'option "Public Bot"
  • Activer l'option "Message Content Intent"
• Se rendre dans l'onget "OAuth2"
  • Sélectionner la sous-section "URL Generator"
  • Cocher le scope "bot"
  • Donner la permission "Administrator"
  • Copier l'URL générée. Exemple : https://discord.com/api/oauth2/authorize?client_id=1234567890&permissions=8&scope=bot

Une fois le bot déclaré :

• Se rendre sur un canal du serveur Discord, poster en message l'URL précédemment copiée
• Cliquer sur le lien
• Confirmer l'ajout du bot au serveur (rire un coup, à cause du message, avant)
• Confirmer le droit "Admnistrateur" accordé au bot

Base de données firebase

Création du projet

• Se rendre sur https://console.firebase.google.com
• Se connecter avec un compte Google
• Ajouter un projet
• Saisir le nom du projet / Cliquer sur "Continuer"
• Décocher Google Analytics (C'est par principe mais tu peux faire comme tu le sens)
• Valider autant de fois que nécessaire pour arriver sur le dashboard

Création de la base de données

• Cliquer sur "Créer" dans le menu de gauche
• Cliquer sur "Realtime database" (j'ai pris la RTDB mais storage aurait pu le faire aussi. Je n'ai juste pas fait attention)
• Cliquer sur "Créer une base de données"
• Sélectionner une région de serveur puis cliquer sur "Suivant"
• Laisser le "mode vérouillé" puis cliquer sur "Activer"
• Cliquer sur l'icône "lien" 🔗 et coller l'url copiée dans le fichier .env, clé FIREBASE_DATABASE_URL

Récupérer les infos de connexion

• Cliquer sur la roue crantée en haut à gauche de l'écran, à droite de "🏠 Vue d'ensemble" et sélectionner "Paramètres du projet"
• Aller dans l'onglet "Comptes de service"
• Cliquer sur "Générer une nouvelle clé privée". Cela déclenchera le téléchargement d'un fichier JSON
• Placer le fichier JSON où tu veux dans le projet.
• Mettre le chemin vers le fichier dans le fichier .env, clé FIREBASE_SERVICE_ACCOUNT. La racine du projet est également la racine de recherche du fichier. Exemple: si le fichier s'appelle secret_firebase_file.json et que tu le mets dans le dossier src/secret, il te faudra saisir src/secret/secret_firebase_file.json

NOTE Le / initial est inutile, cf. exemple ci-dessus.

Poste de développement

Le projet utilise nodeJS pour

• L'installation des dépendances (lancer la commande npm install, en étant à la racine du projet, pour récupérer les dépendances du projet avant exécution)
• Pouvoir exécuter le code javascript du robot en ligne de commande (lancer la commande node .)

Il est nécessaire de créer un fichier .env à la racine du projet. Se baser sur le fichier .env.sample pour le créer.

Annexes

Configuration des rules firebase

Il est recommandé d'utiliser des index pour améliorer les tris et les recherches et le crawler se base sur les canaux afin de ne sauvegarder que les derniers messages. Il est donc nécessaire d'ajouter channelId (qui sert de clé étrangère) aux tables messages et threads.

Pour se faire, dans l'onglet "Règles" de la page "Realtime Database", on peut éditer le JSON comme suit :

{
  "rules": {
    ".read": false,
    ".write": false,   
    "messages": {
      ".indexOn": ["channelId"]
    },
    "threads": {
      ".indexOn": ["channelId"]
    }
  }
}

Documentation

• Documentation de la librairie discord.js
• Documentation de firebase