Sur cette page

Auto-hébergement

Omnillink est un logiciel libre sous licence MIT. Il vous faut Node.js 22 ou plus récent ; Redis est facultatif.

Avec Node.js

Terminal
git clone https://github.com/kayzen-lyon/linkforge.git
cd linkforge
npm install
npx playwright-core install chromium
cp .env.example .env
npm run dev

L’API écoute sur http://localhost:3000. npm run build puis npm start lancent la version compilée.

Sur Vercel

Le dépôt contient la configuration d’un déploiement en une seule fonction serverless, qui sert à la fois l’API et ce site. Le dossier racine du projet Vercel est apps/api.

  • Sur Vercel, Chromium vient du paquet @sparticuz/chromium, prévu pour les fonctions serverless.
  • Sans Redis, le cache vit en mémoire, instance par instance. Ajoutez REDIS_URL pour le partager.
  • Le premier rendu d’une instance froide est plus lent : Chromium doit d’abord démarrer.

Variables d’environnement

Toutes sont facultatives. Les valeurs par défaut conviennent à un essai local.

VariableDéfautRôle
PORT, HOSTDéfaut3000, 0.0.0.0RôleAdresse d’écoute.
REDIS_URLDéfautvideRôleCache partagé. Vide : cache en mémoire.
API_KEYSDéfautvideRôleClés acceptées dans x-api-key, séparées par des virgules, de 16 à 256 caractères.
RATE_LIMIT_MAXDéfaut60RôleRequêtes par fenêtre et par adresse IP.
RATE_LIMIT_KEY_MAXDéfaut600RôleRequêtes par fenêtre et par clé.
RATE_LIMIT_WINDOW_MSDéfaut60000RôleDurée de la fenêtre.
CACHE_*_TTL_SECONDSDéfaut3600RôleDurée de cache par point d’accès : META, SCREENSHOT, PDF, EXTRACT, CONTENT.
HTTP_TIMEOUT_MSDéfaut10000RôleDélai de la lecture HTTP.
BROWSER_NAVIGATION_TIMEOUT_MSDéfaut20000RôleDélai de navigation dans Chromium.
BROWSER_MAX_CONCURRENCYDéfaut4RôlePages rendues en parallèle (2 en serverless).
REQUEST_DEADLINE_MSDéfaut55000RôleDélai global d’une requête.
SSRF_ALLOWED_PORTSDéfaut80,443RôlePorts de destination autorisés.
SSRF_BLOCKED_HOSTSDéfautvideRôleDestinations refusées en plus, hôte ou hôte:port. Cette liste ne peut que restreindre.
BROWSER_PAGE_MAX_REQUESTSDéfaut1500RôleRequêtes au plus par page rendue.
BROWSER_PAGE_MAX_BYTESDéfaut60 Mo (30 en serverless)RôleOctets reçus au plus par page rendue.
CIRCUIT_BREAKER_THRESHOLDDéfaut5RôleÉchecs réseau consécutifs avant de mettre un hôte à l’écart.
CIRCUIT_BREAKER_COOLDOWN_MSDéfaut30000RôleDurée de cette mise à l’écart.
ANIMATION_MAX_BYTESDéfaut10 Mo (4 en serverless)RôlePoids maximal d’une capture animée.
METRICS_TOKENDéfautvideRôleJeton qui protège /metrics (format Prometheus). Vide : la route n’existe pas.
MCP_ENABLEDDéfauttrueRôleActive le point d’accès MCP POST /mcp.
CORS_ORIGINDéfaut*RôleOrigines autorisées à appeler l’API depuis un navigateur.

SSRF_ALLOW_PRIVATE_NETWORKS=true autorise les adresses locales et privées. Ce réglage sert aux tests : l’API refuse de démarrer avec lui quand NODE_ENV=production.

Vérifier l’installation

Terminal
curl http://localhost:3000/health

La réponse donne la durée de fonctionnement, le type de cache et l’état du pool de navigateurs. La page État affiche la même chose pour cette instance.

Raccourcis clavier

CtrlKou/
Ouvrir la recherche et les commandes
?
Afficher cette aide
←→
Passer d’un onglet à l’autre
Ctrl↵
Lancer la requête dans le bac à sable
Esc
Fermer un panneau ou un menu

Les raccourcis à une seule touche se désactivent dans les options d’accessibilité.