2026-09-26 12:59:27 +02:00
2026-09-27 12:52:19 +02:00
2026-09-27 12:52:19 +02:00

Agora Plugins

Sources officielles pour Agora. Chaque plugin est distribué unitairement sous forme de ZIP attaché à une release Gitea, puis installé par Agora dans ~/.agora/plugins/<id>/.

id Source Config
zt Zone-Téléchargement ZT_URL
ztnews Zone-Téléchargement (Team) ZTTEAM_URL
freetel Free-Télécharger FT_URL
fs24 FS24 FS24_URL, FS24_USERNAME, FS24_PASSWORD
flixart FlixArt FLIXART_URL, FLIXART_USERNAME, FLIXART_PASSWORD
movix Movix MOVIX_URL, TMDB_API_KEY (optionnel)
loadix Loadix LOADIX_URL
localdb Base SQLite locale DB_PATH (optionnel)
demo Démo : films et séries libres de droit (Blender, domaine public), vrais liens de téléchargement aucune
hydracker Hydracker (archivé, toujours inactif) HYDRACKER_URL, HYDRACKER_API_KEY

Structure d'un plugin

<id>/
├── index.ts        # Classe ISource + export default register(agora)
├── context.ts      # Pont vers le cœur d'Agora (CONFIG, sourceRegistry, dataDir)
├── api.ts          # Appels HTTP vers le site source
├── parser.ts       # Parsing HTML des résultats
├── icon.png        # Logo (128×128)
└── manifest.json   # Métadonnées (id, version, auteur, configFields…)

Un plugin n'importe jamais de code d'Agora (../../src/...) : il ne dépend que des types de sdk/agora.d.ts (effacés à la compilation) et du contexte injecté au chargement :

import type { AgoraContext } from '../sdk/agora.js';
import { setContext } from './context.js';

export default function register(agora: AgoraContext): void {
    setContext(agora);                  // rend CONFIG / sourceRegistry / agora() utilisables
    agora.registry.register(new MaSource());
}

AgoraContext fournit registry (register, get), config (le CONFIG d'Agora : CONFIG.MA_CLE), dataDir (~/.agora), pluginDir et vault.

  • Données sensibles (cookies de session, jetons…) : toujours dans le coffre chiffré agora.vault (read(nom), write(nom, valeur), delete(nom)), jamais en clair sur le disque. Chaque plugin n'accède qu'à son propre coffre.
  • Autres données persistantes (bases, caches) : dans dataDir (ex : dataDir/database/).

manifest.json

{
  "id": "flixart",
  "name": "FlixArt",
  "version": "1.0.0",
  "description": "…",
  "author": "Nolhan",
  "category": "video",
  "tags": ["films", "séries"],
  "official": true,
  "entry": "index.js",
  "icon": "icon.png",
  "configFields": [
    { "key": "FLIXART_URL", "label": "FlixArt URL", "type": "url", "required": true, "placeholder": "https://..." }
  ],
  "healthCheckMethod": "trending",
  "minAgoraVersion": "2.0.0"
}
  • id = nom du dossier = name de la classe ISource.
  • version en semver ; toute nouvelle release nécessite un bump.
  • configFields[].type : text, url, password, number, boolean, path.
  • configFields[].help (optionnel) : texte d'aide affiché sous le champ dans Agora (à quoi sert la valeur, où la trouver).
  • icon (optionnel) : logo du plugin à la racine du dossier, PNG / JPG / WebP carré (128×128 conseillé, 256 Ko max). Il est inclus dans le ZIP et affiché sur la marketplace et dans Agora.

Plugins communautaires

Un plugin proposé sur la marketplace communautaire n'est pas signé : Agora, et la marketplace avant publication, lui appliquent des règles plus strictes. Un plugin qui ne les respecte pas est refusé, avec le motif.

  • Clés de configuration préfixées par l'id du plugin : plugin mon-plugin → MON_PLUGIN_URL, MON_PLUGIN_TOKEN… (majuscules, chiffres et _, 20 champs au plus).
  • Clé partagée autorisée : TMDB_API_KEY (la clé TMDB réglée dans Agora).
  • Clés interdites, même avec le bon préfixe : celles d'Agora (SECRET, PORT, ADMIN_*, TRUST_PROXY, réglages de Paramètres → Système comme JD_HOST, TMDB_ENABLED, PUBLIC_URL…) et celles des plugins officiels (FS24_PASSWORD, DB_PATH…).
  • Valeurs lues uniquement depuis Agora : un plugin communautaire ne voit que ce que l'admin a saisi dans sa fenêtre « Configurer », jamais les variables d'environnement du serveur.
  • official: true est réservé aux plugins signés de ce dépôt.
  • Données sensibles (cookies de session, jetons) : dans agora.vault, jamais en clair sur le disque.

Un plugin communautaire s'exécute dans le même processus qu'Agora : l'admin est prévenu à l'installation qu'il ne doit installer que des plugins de confiance.

Workflow développeur

npm install
npm run build        # tsc → build/<id>/ (+ manifest) et contrôle qu'aucun import ne sort du plugin
npm run pack         # build/<id>/ → release/<id>.zip

Tester dans une instance Agora locale sans rien copier :

# depuis le dépôt Agora
AGORA_PLUGINS_DIR=../Agora_plugins/build npm run dev

Publier

  1. Bumper version dans <id>/manifest.json, commit + push sur main.
  2. npm run build && npm run pack
  3. GITEA_TOKEN=xxx npm run release -- <id> (scope write:repository).

Le ZIP est alors disponible sur :

https://git.nolhantirer.space/ntrehel/Agora_plugins/releases/download/<id>-v<version>/<id>.zip

C'est cette URL que référence le marketplace communautaire (agora.nolhantirer.space).

S
Description
No description provided
Readme
409 KiB
1 Stars 1 Watchers 0 Forks
2026-11-02 19:05:25 +00:00
Languages
TypeScript 94.5%
JavaScript 5.5%