Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ side of the mapping in the compose file — the right-hand side is the internal
port, the one the process listens on.


Official multi-architecture Docker images (`linux/amd64` and `linux/arm64`) are published automatically to the GitHub Container Registry (GHCR) on pushes to `master` with changes in `src/`. An automated retention policy maintains strictly the last 3 versions:
Official multi-architecture Docker images (`linux/amd64` and `linux/arm64`) are published automatically to the GitHub Container Registry (GHCR) on pushes to `master` and version tags (`v*.*.*`). An automated retention policy maintains strictly the last 3 versions. For a complete deployment guide covering Docker run, Compose, Headroom, Caveman, Cloudflare Tunnel, and Tailscale, see [Docker Deployment Guide](docs/wiki/Docker-Deployment.md).

```bash
docker pull ghcr.io/pathbit/ominirtksync:latest
Expand Down
21 changes: 21 additions & 0 deletions docker-compose.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,27 @@ services:
networks:
- ominirtksync-net

# --- Otimizacao de tokens (opcional) --------------------------------------
#
# Comprime payloads de contexto e reduz custos de tokens para agentes de IA (Claude
# Code, Cursor, Windsurf) intermediando chamadas antes do gateway:
# docker compose --profile headroom up -d
ominirtk-headroom:
image: ghcr.io/headroomlabs-ai/headroom:latest
container_name: ominirtk-headroom
hostname: ominirtk-headroom
profiles: ["headroom"]
restart: unless-stopped
ports:
- "127.0.0.1:8787:8787"
environment:
- UPSTREAM_URL=http://ominirtk-router:20128

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Configure Headroom with its supported upstream variable

Even if the Headroom container starts, UPSTREAM_URL is not a Headroom setting, so requests are not automatically forwarded to OmniRoute as the new guide promises; OpenAI-format traffic retains Headroom's default upstream instead. Headroom documents OPENAI_TARGET_API_URL for a custom OpenAI-compatible target (and ANTHROPIC_TARGET_API_URL for Anthropic traffic), so configure the appropriate supported variable with the OmniRoute URL. See Headroom's proxy environment variables.

Useful? React with 👍 / 👎.

- PORT=8787
Comment on lines +204 to +206

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Allow Headroom's container bind or configure a proxy token

Starting the headroom profile with the floating latest image now exits because the image binds to 0.0.0.0 internally while this environment supplies neither HEADROOM_PROXY_TOKEN nor HEADROOM_ALLOW_UNAUTHENTICATED_BIND=1. Headroom explicitly refuses an unauthenticated non-loopback bind; since the published host port is already loopback-only, add the acknowledgement variable, or configure a token and document how clients send it. See Headroom's Docker installation requirements.

Useful? React with 👍 / 👎.

networks:
- ominirtksync-net
depends_on:
- ominirtk-router

volumes:
ominirtk_tailnet:
omniroute_data:
Expand Down
283 changes: 283 additions & 0 deletions docs/wiki/Docker-Deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
# Docker & Docker Compose Deployment Guide

*(Versão em português disponível na segunda metade desta página.)*

Complete guide to deploying **OminiRTkSync** and **OmniRoute** via Docker and Docker Compose, including token optimization with **Headroom** and **Caveman**, remote access via **Cloudflare Tunnel** and **Tailscale**, and automated container package retention.

---

## 1. Official Docker Packages & 3-Version Retention Policy

Official multi-architecture Docker images (`linux/amd64` and `linux/arm64`) are published to the GitHub Container Registry (GHCR):

```bash
# Pull latest stable release
docker pull ghcr.io/pathbit/ominirtksync:latest
```

### Automated Package Retention (Last 3 Versions)

To ensure high availability, rollback safety, and clean storage, the GitHub Actions CI/CD pipeline enforces an automated package retention policy:
- **Always keeps the last 3 versions**: the active `latest` tag plus the 2 most recent tagged releases / commit SHAs.
- Multi-architecture manifest lists are resolved before deleting orphan manifests, ensuring platform layers remain fully functional.
- Runs automatically after every successful release build and on a weekly schedule.

> [!NOTE]
> **GHCR Visibility & Permissions**: GitHub Container Registry packages in organizations default to Private upon initial push. If `docker pull` returns `unauthorized`, an organization administrator must navigate to `github.com/orgs/pathbit/packages/container/ominirtksync/settings` and set the package visibility to **Public**.

---

## 2. Quick Start with Standalone Docker

If you already have an OmniRoute gateway running on your host machine or network:

```bash
docker run -d \
--name ominirtk-sync \
--restart unless-stopped \
-p 127.0.0.1:9092:9090 \
-v omniroute_data:/app/data \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Mount the gateway's actual data volume

When following this standalone quick start, -v omniroute_data:/app/data silently creates a new empty volume unless the existing gateway happens to use that exact global volume name; Compose-managed gateway volumes are normally project-prefixed, and a native or remote gateway will not use this Docker volume at all. OminiRTkSync reads storage.sqlite directly through DB_PATH, so the documented container remains DATABASE_NOT_READY; require the caller to mount the existing gateway data directory or its actual named volume rather than a generic new volume.

Useful? React with 👍 / 👎.

-v "${HOME}:/root/host:ro" \
-v ominirtksync_logs:/app/logs \
-e DB_PATH=/app/data/storage.sqlite \
-e OMNIROUTE_URL=http://host.docker.internal:20128 \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Make host gateway resolution work on Linux Engine

For users running ordinary Docker Engine on Linux, host.docker.internal is not automatically populated as it is by Docker Desktop, so this standalone command cannot reach the host OmniRoute instance. Docker's documented Linux invocation adds --add-host host.docker.internal=host-gateway; include that flag or provide a platform-specific gateway address. See the docker run --add-host documentation.

Useful? React with 👍 / 👎.

-e DASHBOARD_USER=admin \
-e DASHBOARD_PASSWORD=your-secure-password \
ghcr.io/pathbit/ominirtksync:latest
```

---

## 3. Production Deployment with Docker Compose

The standard production setup runs OmniRoute (gateway) and OminiRTkSync (synchronizer) on an isolated internal management network (`ominirtksync-net`), with optional shared inference networking (`rtk-inference-net`).

### Step 1: Initialize Configuration

```bash
cp .env.example .env
# Edit .env and configure INITIAL_PASSWORD, JWT_SECRET, and DASHBOARD_PASSWORD
```

### Step 2: Launch Stack

```bash
docker compose -f docker-compose.example.yml up -d

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Create the external network before launching Compose

On a fresh Docker host, this advertised production launch fails before starting any container because ominirtk-router always attaches to the external rtk-inference-net, despite the preceding text calling that network optional. Docker explicitly requires external networks to exist before compose up; use the repository's make setup target or document docker network create rtk-inference-net before this command. See Docker's external-network documentation.

Useful? React with 👍 / 👎.

```

### Service Map and Port Allocation

| Service | Container Name | Internal Port | Host Published Port | Purpose |
| :--- | :--- | :--- | :--- | :--- |
| **OmniRoute** | `ominirtk-router` | `20128` | `127.0.0.1:8082` | Gateway API & Admin |
| **OminiRTkSync** | `ominirtk-sync` | `9090` | `127.0.0.1:9092` | Guardian Dashboard & Healthz |
| **Headroom** *(optional)* | `ominirtk-headroom` | `8787` | `127.0.0.1:8787` | Token Compression Proxy |

Dashboard access: **http://localhost:9092**

---

## 4. Token & Cost Optimization: Headroom & Caveman

AI coding agents (such as **Claude Code**, **Cursor**, **Windsurf**, and **Roo Code**) consume vast amounts of tokens when sending large files, terminal logs, git diffs, and conversational explanations. Using **Headroom** and **Caveman** together drastically cuts token consumption and prevents rate limits.

```
┌────────────────────────────────┐
│ Coding Agent / Developer │
│ (Claude Code / Cursor) │
└───────────────┬────────────────┘
│
▼
┌────────────────────────────────┐
│ Caveman (Plugin/Skill) │ <-- Minimizes OUTPUT tokens
│ (Enforces concise responses) │
└───────────────┬────────────────┘
│
▼
┌────────────────────────────────┐
│ Headroom (Proxy: 8787) │ <-- Compresses INPUT tokens
│ (Trims logs, AST & context) │
└───────────────┬────────────────┘
│
▼
┌────────────────────────────────┐
│ OmniRoute (Gateway: 8082) │ <-- Routing & Relational Mapping
└───────────────▲────────────────┘
│
┌───────────────┴────────────────┐
│ OminiRTkSync (Guardian: 9092) │ <-- OAuth renewal & rate-limit healing
└────────────────────────────────┘
```

### Headroom: Input Token Compression Proxy

Headroom acts as a middleware proxy sitting between your coding agent and OmniRoute:
- Analyzes context payloads, logs, git diffs, and structured JSON.
- Compresses input tokens by 20% to 80% without losing critical code semantics.
- To start with Docker Compose:

```bash
docker compose -f docker-compose.example.yml --profile headroom up -d
```

Configure your coding tool to point to Headroom (`http://127.0.0.1:8787/v1`) with OmniRoute credentials. Headroom automatically proxies optimized requests to `http://ominirtk-router:20128`.

### Caveman: Output Token Reduction Skill

While Headroom compresses what the LLM *reads*, Caveman minimizes what the LLM *writes*:
- Enforces an ultra-terse, compact agent communication style ("concise mode").
- Strips conversational filler, preamble, and pleasantries while maintaining strict accuracy for code edits and terminal actions.
- Configured in Claude Code (`settings.local.json` prompt instructions) or agent system instructions.

---

## 5. Remote Access: Cloudflare Tunnel & Tailscale

By default, ports are bound to `127.0.0.1` for loopback security. When you need remote access from laptops, mobile devices, or team members, enable Cloudflare Tunnel or Tailscale.

> [!WARNING]
> **Security Prerequisite**: Before enabling any public tunnel or remote exposure, you **must** set:
> 1. `REQUIRE_LOGIN=true` (with a strong custom password)
> 2. `REQUIRE_API_KEY=true` (for coding tool authentication)
Comment on lines +140 to +141

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Make the remote-access flags configurable

When an operator follows the documented .env workflow and sets these flags before enabling the public tunnel, the values have no effect because docker-compose.example.yml passes literal REQUIRE_LOGIN=false and REQUIRE_API_KEY=false to OmniRoute, overriding the same variables in .env.example. The quick tunnel therefore exposes the gateway without either advertised protection despite the operator satisfying this prerequisite; interpolate both variables in Compose or explicitly instruct users to edit the Compose service itself.

Useful? React with 👍 / 👎.

> Exposing the gateway without these settings allows anyone with the URL to consume your LLM balances.

### Option A: Cloudflare Quick Tunnel (Ephemeral URL)

Useful for temporary demonstrations and remote testing without domain setup:

```bash
docker compose -f docker-compose.example.yml --profile tunel up -d
```

View the generated `https://...trycloudflare.com` URL in container logs:

```bash
docker logs ominirtk-tunel
```

### Option B: Cloudflare Named Tunnel (Persistent Domain)

For permanent custom domains (`omni.yourdomain.com`) with Cloudflare Zero Trust:

1. Create a tunnel in the Cloudflare Zero Trust dashboard.
2. Add your tunnel token to `.env`:
```bash
TUNNEL_TOKEN=eyJhIjoi...
```
3. Start the tunnel profile:
```bash
docker compose -f docker-compose.example.yml --profile tunel up -d
```

### Option C: Tailscale (Private Zero-Trust Tailnet — Recommended)

The safest method: your gateway joins your private tailnet and is never exposed to the public internet.

1. Generate an ephemeral or reusable auth key at `https://login.tailscale.com/admin/settings/keys`.
2. Add `TS_AUTHKEY` to `.env`:
```bash
TS_AUTHKEY=tskey-auth-...
```
3. Start the tailnet container:
```bash
docker compose -f docker-compose.example.yml --profile tailnet up -d
```
4. Access via MagicDNS at `http://ominirtk:20128` or Tailscale IP `100.x.y.z:20128`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Provide a Tailscale Serve mapping before advertising access

After these steps, neither http://ominirtk:20128 nor the Tailscale-IP equivalent forwards to OmniRoute: the inspected ominirtk-tailnet service sets TS_SERVE_CONFIG=/config/serve.json, but mounts no /config directory and supplies no Serve mapping, while its userspace network namespace does not expose another container's port automatically. Tailscale requires the JSON configuration file to be mounted and to define the endpoint-to-backend mapping, as shown in its Docker parameter documentation; add that configuration or remove this access claim.

Useful? React with 👍 / 👎.


Alternatively, install Tailscale directly on the host machine:

```bash
curl -fsSL https://tailscale.com/install.sh | sh
sudo tailscale up
tailscale ip -4
Comment on lines +190 to +192

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Rebind the gateway when installing Tailscale on the host

Following this alternative only joins the host to the tailnet; it does not make the gateway reachable because docker-compose.example.yml publishes OmniRoute exclusively on 127.0.0.1:8082. Requests to the host's 100.x.y.z address therefore never reach that loopback-only listener. Document changing the port mapping to bind the discovered Tailscale IP (using host port 8082, not container port 20128) before presenting host-installed Tailscale as an equivalent remote-access path.

Useful? React with 👍 / 👎.

```

---

## 6. Container Healthchecks & Monitoring

Verify the status of all services:

```bash
docker compose -f docker-compose.example.yml ps
```

The synchronizer exposes `/healthz` on port 9090 (host 9092):
- `OK` (HTTP 200): Synchronizer active and gateway reachable.
- `DATABASE_NOT_READY` (HTTP 503): Database path not found.
- `GATEWAY_SERVICE_UNREACHABLE` (HTTP 503): OmniRoute gateway not answering.

---

*(Versão em Português)*

# Guia de Implantação via Docker e Docker Compose

Guia completo para implantar o **OminiRTkSync** e o **OmniRoute** via Docker e Docker Compose, com otimização de tokens via **Headroom** e **Caveman**, acesso remoto seguro via **Cloudflare Tunnel** e **Tailscale**, e retenção automatizada de imagens no GitHub Packages.

## 1. Pacotes Oficiais e Política de Retenção de 3 Versões

As imagens oficiais multi-arquitetura (`linux/amd64` e `linux/arm64`) são geradas e publicadas no GitHub Container Registry (GHCR):

```bash
docker pull ghcr.io/pathbit/ominirtksync:latest
```

### Retenção Automática das 3 Últimas Versões

O pipeline do GitHub Actions garante que:
- **Sempre mantemos as 3 versões mais recentes**: a tag ativa `latest` mais as 2 versões/tags marcadas anteriores.
- Os manifestos multi-plataforma são resolvidos antes da limpeza para evitar a quebra de camadas.
- A limpeza ocorre ao término de cada build de release e em agendamento semanal.

> [!NOTE]
> **Visibilidade no GHCR**: Por padrão de segurança do GitHub, pacotes criados sob organizações nascem com visibilidade Privada. Se o comando `docker pull` responder com `unauthorized`, o administrador da organização no GitHub deve acessar as configurações do pacote (`github.com/orgs/pathbit/packages/container/ominirtksync/settings`) e alterar a visibilidade para **Public**.

## 2. Implantação Rápida com Docker Run

Para executar o sincronizador apontando para um OmniRoute já existente:

```bash
docker run -d \
--name ominirtk-sync \
--restart unless-stopped \
-p 127.0.0.1:9092:9090 \
-v omniroute_data:/app/data \
-v "${HOME}:/root/host:ro" \
-v ominirtksync_logs:/app/logs \
-e DB_PATH=/app/data/storage.sqlite \
-e OMNIROUTE_URL=http://host.docker.internal:20128 \
-e DASHBOARD_USER=admin \
-e DASHBOARD_PASSWORD=sua-senha-segura \
ghcr.io/pathbit/ominirtksync:latest
```

## 3. Implantação Completa com Docker Compose

```bash
# 1. Prepare as variáveis de ambiente
cp .env.example .env

# 2. Inicie a stack
docker compose -f docker-compose.example.yml up -d
```

Acesse o painel web em: **http://localhost:9092**

## 4. Otimização de Tokens: Headroom e Caveman

A combinação de **Headroom** e **Caveman** atua em duas frentes complementares:
1. **Headroom (Entrada/Input):** Middleware proxy que intercepta context windows, logs de compilação e comandos git diff, compactando a carga antes do envio ao OmniRoute. Ative via perfil:
```bash
docker compose -f docker-compose.example.yml --profile headroom up -d
```
Aponte seus clientes para `http://127.0.0.1:8787/v1`.
2. **Caveman (Saída/Output):** Instrução de estilo conciso para agentes (Claude Code / Cursor) que elimina rodeios e respostas prolixas, gerando respostas diretas e economizando 30% a 60% de tokens de saída.

## 5. Acesso Remoto: Cloudflare Tunnel e Tailscale

Regra essencial de segurança: antes de expor qualquer rota, ative `REQUIRE_LOGIN=true` e `REQUIRE_API_KEY=true`.

- **Cloudflare Tunnel Rápido:** `docker compose -f docker-compose.example.yml --profile tunel up -d`
- **Cloudflare Tunnel Nomeado:** Preencha `TUNNEL_TOKEN` no `.env` e suba o perfil `tunel`.
- **Tailscale (VPN Privada):** Preencha `TS_AUTHKEY` no `.env` e execute `docker compose -f docker-compose.example.yml --profile tailnet up -d`.
1 change: 1 addition & 0 deletions docs/wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ republishes these pages automatically. Editing a page directly here will be over
| Page | What it covers |
| :--- | :--- |
| [Installation](Installation) | Docker Compose and local virtual environment |
| [Docker Deployment](Docker-Deployment) | Docker run, Compose, Headroom, Caveman, Tunnel, Tailscale |
| [Configuration](Configuration) | Every environment variable — the full headless contract |
| [Dashboard](Dashboard) | The server-rendered panel, language switcher, cron logs |
| [Authentication](Authentication) | Credentials, headless mode, break-glass recovery |
Expand Down
1 change: 1 addition & 0 deletions docs/wiki/Installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Installation

Two supported paths: Docker (recommended) and a local Python virtual environment.
For a complete guide covering Docker run, Compose, Headroom, Caveman, Tunnel, and Tailscale, see [Docker Deployment](Docker-Deployment).

---

Expand Down
1 change: 1 addition & 0 deletions docs/wiki/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [Home](Home)
- [Installation](Installation)
- [Docker Deployment](Docker-Deployment)
- [Configuration](Configuration)
- [Dashboard](Dashboard)
- [Authentication](Authentication)
Expand Down
2 changes: 1 addition & 1 deletion tools/valida_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
# CLI deste produto.
"--profile", "--env-file", "--remove-orphans", "--wait",
"--wait-timeout", "--force-recreate", "--no-autoupdate", "--url",
"--token", "-d", "-f",
"--token", "-d", "-f", "--name", "--restart",
}

# Rotas do GATEWAY, nao do painel. A pagina de saida de rede cita a API do
Expand Down
Loading