mirror of
https://github.com/Routstr/routstr-core.git
synced 2026-10-05 12:28:22 +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.
113 lines
3.2 KiB
YAML
113 lines
3.2 KiB
YAML
site_name: Routstr Core Documentation
|
|
site_url: https://docs.routstr.com
|
|
site_description: FastAPI-based reverse proxy for OpenAI-compatible APIs with Bitcoin eCash micropayments
|
|
site_author: Routstr Team
|
|
|
|
repo_name: routstr/routstr-core
|
|
repo_url: https://github.com/routstr/routstr-core
|
|
edit_uri: tree/main/docs
|
|
|
|
theme:
|
|
name: material
|
|
language: en
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: orange
|
|
accent: amber
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: orange
|
|
accent: amber
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- navigation.indexes
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.tabs.link
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
icon:
|
|
logo: material/lightning-bolt
|
|
repo: fontawesome/brands/github
|
|
|
|
plugins:
|
|
- search
|
|
- mermaid2
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- codehilite:
|
|
guess_lang: false
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.details
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- attr_list
|
|
- md_in_html
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/routstr
|
|
- icon: fontawesome/brands/bitcoin
|
|
link: https://cashu.space
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Overview: overview.md
|
|
- Client Guide:
|
|
- Introduction: client/introduction.md
|
|
- Payment Flow: client/payments.md
|
|
- Integration: client/integration.md
|
|
- Provider Guide:
|
|
- Quick Start: provider/quickstart.md
|
|
- Dashboard: provider/dashboard.md
|
|
- Deployment: provider/deployment.md
|
|
- Configuration: provider/configuration.md
|
|
- Pricing: provider/pricing.md
|
|
- Advanced Pricing: provider/advanced-pricing.md
|
|
- Discovery: provider/discovery.md
|
|
- Tor Support: provider/tor.md
|
|
- Teams (Remote):
|
|
- Overview: teams/index.md
|
|
- Deploy on Cloudron: teams/deploy-cloudron.md
|
|
- Deploy with Docker: teams/deploy-docker.md
|
|
- Team Members: teams/team-members.md
|
|
- Connecting Clients: teams/clients.md
|
|
- Usage and Model Policy: teams/usage-and-policy.md
|
|
- Security Model: teams/security.md
|
|
- Troubleshooting: teams/troubleshooting.md
|
|
- API Reference:
|
|
- Overview: api/overview.md
|
|
- Authentication: api/authentication.md
|
|
- Endpoints: api/endpoints.md
|
|
- Errors: api/errors.md
|
|
- Contributing:
|
|
- Setup Development: contributing/setup.md
|
|
- Architecture: contributing/architecture.md
|
|
- Code Structure: contributing/code-structure.md
|
|
- Testing: contributing/testing.md
|