Environnement de développement

Cette page explique comment compiler et lancer le cœur libre de Vuisio depuis les sources : l’orchestrateur (le SFU) et le client web. C’est le chemin pour contribuer au périmètre AGPL.

Prérequis

• Rust, installé via rustup.
• Node.js 22 et pnpm (via corepack), pour le client web.
• Paquets système : protobuf-compiler, libopus-dev, cmake, libssl-dev, pkg-config.

VUISIO_EXTERNAL_IP

Le média WebRTC a besoin d’une adresse IP joignable. Donnez à VUISIO_EXTERNAL_IP l’adresse de votre machine sur le réseau local, et non 127.0.0.1 : sinon le candidat ICE annoncé est inutilisable et les flux audio et vidéo ne s’établissent pas entre deux navigateurs.

Récupérer les sources

Le code source du périmètre libre (AGPL) est publié dans le dépôt public, hébergé sur un GitLab français :

git clone https://lab.frogg.it/geezot/vuisio-public.git
cd vuisio-public

Note

L’emplacement de ce dépôt public est susceptible de changer dans les prochains mois.

Compiler

cargo build --workspace

Lancer le cœur en local

1. Démarrer l’orchestrateur (le SFU et l’API) :

   export VUISIO_EXTERNAL_IP=192.168.1.10   # votre IP locale, pas 127.0.0.1
   RUST_LOG=debug cargo run -p vuisio

   L’orchestrateur écoute en HTTP sur :3000, expose le registre gRPC sur :50050 et le média WebRTC sur l’UDP à partir de 16384.

2. Démarrer le client web, dans un autre terminal :

   cd modules/webclient
   pnpm install
   pnpm dev --port 3002

   Le client web est alors disponible sur http://localhost:3002.

Caméra et micro : contexte sécurisé

Les navigateurs n’autorisent l’accès à la caméra et au micro que dans un contexte sécurisé. Ouvrez le client web via http://localhost (localhost est considéré comme sûr) ou via HTTPS. En HTTP sur une adresse IP ou un nom de domaine, le navigateur bloque le média.

Note

Redis est optionnel en développement. Sans VUISIO_REDIS_URL, les salles sont éphémères et ne vivent qu’en mémoire.

Tester, linter, formater

cargo test --workspace                   # tests Rust
cargo clippy --workspace -- -D warnings  # lint (warnings bloquants)
cargo fmt --all -- --check               # vérifier le formatage

Côté client web :

cd modules/webclient && pnpm test

Conventions de contribution

• Anglais pour le code, les commentaires, les commits et les PR.
• Commits conventionnels : feat, fix, refactor, docs, test, chore, perf, ci.
• Rust 2024 edition.
• Pas de tiret de ponctuation dans les textes destinés aux utilisateurs (interface, documentation, messages d’erreur).