diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/QUICKSTART.md | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md index 2fa5af0..ca3beee 100644 --- a/docs/QUICKSTART.md +++ b/docs/QUICKSTART.md @@ -14,21 +14,34 @@ Le node tourne sur votre machine et héberge vos fichiers. ```bash cd ~/meshbay # le dépôt local (pas encore publié sur GitHub) -python3 -m venv .venv && source .venv/bin/activate ``` -> **Important — ne pas copier `.venv/` entre machines d'OS différents.** -> Le venv est spécifique à l'OS. Si vous avez cloné/copié le repo depuis une machine Fedora -> vers Ubuntu (ou inversement), le venv doit être recréé avec `--clear` : +> **Si vous synchez le repo depuis une autre machine (rsync, scp)** : +> ne pas copier `.venv/` — il est lié à l'OS source et casse pip sur l'OS cible. +> Toujours recréer le venv avec `--clear` sur la machine cible. ```bash -python3 -m venv .venv --clear # ← --clear force la recréation propre +# Créer (ou recréer proprement) le venv +python3 -m venv .venv --clear source .venv/bin/activate -pip install -e packages/meshbay-common -e packages/meshbay-node httpx blake3 uvicorn + +# Installer les packages — les dépendances (aioquic, watchdog, etc.) viennent automatiquement +pip install -e packages/meshbay-common -e packages/meshbay-node -e packages/meshbay-hub ``` -Sans `--clear`, pip peut échouer avec `FileNotFoundError` dans `certifi` parce qu'il -cherche les certificats CA à un chemin valide sur l'OS d'origine mais absent sur l'OS cible. +Les dépendances déclarées dans les `pyproject.toml` sont installées automatiquement : + +| Package | Vient de | Rôle | +|---|---|---| +| `cryptography` | meshbay-common | crypto (Ed25519, ChaCha20, Argon2id) | +| `PyJWT` | meshbay-common | JWT EdDSA | +| `blake3`, `msgpack`, `zstandard` | meshbay-common | hashing, sérialisation, compression | +| `fastapi`, `uvicorn` | meshbay-node | HTTP API + UI locale | +| `httpx` | meshbay-node | client hub | +| `watchdog` | meshbay-node | surveillance répertoire | +| `aioquic` | meshbay-node | transport QUIC (MNP v2) | +| `aioice` | meshbay-node | ICE/STUN NAT traversal | +| `websockets` | meshbay-node | notifications hub→node | --- |