Logo Francisca

🌐 Language
Français | English
Indexeur haute performance *general-purpose* pour les systĂšmes supportant le protocole Nostr (Ă©vĂ©nements torrent NIP-35), Ă©crit en Rust ## https://discord.gg/rcsgdzNrvJ Merci Ă  tous les contributeurs. Merci Ă  Gauvino pour le Docker, la documentation et le nettoyage post-DMCA. Merci Ă  Gr0lum. Merci Ă  la personne qui a fourni sa base de donnĂ©es de hash. Merci Ă  tous les utilisateurs qui ont permis de mettre fin Ă  ce site infernal. Pour ceux qui arrivent ici aprĂšs la guerre : il y a fort longtemps, ce repo Ă©tait dĂ©diĂ© au contournement de paywalls sur un site de partage francophone qui ne mĂ©ritait pas le moindre centime. C'est grĂące Ă  vous tous que ce site est enfin mort, et c'est mieux ainsi. Francisco, Oracle ou mĂȘme Destroy, ne reviens jamais... tu as tuĂ© le partage. Sur ces belles paroles, et probablement avec ce dernier commit, je vous souhaite une belle journĂ©e paisible pendant que certains se cachent au Maroc. Vive le partage, et surtout vive le partage libre et gratuit. N'oubliez jamais ce qu'il s'est passĂ©, cela ne doit jamais se reproduire. En espĂ©rant de tout coeur voir U2P fonctionner en production un jour. ## [DISCLAIMER LÉGAL](DISCLAIMER-fr.md) **CaractĂ©ristiques principales** : - Compatible avec n'importe quel relais Nostr exposant des Ă©vĂ©nements torrent NIP-35 - Relais entiĂšrement configurables, aucun compte ni authentification requis - Classement automatique des relais par latence au dĂ©marrage - Recherche quasi instantanĂ©e - Consommation mĂ©moire faible - Recherche de torrents trĂšs modulaire (par nom, seed, leech, date de publication, etc.) - Support Tor optionnel pour anonymiser les connexions aux relais - IntĂ©gration TMDB/IMDB pour la rĂ©solution par identifiant - Compatible Prowlarr, Jackett et toutes les applications \*arr ## Configuration (Ă  faire avant le premier lancement) Francisca ne contient **aucun relais par dĂ©faut** : vous devez en fournir au moins un (un relais Nostr exposant des Ă©vĂ©nements torrent NIP-35). **Via `config.json`** (gĂ©nĂ©rĂ© au premier lancement, Ă  Ă©diter) : ```json { "relays": [ "wss://u2p.anhkagi.net" ] } ``` **Ou via variables d'environnement** (Docker) : ```yaml environment: RELAYS: "wss://u2p.anhkagi.net" # plusieurs relais : sĂ©parĂ©s par des virgules ``` | ClĂ© (`config.json` / env) | Requis | Description | |---------------------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------| | `relays` / `RELAYS` | **oui** | Relais Nostr (NIP-35) Ă  interroger. `wss://` (clearnet) ou `ws://
onion` (Tor). Plusieurs = tableau JSON, ou liste sĂ©parĂ©e par des virgules en env. | | `allowed_pubkeys` / `ALLOWED_PUBKEYS` | non | Pubkeys de publishers de confiance (hex). DĂ©faut : publisher du rĂ©seau U2P. `[]` = accepter tout Ă©vĂ©nement Ă  signature valide. | | `web_base_url` / `WEB_BASE_URL` | non | Base URL d'un lien « dĂ©tails » par rĂ©sultat. Vide = aucun lien. | > [!NOTE] > Sans relais configurĂ©, l'application s'arrĂȘte au dĂ©marrage avec un message expliquant comment en ajouter. ## PrĂ©requis pour la compilation - Rust 1.85.0+ # Installation Une image Docker prĂȘte Ă  l'emploi est disponible pour Francisca. Pour commencer le dĂ©ploiement et la configuration de Docker, consultez le [Guide dĂ©diĂ© Ă  Docker](https://francisca.lila.ws/installation/docker-guide). > [!IMPORTANT] > Si vous rencontrez une erreur `Permission denied` aprĂšs mise Ă  jour, consultez la > section [Gestion des permissions](https://francisca.lila.ws/installation/docker-guide#gestion-des-permissions) du > guide > Docker. ## Docker Pour crĂ©er une image Docker personnalisĂ©e avec vos propres optimisations, consultez le [Guide de crĂ©ation Docker](https://francisca.lila.ws/installation/docker-guide). ## Installation manuelle Pour compiler l'application Ă  partir des sources, suivez le [Guide d'installation manuel](https://francisca.lila.ws/installation/source-guide). ## Configuration IMDB et TMDB Pour activer la rĂ©cupĂ©ration des mĂ©tadonnĂ©es IMDB et TMDB, veuillez suivre les instructions du [guide d'assistance TMDB et IMDB](https://francisca.lila.ws/tmdb-imdb). ## Support Tor Francisca peut router ses connexions aux relais Nostr via Tor pour anonymiser le trafic. | Variable d'environnement | DĂ©faut | Description | |--------------------------|------------------|-----------------------------------------| | `USE_TOR` | `false` | Activer le routage Tor (`true`/`false`) | | `TOR_PROXY` | `127.0.0.1:9050` | Adresse du proxy SOCKS5 Tor | Exemple Docker Compose : ```yaml environment: USE_TOR: "true" TOR_PROXY: "127.0.0.1:9050" # Optionnel si valeur par dĂ©faut ``` > [!NOTE] > Tor doit ĂȘtre installĂ© et en cours d'exĂ©cution sur votre machine (ou accessible depuis le conteneur) pour que cette > option fonctionne. ## IntĂ©gration Ă  Prowlarr Francisca peut ĂȘtre utilisĂ© comme indexeur personnalisĂ© pour Prowlarr. Pour le mettre en place, trouvez votre rĂ©pertoire AppData (situĂ© dans la page `/system/status` de Prowlarr) et copiez le fichier `francisca.yml` du repo dans le dossier `{votre chemin appdata prowlarr}/Definitions/Custom`, vous aurez probablement besoin de crĂ©er le dossier `Custom`. Une fois que c'est fait, redĂ©marrez Prowlarr et allez dans les paramĂštres des indexeurs, vous devriez voir Francisca dans la liste des indexeurs disponibles. > [!NOTE] > Prowlarr ne permet pas de personnaliser le "Base URL". Par dĂ©faut, utilisez `http://localhost:8715/`. Pour les > configurations Docker Compose, utilisez `http://francisca:8715/`. Alternativement, utilisez > francisca-dns-redirect.local > avec un DNS personnalisĂ© ou en Ă©ditant le fichier hosts. ## IntĂ©gration Ă  Jackett Francisca peut ĂȘtre utilisĂ© comme indexeur personnalisĂ© pour Jackett. Pour le mettre en place, localisez votre rĂ©pertoire AppData Jackett et copiez le fichier `francisca.yml` du dĂ©pĂŽt dans le dossier `{votre chemin appdata jackett}/cardigann/definitions/`. Vous devrez peut-ĂȘtre crĂ©er le sous-dossier `cardigann/definitions/` s'il n'existe pas. > [!NOTE] > L'image Docker LinuxServer Jackett fournit une structure de dossiers bien organisĂ©e. Si vous utilisez une autre image > Docker, adaptez les chemins en consĂ©quence. Une fois terminĂ©, redĂ©marrez Jackett et accĂ©dez aux paramĂštres des indexeurs. Vous devriez voir Francisca dans la liste des indexeurs disponibles. # Documentation ## Documentation utilisateur La documentation complĂšte est disponible sur [francisca.lila.ws](https://francisca.lila.ws) : - [Guide de dĂ©marrage](https://francisca.lila.ws/getting-started) - [Installation](https://francisca.lila.ws/installation/docker-guide) - [Configuration](https://francisca.lila.ws/configuration) - [IntĂ©grations (Prowlarr/Jackett)](https://francisca.lila.ws/integrations/prowlarr) - [Documentation de l'API](https://francisca.lila.ws/api) - [FAQ](https://francisca.lila.ws/faq) ## Documentation dĂ©veloppeur Pour contribuer au projet ou comprendre le fonctionnement interne : - [Guide de contribution](docs/contribution-fr.md) - [Pipeline CI/CD](docs/ci_implementation-fr.md) - [Workflow de preview des PRs](docs/preview_workflow-fr.md) - [Workflow de release](docs/release_workflow-fr.md)