Alle Seiten
Auf dieser Seite

Erster Start

Sobald der Befehl oar installiert ist (siehe Installation), trennen dich drei Dinge von einer Konversation: Das Relay braucht eine Config (einen Port, wer es erreichen darf, und ein Zugriffstoken), es muss laufen, und dein Browser muss sich mit dem Token anmelden. Diese Seite geht sie in dieser Reihenfolge durch.

Einrichtung #

oar setup schreibt die Config-Datei, config.json im Zustandsordner von OAR (~/.oar auf macOS und Linux, %APPDATA%\oar auf Windows; die Umgebungsvariable OAR_STATE_ROOT verlegt ihn). Sie legt drei Dinge fest, auf Windows zusätzlich den Autostart:

Einstellung Bedeutung Standard für eine neue Config
Zugriffstoken Das Geheimnis, mit dem sich jeder Browser anmeldet. Ein zufälliges, für dich erzeugt.
Zugriff This machine only (nur dieser Rechner) oder LAN (andere Geräte in deinem Netzwerk). Nur dieser Rechner.
Port Der Port, auf dem das Relay lauscht. 3333 oder der erste freie Port ab 3333.
Autostart (Windows) Neu in 0.9.15 Ob das Relay von selbst startet: bei der Anmeldung, beim Hochfahren, bevor sich jemand anmeldet, oder gar nicht. Nicht Teil der Config. Der aktive Modus; bei einer Neuinstallation aus.

Der Installer für macOS und Linux hat oar setup --defaults --start bereits für dich ausgeführt; ein Relay läuft also mit diesen Standardwerten, und der Installer hat seine Adresse ausgegeben. Der Windows-Installer endet mit oar setup, das die Fragen unten stellt, das Relay aber nicht startet: Führe danach oar start aus. Nach einem manuellen npm install -g führst du oar setup selbst aus, dann oar start.

In einem Terminal stellt oar setup drei Fragen und zeigt jedes Mal den aktuellen Wert, sodass Enter ihn behält. Neu in 0.9.15 Auf Windows stellt es eine vierte, wie das Relay startet (Autostart):

New auth token? It signs every device out.
Access: 1 = this machine only, 2 = LAN (other devices on your network) [1]:
Port [3333]:
Autostart: 1 = at sign-in, 2 = at boot, before anyone signs in (one administrator prompt), 3 = off [3]:

At boot (Beim Hochfahren) verlangt eine Administrator-Bestätigung am PC; eine abgelehnte Abfrage ändert nichts, und setup schreibt die Config trotzdem.

Der gewählte Port muss frei sein. Setup akzeptiert keinen Port, den ein anderes Programm belegt, und auf WSL keinen, den Windows belegt: Mit --port bricht es ab, bei der Frage fragt es erneut. Das Relay derselben Installation darf seinen eigenen Port behalten.

Setup nimmt auch Optionen. Gibst du eine von --port, --lan, --local, --new-token oder --autostart an, fragt setup gar nichts; was du nicht angibst, behält seinen aktuellen Wert.

Option Was sie tut
--port <port> Nutzt diesen Port (eine Zahl von 1 bis 65535).
--lan Macht das Relay von anderen Geräten in deinem Netzwerk erreichbar.
--local Beschränkt das Relay auf diesen Rechner. Nicht mit --lan kombinierbar.
--new-token Ersetzt das Zugriffstoken. Jeder angemeldete Browser wird abgemeldet.
--autostart signin|boot|off Neu in 0.9.15 Stellt um, wie das Relay von selbst startet, wie oar autostart. Nur für globale Installationen.
--defaults Fragt nichts. Eine vorhandene Config bleibt, wie sie ist; eine neue bekommt nur dieser Rechner und den ersten freien Port ab 3333.
--start Startet zusätzlich das Relay und installiert auf Linux mit systemd-Benutzersession den Dienst, der es bei jeder Anmeldung startet. Der Installer nutzt das.
--migrate-from <dir> Für einen früheren Git-Checkout von OAR aus der Zeit vor der Umbenennung: kopiert den Relay-Zustand des Checkouts in <dir> in den Zustandsordner von OAR. Der Checkout wird nie verändert. Abgelehnt, solange noch ein Relay daraus läuft. Es läuft jedes Mal, wenn du einen Ordner nennst: Einer, der schon übernommen wurde, meldet das nur, und einer ohne etwas zu übernehmen ist ein Fehler. Siehe Eine alte Installation umziehen.

Läuft ein Relay und du änderst Token, Port oder Zugriff, startet setup es neu, damit die Änderung greift. In einem Terminal fragt es vorher (The relay is running. Restart it now to apply the change?); mit --defaults oder ohne Terminal startet es sofort neu. Antwortest du mit nein, behält das laufende Relay seine bisherigen Einstellungen bis oar restart.

Am Ende gibt setup die Relay-Adresse aus und einen QR-Code, wenn ein Handy sie erreichen kann (siehe Vom Handy aus).

Starten und stoppen #

Führe oar ohne Argumente in einem Terminal aus, um ein Menü zu bekommen: einen Header mit dem Status des Relays (läuft oder gestoppt, Version, Adresse, Port, Zugriff, Dienst) und einem Eintrag für jeden Befehl. Nutze die Pfeiltasten oder eine Ziffer und Enter; q beendet. Außerhalb eines Terminals gibt oar stattdessen den Status und die Hilfe aus.

Die Befehle, die du zuerst brauchst:

Befehl Was er tut
oar start Startet das Relay im Hintergrund und gibt seine Adresse aus. Ein bereits laufendes Relay bleibt unberührt.
oar status Sagt, ob das Relay läuft, auf welchem Port und mit welchem Zugriff. Sein Exit-Code ist 0, wenn das Relay läuft, und 3, wenn nicht.
oar url Gibt die Adresse erneut aus, mit dem Token, und einen QR-Code, wo ein Handy sie nutzen kann.
oar stop Stoppt das Relay. Es wartet, bis kein Turn mehr läuft.
oar restart Startet es neu und wartet ebenfalls auf laufende Turns.

oar start gibt eine Zeile wie diese aus:

[oar] Relay URL: http://localhost:3333/?token=<your token>

Behandle diese Adresse wie ein Passwort: Sie enthält das Token. Ist der Zugriff auf nur diesen Rechner gesetzt, sagt eine zweite Zeile das und nennt die zwei Wege, es vom Handy aus zu erreichen: LAN-Zugriff oder einen Tunnel.

Das Relay öffnen #

Öffne die ausgegebene Adresse in einem Browser auf dem Rechner, auf dem das Relay läuft. Der Teil ?token= meldet dich an. Das Relay hält den Browser dann mit einem Cookie angemeldet, das 30 Tage gilt, und die Adresszeile des Browsers verliert das Token. Das Cookie ist HttpOnly und wird als Secure markiert, wenn du das Relay über HTTPS erreichst.

Ohne das Token in der Adresse zeigt das Relay ein Anmeldefeld mit Enter your access token to connect (Gib dein Zugriffstoken ein, um dich zu verbinden). Füge das Token ein und drücke Connect (Verbinden). Ein falsches zeigt Invalid token (Ungültiges Token).

Vom Handy aus #

Für ein Handy oder einen anderen Computer im selben Netzwerk schaltest du den LAN-Zugriff ein:

oar setup --lan

Läuft das Relay, startet setup es neu (in einem Terminal fragt es vorher). Es gibt eine Adresse mit der Netzwerkadresse deines Rechners anstelle von localhost aus, zusammen mit einem QR-Code. Scanne ihn mit dem Handy. oar url gibt dieselbe Adresse und denselben Code später aus. Der QR-Code erscheint nur, wenn das Relay LAN-Zugriff hat und der Rechner eine Netzwerkadresse hat; mit LAN-Zugriff ohne Netzwerkadresse sagt der Befehl das. Auf WSL mit Standard-Netzwerkmodus ist die Adresse WSL-intern, und andere Geräte erreichen sie nicht, daher gibt setup keinen Code aus: Nutze einen Tunnel oder stelle WSL auf den Mirrored-Netzwerkmodus um (networkingMode=mirrored in .wslconfig).

Die Adresse ist einfaches http. Außerhalb deines eigenen Netzwerks nutze einen der Tunnel von OAR, die HTTPS hinzufügen (siehe Von außerhalb deines Netzwerks).

Wenn du das Token verlierst #

oar url gibt die Adresse mit dem aktuellen Token aus. Willst du lieber ein neues, führe oar setup --new-token aus: Es schreibt ein neues Token und startet das Relay neu (in einem Terminal fragt es vorher), und jedes Gerät, das angemeldet war, muss sich mit der neuen Adresse neu anmelden.

Der erste Blick #

Der erste Bildschirm ist die leere Konversationsansicht. Was dort steht, hängt vom Relay ab:

  • Set up a provider (Provider einrichten), wenn kein Provider bereit ist. Es bietet Open Settings (Einstellungen öffnen) und + New chat (Neuer Chat). GitHub Copilot ist der Standard-Provider; er braucht eine angemeldete Copilot CLI auf dem Relay-Host. Die anderen schaltest du unter Settings → Providers (Einstellungen → Provider) ein. Provider im Überblick sagt, was jeder braucht.
  • Start your first chat (Starte deinen ersten Chat), wenn ein Provider bereit ist. + New chat ist der Hauptbutton.

⚙️ Settings ist im ⋯-Menü oben in einer Konversation, und der leere Bildschirm hat ebenfalls einen Button dafür. Auf einem schmalen Bildschirm zeigt der Button ☰ die Konversationsliste.

+ New Chat in der Seitenleiste öffnet den Dialog, in dem du Provider, Modell und Arbeitsordner wählst. Eine Konversation starten beschreibt ihn Feld für Feld.

Am Laufen halten #

oar start lässt das Relay laufen, bis du es stoppst oder der Rechner neu startet. Damit es bei jeder Anmeldung startet, richtet oar service install das auf Linux mit systemd-Benutzersession und auf Windows ein; das Menü hat einen Eintrag dafür. Neu in 0.9.15 Auf Windows startet oar autostart boot es stattdessen beim Hochfahren, bevor sich jemand anmeldet. Auf macOS gibt es das noch nicht: Starte das Relay dort mit oar start.

Von außerhalb deines Netzwerks #

OAR hat eingebaute Tunnel-Unterstützung, um das Relay von außerhalb deines Netzwerks über HTTPS zu erreichen: einen Cloudflare Tunnel oder einen SSH-Tunnel. Lies vorher Was OAR offenlegt.

Wenn es nicht startet #

Was du siehst Was du tust
Port 3333 is in use by another program (or by a relay with another token). von oar start Ein anderes Programm nutzt den Port, oder ein Relay mit einem früheren Token läuft noch. Die Meldung schlägt oar setup --port <port> vor.
Port 3333 is held by another program, or by a relay with another token. von oar status, oar stop oder oar restart Dieselbe Ursache. oar stop und oar restart fügen eine zweite Zeile mit der Prozess-ID hinzu, wenn ein Relay dieser Installation zu laufen scheint: Starte es über seine Web-Oberfläche neu, im ⋯-Menü mit 🌄 Restart web relay (Web-Relay neu starten), oder beende diesen Prozess, dann führe oar start aus. oar status gibt keinen solchen Hinweis.
Port 3333 is in use by another program. von oar setup Dieselbe Ursache. Setup fragt nach einem anderen Port oder fordert dich mit --port auf, einen zu wählen.
The relay did not come up — see …/server-err.log Das Relay ist gestartet und hat sich beendet. Die Meldung nennt die Logdatei im Ordner logs von OAR; lies die letzten Zeilen. oar doctor zeigt die verwendete Installation, den Zustandsordner und die Config.
Ein von Hand gestarteter Server beendet sich sofort mit Relay already running oder Relay appears to be owned by another live process Pro Datenordner darf nur ein Relay laufen. Die Meldung erscheint in diesem Terminal oder in server-err.log, wenn oar es gestartet hat, und nennt die Prozess-ID des Relays, das die Sperre hält, sowie die Sperrdatei. Neu in 0.9.14 Sie endet mit dem, was zu tun ist (oar stop, or end process <pid>), und das Relay beendet sich mit Code 78. Stoppe dieses Relay mit oar stop und starte dann erneut. Siehe Ein Relay pro Datenordner.
WSL: Der Browser unter Windows zeigt eine andere Seite oder lehnt das Token ab Im Standard-Netzwerkmodus von WSL kann ein Port in der Distro frei sein, während ein Windows-Programm darauf lauscht, und localhost:<port> in einem Windows-Browser erreicht dann dieses Programm. oar setup wählt einen Port, der auf beiden Seiten frei ist, und oar status, oar start und oar doctor warnen, wenn Windows den Port belegt. Wähle mit oar setup --port <port> einen anderen.
Invalid token im Anmeldefeld Nutze das Token aus oar url, das das aktuelle ausgibt. Nach --new-token oder einer Token-Änderung in der Config funktionieren alte Adressen nicht mehr.
The relay runs with its earlier settings; restart it to apply the new ones. Du hast Token, Port oder Zugriff geändert, während das Relay lief. oar restart übernimmt die Änderungen.