diff --git a/docs/2.modules/9.logs.md b/docs/2.modules/9.logs.md index daa2750b8..eaa892057 100644 --- a/docs/2.modules/9.logs.md +++ b/docs/2.modules/9.logs.md @@ -11,7 +11,6 @@ updatedAt: '2023-03-01' Les logs sont un historique des actions faites sur votre serveur. Ils vous permettent de pouvoir retrouver une action qui vous intrigue ou bien de voir qui a fait quelle action. Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par des webhooks. Un webhook vous permet d'envoyer un message avec une photo de profil, un nom et un contenu personnalisé. -> ***DraftBot** gère ses propres webhooks et l'envoi des messages avec ses derniers. Si vous supprimez son webhook de logs, il le recréera automatiquement lors de l'envoi du prochain log.* ## Configuration générale @@ -29,10 +28,15 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de Ici sera affiché, pour chaque module : - Log activé (✅) ou non (❌). - Salon d'envoi. - - Couleur. + - Couleur. (<:icon_premium_:1096140508625125417>) + - Avatar. (<:icon_premium_:1096140508625125417>) ::hint{ type="info" } - Les logs de messages et de boosts sont réservés aux serveurs [premium <:icon_premium_:1096140508625125417>](/premium). + Les fonctionnalités accompagnées du symbole <:icon_premium:1096140508625125417> sont réservées aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>. + :: + + ::hint{ type="info" } + Les logs de **messages** et de **boosts** sont réservés aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>. :: Sous ce message, retrouvez les boutons permettant de configurer les logs : @@ -67,6 +71,89 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de :: :: +## Configuration des destinations + +Chaque log peut être envoyé vers différentes destinations. + +### Choix de la destination + +::tabs + ::tab{ label="Via le panel" } + [⫸ Accéder au panel de **DraftBot**](/dashboard/first/logs) + + ![Configuration d'un module de log depuis le panel](../assets/logs/panel_module.png) + + Vous pouvez choisir la destination d'envoi des logs en cliquant sur **Modifier** puis choisir le type de destination parmi [ces options](#les-options). + :: + + ::tab{ label="Via la commande /config" } + Si vous souhaitez effectuer toute la configuration directement depuis Discord, vous pouvez le faire via la commande /config, puis en vous rendant dans l'onglet "Logs". Le menu ressemble alors à ceci : + + ![Configuration d'un module de log depuis le /config](../assets/logs/config_moderation.png) + + Vous pouvez choisir la destination d'envoi des logs en cliquant sur **Destination** puis choisir le type de destination parmi [ces options](#les-options). + :: +:: + +### Les options + +::tabs + ::tab{ label="Serveur" } + L'option par défaut, les logs sont envoyés dans un salon configuré du serveur. + + > ***DraftBot** gère ses propres webhooks et l'envoi des messages avec ses derniers. Si vous supprimez son webhook de logs, il le recréera automatiquement lors de l'envoi du prochain log.* + :: + + ::tab{ label="Autres serveurs" } + ::hint{ type="warning" } + Vous devez être propriétaire du serveur en question afin de pouvoir configurer cette fonctionnalité. + :: + Les logs sont envoyés vers un autre serveur Discord à l'aide d'un **webhook Discord** externe. + + > Exemple : + > https://discord.com/api/webhooks/... + + Pour créer un webhook, vous devez aller dans les \<:icon_settings:1120818166067646664> **Paramètres** de votre salon de réception, dans la section **Intégrations** et vous pourrez alors **Créer un webhook**. + + ![Créez vos webhooks en cliquant sur "Créer un webhook"](../assets/logs/server_webhook.png) + + Après avoir créer votre webhook, vous pouvez modifier votre webhook. + + ![Menu qui apparaît lors de la modifiication d'un webhook](../assets/logs/server_webhook_section.png) + + Parmi ce qui apparaît dans ce menu, nous retrouvons : + + | Composant | Description | + |-----------|-------------| + | Nom | Le nom avec lequel le webhook enverra les logs de **DraftBot** | + | Image | L'image avec laquelle le webhook enverra les logs de **DraftBot** | + | Salon | Le salon dans lequel le webhook enverra les logs de **DraftBot** | + | Copier l'URL du webhook | Permet de copier l'URL du webhook afin de le renseigner dans le [choix de la destination](#choix-de-la-destination) | + | Suppression du webhook | Permet de supprimer le webhook si vous n'en avez plus besoin. | + + ::hint{ type="warning" } + **Attention :** Cette action est irréversible + :: + :: + + ::tab{ label="API Externe" } + Les logs sont envoyés vers une URL externe (API, site web, service tiers). + + | Type | Description | Exemple | + |------|-------------|---------| + | **URL personnalisée** | URL vers laquelle les données sont envoyées. Elle doit être valide et commencer par http:// ou https://. | https://example.com/webhook | + | **Headers HTTP personnalisés** | Paires clé/valeur ajoutées à la requête HTTP (authentification, options…). Jusqu'à 3 headers sont autorisés. | X-API-Key: YOUR_API_KEY | + + ::hint{ type="info" } + Cette fonctionnalité est réservée aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>. + :: + + ::hint{ type="warning" } + Vous devez être propriétaire du serveur en question afin de pouvoir configurer cette fonctionnalité. + :: + :: +:: + ## Configuration par module ::tabs @@ -77,11 +164,17 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de ![Configuration d'un module de log via la commande /config](../assets/logs/config_modules.png) - Une fois le module sélectionné, laissez-vous guider par **DraftBot** pour terminer la configuration du module ! + Le module "**Modération**" est le module choisi par défaut. Vous pouvez sélectionner le module que vous souhaitez via le sélecteur qui se trouve en dessous de l'embed ! + + Laissez-vous guider par **DraftBot** pour terminer la configuration du module ! - Pour changer le salon d'envoi : Indiquez la mention ou l'identifiant du salon voulu. - Pour changer la photo de profil du log, lors de l'envoi : Envoyez une image respectant les normes indiquées dans la description de la question correspondante. (<:icon_premium:1096140508625125417>) - Pour changer la couleur du log, lors de l'envoi : Indiquez un code couleur au format hexadécimal (<:icon_premium:1096140508625125417>) + ::hint{ type="info" } + Les fonctionnalités accompagnées du symbole <:icon_premium:1096140508625125417> sont réservées aux serveurs [premium](/premium) <:icon_premium_:1096140508625125417>. + :: + ::hint{ type="success" } La configuration du module est faite ! Vous aurez désormais accès aux logs de ce module dans le salon défini. :: @@ -115,3 +208,5 @@ Les logs sont des embeds qui sont envoyés non pas par **DraftBot**, mais par de :: :: + + diff --git a/docs/assets/logs/bot_log.png b/docs/assets/logs/bot_log.png index 88433ad24..55e8a1a0a 100644 Binary files a/docs/assets/logs/bot_log.png and b/docs/assets/logs/bot_log.png differ diff --git a/docs/assets/logs/config_moderation.png b/docs/assets/logs/config_moderation.png new file mode 100644 index 000000000..bda10070c Binary files /dev/null and b/docs/assets/logs/config_moderation.png differ diff --git a/docs/assets/logs/config_modules.png b/docs/assets/logs/config_modules.png index 34d476f01..cff3b06d0 100644 Binary files a/docs/assets/logs/config_modules.png and b/docs/assets/logs/config_modules.png differ diff --git a/docs/assets/logs/config_view.png b/docs/assets/logs/config_view.png index 0af015989..e6e6a8673 100644 Binary files a/docs/assets/logs/config_view.png and b/docs/assets/logs/config_view.png differ diff --git a/docs/assets/logs/panel_activate.png b/docs/assets/logs/panel_activate.png index b1cdf514b..f5acb6a6b 100644 Binary files a/docs/assets/logs/panel_activate.png and b/docs/assets/logs/panel_activate.png differ diff --git a/docs/assets/logs/panel_module.png b/docs/assets/logs/panel_module.png index 4967373e9..0cd30a623 100644 Binary files a/docs/assets/logs/panel_module.png and b/docs/assets/logs/panel_module.png differ diff --git a/docs/assets/logs/server_webhook.png b/docs/assets/logs/server_webhook.png new file mode 100644 index 000000000..c40dcc9c3 Binary files /dev/null and b/docs/assets/logs/server_webhook.png differ diff --git a/docs/assets/logs/server_webhook_section.png b/docs/assets/logs/server_webhook_section.png new file mode 100644 index 000000000..ad31598ec Binary files /dev/null and b/docs/assets/logs/server_webhook_section.png differ