Files
meow/README.md
T

52 lines
1.9 KiB
Markdown
Raw Normal View History

2026-11-20 21:47:33 +01:00
# Meow v2 — Rust
Réécriture en Rust de `meowlib`, `meowsrv` et `meowcli`, avec un protocole v2. Voir :
* [`ARCHITECTURE.md`](ARCHITECTURE.md) : crates, cryptographie, protocole, API ;
* [`ROADMAP.md`](ROADMAP.md) : lots de travail et état d'avancement.
## Démarrage rapide
```bash
# toolchain (si absente) : https://rustup.rs
cargo build --release
# serveur (stockage mémoire ; --storage redis://127.0.0.1:6379/0 pour Redis)
./target/release/meowsrv --listen 127.0.0.1:8080 --name "mon serveur"
# client
export MEOW_PASSWORD='un mot de passe solide'
meow() { ./target/release/meow -i bob.mwid2 "$@"; }
meow identity create bob
meow server add http://127.0.0.1:8080
meow invitation create alice # → bob-alice.mwiv2, à transmettre à alice
meow server-invitation create carol # → URL à transmettre à carol
meow send alice "bonjour"
meow # synchronise (= meow sync)
meow longpoll # écoute en continu
```
## Tests
```bash
scripts/check.sh # fmt + clippy -D warnings + tests unitaires et d'intégration
tests/e2e.sh # bout-en-bout : 2 serveurs meowsrv + CLI (équivalent de meowcli/test.sh)
E2E_STORAGE=redis://127.0.0.1:6379/15 tests/e2e.sh # idem avec Redis
MEOW_TEST_REDIS=redis://127.0.0.1:6379/15 cargo test -p meow-server # test du backend Redis
```
## Configuration du serveur
Priorité : options en ligne de commande, puis variables d'environnement `MEOWSRV_*`, puis fichier
TOML (`--config`), puis valeurs par défaut.
```toml
listen = "0.0.0.0:8080"
public_url = "https://meow.example.org" # annoncée dans la carte signée : doit être exacte
name = "meow example"
description = "serveur de test"
storage = "redis://127.0.0.1:6379/0"
key_file = "/var/lib/meowsrv/server.key" # créée en 0600 au premier démarrage
mailbox_ttl_days = 30
log = "info"
```