ix-scout/README.md
2026-02-25 00:53:29 +00:00

43 lines
1.1 KiB
Markdown

# IX Scout
*Part of the Inference-X Ecosystem*
[![License: BSL-1.1](https://img.shields.io/badge/License-BSL_1.1-orange.svg)](LICENSE)
**Real-time global map of every Inference-X node.**
When you run IX Engine with `--scout`, you optionally report anonymous hardware telemetry.
IX Scout aggregates this data into a live map of the community's collective compute.
## Deploy Scout Server
```bash
pip install fastapi uvicorn
python ix_scout.py
# → API at http://localhost:7936
```
## Enable Node Reporting
```bash
# Add --scout flag to your IX Engine command
./inference-x model.gguf --serve 8080 --scout https://scout.inference-x.com
```
## API
```
POST /report — IX Engine nodes report telemetry
GET /stats — Aggregated stats (24h window)
GET /nodes — Recent nodes (anonymized)
GET /health — Service status
```
## Privacy
- All telemetry is anonymous (no IPs stored)
- Opt-in only via explicit `--scout` flag
- Only hardware specs reported (backend, RAM, speed, country optional)
- Data retained for 24 hours then pruned
Built in Morocco for the world. 🇲🇦
## License
[Business Source License 1.1](LICENSE)
**Author:** Salka Elmadani