mirror of
https://github.com/Routstr/routstr-core.git
synced 2026-10-05 20:28:23 +00:00
redshift
7cea2535ef
Documents the shared/team routstrd deployment (routstrd-remote / routstrd-auth) as a new top-level docs section. Eight pages: overview, Cloudron deploy, Docker deploy, team members, connecting clients, usage and model policy, security model, and troubleshooting. Content is written from the implementation rather than the existing prose in the routstrd-remote repo, which has drifted: - client-id header injection was removed in 0.1.5; Bearer auth headers are deliberately preserved, NIP-98 headers stripped - /clients and /usage are strictly owner-scoped, so admins cannot see a colleague's clients through the API - the model allowlist is disabled by default as of 0.1.26 - the Dockerfile is now the Cloudron image (cloudron/base, /app/data), so the README's vanilla Docker instructions and docker-compose.yml no longer match it Adds an explicit offboarding procedure: deleting an npub does not revoke existing sk- API keys, and the proxy's ownership scoping means their clients must be removed on the node. Wires the section into mkdocs.yml nav and the docs landing page.
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# Routstr Core Documentation
|
|
|
|
**Routstr** is a decentralized protocol for permissionless AI inference. It enables an open marketplace where anyone can buy and sell compute using **Bitcoin eCash (Cashu)**.
|
|
|
|
---
|
|
|
|
## 🐣 For Clients (Users & Builders)
|
|
|
|
If you want to use AI models in your application without accounts or KYC.
|
|
|
|
- **[Introduction](client/introduction.md)**: How the ecosystem works.
|
|
- **[Payment Flow](client/payments.md)**: Funding sessions, topping up, and refunds.
|
|
- **[Integration Guide](client/integration.md)**: Code examples for Python, JS, and cURL.
|
|
|
|
## 🦁 For Providers (Node Operators)
|
|
|
|
If you want to run a node, resell API access, or monetize hardware.
|
|
|
|
- **[Quick Start](provider/quickstart.md)**: Deploy a node in 5 minutes.
|
|
- **[Deployment](provider/deployment.md)**: Production Docker setup.
|
|
- **[Configuration](provider/configuration.md)**: Environment variables and settings.
|
|
- **[Dashboard](provider/dashboard.md)**: Managing your node visually.
|
|
- **[Pricing Strategy](provider/pricing.md)**: Setting margins and fees.
|
|
- **[Discovery](provider/discovery.md)**: Announcing your node on Nostr.
|
|
- **[Tor Support](provider/tor.md)**: Running an anonymous hidden service.
|
|
|
|
---
|
|
|
|
## 👥 For Teams (Remote Nodes)
|
|
|
|
If you want one shared Routstr endpoint for a whole team, with per-member identities and per-member usage tracking.
|
|
|
|
- **[Overview](teams/index.md)**: What a remote node is, and when to use one.
|
|
- **[Deploy on Cloudron](teams/deploy-cloudron.md)**: The packaged, supported deployment.
|
|
- **[Deploy with Docker](teams/deploy-docker.md)**: Run it on any host behind your own TLS.
|
|
- **[Team Members](teams/team-members.md)**: Bootstrap the first admin and invite people.
|
|
- **[Connecting Clients](teams/clients.md)**: Wire up Claude Code, Pi, OpenCode, and API keys.
|
|
- **[Usage and Model Policy](teams/usage-and-policy.md)**: Per-member spend and model allowlists.
|
|
- **[Security Model](teams/security.md)**: Auth rules and endpoint scoping.
|
|
|
|
---
|
|
|
|
## 🔌 API Reference
|
|
|
|
- **[Overview](api/overview.md)**: Base URL, headers, and standards.
|
|
- **[Endpoints](api/endpoints.md)**: Full list of REST endpoints.
|
|
- **[Authentication](api/authentication.md)**: Handling API keys and tokens.
|
|
- **[Errors](api/errors.md)**: Status codes and debugging.
|
|
|
|
## 🛠️ Contributing
|
|
|
|
- **[Architecture](contributing/architecture.md)**: System design.
|
|
- **[Setup](contributing/setup.md)**: Development environment.
|
|
- **[Testing](contributing/testing.md)**: Running tests.
|
|
|
|
---
|
|
|
|
*Powered by [Cashu](https://cashu.space) and [Nostr](https://nostr.com).*
|