From 321ab062e303d4d10cfcac35ed976127cf84d683 Mon Sep 17 00:00:00 2001 From: UNFR Date: Thu, 2 Apr 2026 08:07:27 +0000 Subject: [PATCH] Ajouter README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..db7cd48 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +#MarkHS pour NZBGet + +Ce script de post-traitement pour NZBGet permet de signaler automatiquement les *releases* irréparables ou défectueuses (HS). + +En cas d'échec de vérification ou de réparation d'un téléchargement, le script récupère l'identifiant unique du NZB et avertit l'API afin de marquer la release comme "HS". + +## 🚀 Fonctionnement + +* **Ciblé et silencieux :** Le script ne contacte l'API **que si** le téléchargement rencontre une erreur critique (`FAILURE/HEALTH` ou `FAILURE/PAR`). Si le téléchargement réussit, il ne fait rien. +* **Sécurité anti-spam :** Le script vérifie la présence de la balise `` dans le fichier `.nzb`. Si cette balise est absente (ce qui signifie que le NZB ne provient probablement pas d site), le script s'arrête sans rien envoyer. Vous pouvez donc l'activer sur tous vos téléchargements sans craindre de spammer l'API avec des fichiers externes. + +## 🛠 Prérequis + +* **NZBGet** v18.0 ou supérieur. +* **Python 3** installé sur votre machine. + +## 📥 Installation + +1. Placez le **répertoire** contenant le script dans le dossier `scripts` de votre installation NZBGet. +2. Rechargez NZBGet (ou allez dans *Settings > System > Reload*) pour qu'il détecte le nouveau script. + +## ⚙️ Configuration + +Toute la configuration s'effectue directement depuis l'interface web de NZBGet. **Il n'est pas nécessaire de modifier le code du script.** + +1. Allez dans les réglages de NZBGet. +2. Vous pouvez configurer le script de deux manières : + * **Globalement :** Allez dans la section *Extension Scripts* / *Extensions*. + * **Par Catégorie :** Allez dans la section *Categories* (Note : la configuration d'une catégorie précise sera toujours prioritaire sur la configuration globale). +3. Repérez la section de configuration **MARKHS**. +4. Renseignez votre **ApiKey** (vous la trouverez dans la page de vos réglages sur le site). +5. Sauvegardez la configuration et rechargez NZBGet. + +## 📋 Utilisation & Conseils + +* **Ordre des scripts :** Il est fortement conseillé d'assigner ce script **à la toute fin** de votre liste de scripts de post-traitement. +* **Suivi :** Vous pouvez suivre l'activité du script directement dans les logs de NZBGet. Lors d'un échec de téléchargement couvert par le script, vous verrez des lignes de type `[INFO]` indiquant : + * La lecture du fichier NZB. + * La récupération du *Random ID*. + * L'appel API. + * La confirmation : `Release marquée HS avec succes.` \ No newline at end of file