From 6060c107159655e3b0f37fd6d657d7868843b4b2 Mon Sep 17 00:00:00 2001 From: Darks Date: Wed, 13 Apr 2022 23:07:52 +0200 Subject: [PATCH] README update --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9d132f..d631329 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ Ce bot recoit des requêtes Gitea, les parse et poste des messages en tant que `Gitea` sur la shoutbox. + ## Configuration du backend 1. Cloner le dépot dans `/home/pc/gitea-bot/` -2. Copier le cookie de session de GLaDOS dans `gb_secrets.py` +2. Copier les identifiants de `Gitea` dans `gb_secrets.py` (`credentials = {"username":"Gitea", "password":"P@ssw0rd"}`) 3. Placer `gitea-bot.service` dans `/etc/systemd/system/` 4. Démarrer le service `gitea-bot` @@ -21,6 +22,7 @@ $ exit En soit le cookie peut être celui de n'importe quel membre ayant le droit de causer sur la shout. Par contre ça ne sera plus `Gitea` qui causera. + ## Configuration de Gitea Les webhooks peuvent être activés par dépôt ou globalement. @@ -40,6 +42,7 @@ Sélectionner des éléments qui déclencheront des évènements, vérifier que Les derniers évènements sont affichés sous le formulaire. + ## Traiter de nouveaux évènements La documentation sur les events est disponible [ici](https://docs.gitea.io/en-us/webhooks/). @@ -48,6 +51,7 @@ Gitea logge les événements récents dans les paramètres du webhook dans le pa Le script actuel est pas fou, n'hésitez pas à proposer des améliorations ! :) + ## Tester les modifications en local Lancer le serveur de test avec `flask run` ; les requêtes enregistrées par Gitea peuvent être envoyées avec curl. @@ -56,6 +60,18 @@ Lancer le serveur de test avec `flask run` ; les requêtes enregistrées par Git curl http://127.0.0.1:5000 -X POST -H 'X-Gitea-Event:push' -H 'Content-Type: application/json' -d "$(cat logged-push-event.json)" ``` + +## Modifier la verbosité des logs + +Vous pouvez changer le niveau de verbosité des logs via la variable d’environement `LOGLEVEL` : + +- `critical` +- `error` +- `warning` +- `info` (défaut) +- `debug` + + ## Appliquer des modifications ``` @@ -65,3 +81,8 @@ $ git pull $ exit # systemctl restart gitea-bot ``` + + +## En cas de soucis + +Si le bot ne fonctionne plus sans modification apparente, vous pouvez essayer de redémarrer le service. Cela réinitialisera la session et ses cookies d’authentification.