From 3943e79bb1116d0e070434a87da48a6c26e4fac1 Mon Sep 17 00:00:00 2001 From: duffyduck Date: Fri, 10 Apr 2026 08:45:26 +0200 Subject: [PATCH] docs: document .env.example with detailed comments, explain both tokens in README - ARIA_AUTH_TOKEN: Gateway auth (who can talk to ARIA) - RVS_TOKEN: Pairing token (same room in RVS relay) - RVS_UPDATE_HOST: SSH target for auto-update APK copy - All variables with German comments and examples Co-Authored-By: Claude Opus 4.6 (1M context) --- .env.example | 44 +++++++++++++++++++++++++++++++++++++------- README.md | 19 +++++++++++++++++-- 2 files changed, 54 insertions(+), 9 deletions(-) diff --git a/.env.example b/.env.example index 380f43a..370d705 100644 --- a/.env.example +++ b/.env.example @@ -1,20 +1,50 @@ -# ARIA Environment Configuration -# Copy to .env and fill in values +# ════════════════════════════════════════════════ +# ARIA — Umgebungsvariablen +# Kopieren nach .env und Werte eintragen +# ════════════════════════════════════════════════ -# Auth token for ARIA Core (generate a long random string) -# openssl rand -hex 32 +# ── ARIA Auth Token ────────────────────────────── +# Authentifizierung fuer den OpenClaw Gateway (aria-core). +# Wird von Diagnostic, Bridge und App genutzt um sich am Gateway anzumelden. +# Alle Services die mit aria-core kommunizieren brauchen diesen Token. +# Generieren: openssl rand -hex 32 ARIA_AUTH_TOKEN=change-me-to-a-long-random-string -# RVS — Rendezvous-Server (Bridge + App verbinden sich hierüber) +# ── RVS — Rendezvous-Server ───────────────────── +# Der RVS ist ein WebSocket-Relay im Rechenzentrum. +# App, Bridge, Diagnostic und XTTS-Bridge verbinden sich hierueber. +# Alle muessen den gleichen Host, Port und Token nutzen. + +# Hostname des RVS-Servers (z.B. rvs.example.de oder mobil.hacker-net.de) RVS_HOST=rvs.example.de + +# Port auf dem der RVS laeuft (muss mit rvs/docker-compose.yml uebereinstimmen) RVS_PORT=443 + +# TLS (wss://) verwenden? true = verschluesselt, false = unverschluesselt (ws://) RVS_TLS=true + # Bei TLS-Fehler automatisch auf ws:// (ohne TLS) fallback? -# true = Fallback erlaubt, false = nur mit TLS verbinden +# Nuetzlich wenn kein TLS-Zertifikat vorhanden (z.B. Entwicklung) RVS_TLS_FALLBACK=true + +# Pairing-Token: Wer den gleichen Token hat, landet im gleichen RVS-Room. +# Wird von generate-token.sh automatisch generiert und hier eingetragen. +# Die Android App bekommt den Token per QR-Code beim Pairing. +# WICHTIG: Muss auf ARIA-VM, Gaming-PC (xtts/.env) und App identisch sein! +# Generieren: ./generate-token.sh (traegt den Token automatisch ein) RVS_TOKEN= -# Gitea (for release.sh — Kennwort wird interaktiv abgefragt) +# ── Gitea — Release-Verwaltung ─────────────────── +# Wird von release.sh genutzt um APKs auf Gitea zu veroeffentlichen. +# Kennwort wird beim Release interaktiv abgefragt (nicht in .env!). GITEA_URL=https://git.hacker-net.de GITEA_REPO=Hacker-Software/ARIA-AGENT GITEA_USER=duffyduck + +# ── Auto-Update — APK auf RVS-Server kopieren ─── +# SSH-Ziel fuer scp: release.sh kopiert die APK dorthin. +# Der RVS-Server stellt sie dann per WebSocket an die App bereit. +# Format: user@host (z.B. root@aria-rvs oder root@rvs.example.de) +# Leer lassen = Auto-Update ueberspringen, APK manuell auf RVS kopieren. +RVS_UPDATE_HOST= diff --git a/README.md b/README.md index 61de3a1..51486b1 100644 --- a/README.md +++ b/README.md @@ -103,16 +103,31 @@ cd ~/ARIA-AGENT cp .env.example .env ``` -`.env` Datei editieren: +`.env` Datei editieren (Details siehe `.env.example`): ```bash +# Gateway-Auth: Alle Services die mit aria-core reden brauchen diesen Token +# Diagnostic, Bridge, App nutzen ihn fuer den WebSocket-Handshake ARIA_AUTH_TOKEN= # openssl rand -hex 32 + +# RVS-Verbindung: Hostname + Port deines Rendezvous-Servers RVS_HOST= # z.B. rvs.hackersoft.de RVS_PORT=443 RVS_TLS=true RVS_TLS_FALLBACK=true -RVS_TOKEN= # wird von generate-token.sh automatisch gesetzt + +# Pairing-Token: Verbindet App, Bridge, Diagnostic und XTTS im gleichen RVS-Room +# MUSS auf allen Geraeten identisch sein (ARIA-VM, Gaming-PC, App) +# Wird von generate-token.sh automatisch generiert und eingetragen +RVS_TOKEN= # ./generate-token.sh + +# Optional: SSH-Host des RVS-Servers fuer Auto-Update (z.B. root@aria-rvs) +RVS_UPDATE_HOST= ``` +**Zwei Tokens, zwei Zwecke:** +- **ARIA_AUTH_TOKEN**: Authentifizierung am OpenClaw Gateway (aria-core). Wer diesen Token hat, kann ARIA Befehle geben. +- **RVS_TOKEN**: Pairing-Token fuer den Rendezvous-Server. Alle Geraete mit dem gleichen Token landen im gleichen "Room" und koennen kommunizieren. Die App bekommt diesen Token per QR-Code. + ### 2. Claude CLI einloggen (Proxy-Auth) Der Proxy-Container nutzt deine Claude Max Subscription. Die Credentials muessen