Das Relay automatisch starten

oar start lässt das Relay im Hintergrund laufen, bis du es stoppst oder der Rechner neu startet. Damit das Relay von selbst wiederkommt, installiere den Autostart: oar service install Neu in 0.9.9 richtet ihn auf Linux und Windows ein. Neu in 0.9.15 oar autostart wählt einen der beiden Windows-Modi, bei der Anmeldung oder beim Hochfahren, und oar setup fragt auf Windows danach. Danach brauchst du kein offenes Terminal mehr, und auf einem Host ohne Bildschirm musst du dich nicht anmelden.

Der Dienst betreibt dasselbe Relay wie oar start: dieselbe Config, denselben Datenordner und denselben Log-Ordner. An deinen Konversationen ändert sich nichts. Neu in 0.9.14 Auf Windows gilt das auch für beide Autostart-Modi; vor 0.9.14 hielten sie die Daten im installierten Paket (siehe Datenordner der Windows-Einträge).

Die Befehle #

oar service install
oar service status
oar service remove

oar service status ist der Standard, wenn du kein Wort angibst. Die Befehle sind für globale Installationen; in einem Git-Checkout sagen sie das und tun nichts. oar allein öffnet ein Menü mit einem Eintrag für dasselbe (Install or remove the service, Dienst installieren oder entfernen). oar setup --start und der Installer für macOS und Linux installieren den Linux-Dienst für dich, wo es eine systemd-Benutzersession gibt.

oar service install braucht eine Config: Führe vorher oar setup aus.

Neu in 0.9.15 oar autostart nennt den Modus statt eines Dienstes:

oar autostart signin    # Windows: at sign-in
oar autostart boot      # Windows: at boot, before anyone signs in
oar autostart off
oar autostart status    # the default when you give no word

Auf Windows ist es der Befehl für beide Modi, mit denselben Regeln wie das Steuerelement Autostart (Windows) in Settings (Einstellungen). Auf Linux ist es oar service: signin und boot führen beide oar service install aus, off führt oar service remove aus und status führt oar service status aus. Auf macOS meldet es Autostart is not supported on macOS yet. Start the relay with: oar start. In einem Git-Checkout sagt es, dass es für globale Installationen ist. signin und boot brauchen eine Config; off und status nicht.

Linux: der systemd-Benutzerdienst #

Neu in 0.9.8

Der Dienst heißt oar. oar service install schreibt seine Unit-Datei nach ~/.config/systemd/user/oar.service, aktiviert und startet ihn. Außerdem führt es loginctl enable-linger für deinen Benutzer aus. Lingering hält deine Benutzerdienste aktiv, während niemand angemeldet ist, sodass das Relay nach einem Neustart wieder da ist und nach dem Abmelden weiterläuft. Nichts davon braucht sudo. Lässt sich Lingering nicht aktivieren, sagt der Befehl das und nennt die Zeile, die du selbst ausführen musst, denn ohne Lingering stoppt das Relay beim Abmelden:

loginctl enable-linger "$USER"

Die Unit startet das Relay mit dem Node.js, das den Befehl ausgeführt hat, und startet es nach einem Absturz neu (Restart=on-failure, nach 5 Sekunden). Neu in 0.9.14 Ein Relay, das mit Exit-Code 78 beendet wurde, startet sie nicht neu (RestartPreventExitStatus=78): Das Relay nutzt diesen Code, wenn es nicht auf seinen Daten laufen kann, zum Beispiel wenn ein anderes Relay seine Sperre hält (siehe Wenn es nicht funktioniert). Einer Unit, die eine frühere Version geschrieben hat, fehlt die Zeile, bis du oar service install erneut ausführst. Die Unit übernimmt den PATH der Shell, die oar service install ausgeführt hat, plus ~/.local/bin und den Ordner dieses Node.js, weil ein systemd-Benutzerdienst sonst mit einem kahlen PATH startet. Die Sessions des Relays finden die Provider-CLIs und node darüber. Hat sich dein PATH geändert, führe oar service install erneut aus und dann oar restart: install schreibt die Unit neu, startet einen bereits laufenden Dienst aber nicht neu.

Läuft ein Relay, das du von Hand gestartet hast, stoppt install es zuerst, damit der Dienst den Port übernehmen kann. Ist dieses Relay beschäftigt und stoppt nicht sofort, wird der Dienst installiert und übernimmt bei der nächsten Anmeldung, oder wenn du oar start ausführst, sobald das Relay gestoppt ist.

Starten, stoppen und neu starten #

Mit installiertem Dienst laufen oar start, oar stop und oar restart über systemd.

Status und Logs #

systemctl --user status oar

zeigt, ob der Dienst läuft. Die Unit leitet die Ausgabe des Relays nicht um, daher hält systemd sie im Journal: journalctl --user -u oar liest es.

Die Unit setzt den Log-Ordner des Relays außerdem auf den Ordner logs im Zustandsordner von OAR (standardmäßig ~/.oar/logs). Das Relay legt dort eine Kopie seiner Konsole in relay-console.log ab, und jeder Session-Worker schreibt ein worker-<session>.log. oar doctor gibt den Zustandsordner aus, unter dem sie liegen.

Windows #

Neu in 0.9.2

Windows hat zwei Autostart-Modi. Beide betreiben dasselbe Relay mit derselben Config.

Das Steuerelement ist unter ⚙️ Settings → General (Einstellungen → Allgemein) und heißt Autostart (Windows). Es erscheint nur auf einem Windows-Relay und hat drei Optionen:

Off
At sign-in — visible terminal after you log on
At system startup — headless, no logon needed

Neu in 0.9.15 In einem Terminal auf Windows fragt oar setup als letzte Frage nach dem Modus, mit dem aktiven Modus als Standard:

Autostart: 1 = at sign-in, 2 = at boot, before anyone signs in (one administrator prompt), 3 = off [3]:

Enter behält den Modus, wie er ist. oar setup --autostart signin|boot|off setzt ihn ohne die Frage. Kann der Start-Task nicht gelesen werden, fragt setup nicht. Geht die Umstellung nicht durch, schreibt setup die Config trotzdem, meldet The config is written; the autostart step did not go through (see above). und beendet sich mit 1.

Jede Umstellung entfernt den Eintrag des anderen Modus, aber nur einen, den OAR erzeugt hat (siehe Einträge, die OAR nicht angelegt hat).

At sign-in #

Wähle At sign-in, oder führe oar autostart signin oder oar service install aus. Alle schreiben denselben Eintrag, oar-web-relay.cmd in deinem Autostart-Ordner, sodass Befehle und Steuerelement übereinstimmen. oar autostart off, oar service remove oder Off (Aus) löscht ihn. Keiner davon startet das Relay sofort: Das Relay startet bei deiner nächsten Anmeldung, oder jetzt mit oar start. Der Wechsel vom Boot-Modus zur Anmeldung braucht die Admin-Bestätigung, die den Start-Task entfernt.

At system startup #

Wähle At system startup, oder führe oar autostart boot aus. Das Registrieren eines Start-Tasks braucht Administratorrechte, und das Relay läuft ohne sie, daher fragt Windows nach einer Admin-Bestätigung; erhöht läuft nur der Aufruf von schtasks. Die Abfrage erscheint nur auf dem Desktop des PCs selbst. oar autostart gibt Confirm the administrator prompt to register the boot task … aus und wartet. In einem Browser auf einem anderen Gerät zeigt Settings Confirm the admin prompt on the PC…. Beide warten bis zu zwei Minuten; eine Abfrage, die bis dahin niemand beantwortet hat, gilt als gescheitert. Die Aufgabe läuft als dein Benutzer ohne gespeichertes Passwort. Lokale Dateien und der Tunnel funktionieren wie gewohnt; für Netzwerkfreigaben hat die Aufgabe keine Zugangsdaten.

Der Wechsel zurück zu Off oder At sign-in (oar autostart off, oar autostart signin) braucht dieselbe Bestätigung, um die Aufgabe zu entfernen. Neu in 0.9.15 Das Steuerelement schaltet den Anmeldeeintrag erst ein, wenn diese Abfrage bestätigt wurde und die Aufgabe weg ist.

Neu in 0.9.15 Eine abgelehnte Abfrage ändert nichts: Nothing changed: the administrator prompt was declined. Der vorherige Modus bleibt, wie er war, und keine Datei bleibt zurück. Scheitert die Umstellung selbst nach der Abfrage, stellt sie die gelöschten Aufgaben aus ihren Kopien wieder her (<task>.task.xml.bak im OAR-Ordner, %APPDATA%\oar), behält die Kopien und meldet den Fehler. Wurde die Abfrage bestätigt, aber die Aufgabe lässt sich danach nicht zurücklesen, sagt OAR das, nennt die Kopien und macht nichts rückgängig. In der Web-Oberfläche zeigt ein Fehler das Problem und einen Befehl, den du stattdessen in einer PowerShell mit Administratorrechten ausführen kannst.

Neu in 0.9.15 Der Boot-Modus lässt sich auch mit einem Leerzeichen, einem Apostroph oder Nicht-ASCII-Zeichen in deinem Profilpfad ein- und ausschalten, zum Beispiel C:\Users\Jürgen. Frühere Versionen scheiterten dort oder hielten OARs eigene Aufgabe für eine von Hand angelegte.

Der Start-Task startet ein Launcher-Skript, das OAR erzeugt, oar-web-relay-launcher.cmd im OAR-Ordner. Neu in 0.9.11 Der Launcher hängt den Ordner von Node.js ans Ende von PATH. Das Relay startet seine Worker mit seinem eigenen Node.js über den vollen Pfad, sodass sie starten, obwohl der PATH der Aufgabe kein node enthält (Der Agent-Prozess).

Fehlt ein erzeugter Launcher oder stammt er von einer früheren Version, nennt Settings den Unterschied, statt einen Fehler zu melden, und erneutes Wählen von At system startup (oder oar autostart boot) erzeugt ihn neu. Scheitert eine Änderung der Einstellung, zeigt Settings den Grund des Relays. Gibt es neben dem Start-Task einen Anmeldeeintrag, warnt die Einstellung, dass das Relay doppelt starten kann; wähle At system startup erneut, um aufzuräumen.

oar service meldet diesen Modus nur. Solange der Start-Task besteht, lehnen oar service install und oar service remove ab und verweisen dich auf oar autostart signin|off oder Settings; oar service status gibt on, at boot (scheduled task) aus.

Status Neu in 0.9.15 #

oar autostart status gibt den Modus aus, dann jeden vorhandenen Eintrag und ob OAR ihn erzeugt hat:

[oar] Autostart: at boot, before anyone signs in (scheduled task)
[oar]   scheduled task \oar-relay (generated by OAR)
[oar]   C:\Users\dev\AppData\Roaming\oar\oar-web-relay-launcher.cmd (generated by OAR)

Der Modus ist at sign-in (Startup folder), at boot, before anyone signs in (scheduled task), off oder unknown, the boot task could not be read (<reason>). Ein von Hand angelegter Eintrag lautet <path> (hand-made), und einer, den eine andere OAR-Installation hinterlassen hat, <path> (hand-made: it starts the OAR install in <folder>). Gibt es einen, sagt eine letzte Zeile, wie du ihn ersetzt.

Einträge, die OAR nicht angelegt hat Neu in 0.9.15 #

OAR ändert nur Autostart-Einträge, die genau so sind, wie eine OAR-Version sie für diese Installation erzeugt hat, in der Web-Oberfläche wie in oar autostart. Jeder andere Eintrag ist hand-made (von Hand angelegt) und wird nie gelöscht oder überschrieben:

• ein Autostart-Eintrag, den du bearbeitet hast, oder einer einer anderen OAR-Installation oder Config;
• der Start-Task, wenn er von dem abweicht, den OAR registriert, im Konto, in der Ausführungsebene, in seiner einen Aktion, seinem einen Boot-Trigger oder seinen Einstellungen;
• ein Launcher, den du bearbeitet hast;
• eine Aufgabe namens oar-relay, die jemand anderes angelegt hat, und der Start-Task aus der Zeit vor der Umbenennung.

Solange ein von Hand angelegter Eintrag neben dem neuen Modus bliebe oder von ihm ersetzt würde, ändert eine Umstellung nichts und nennt den Eintrag:

[oar] Nothing changed: OAR does not delete or overwrite an autostart entry it did not make. Remove it yourself, or replace it keeping a copy: oar autostart boot --replace.
[oar] Left as it is: C:\Users\dev\AppData\Roaming\oar\oar-web-relay-launcher.cmd (hand-made).

Die Web-Oberfläche zeigt dieselbe Meldung. Ein von Hand angelegter Eintrag des gewählten Modus dient diesem Modus und bleibt (Left as it is: …). Um von Hand angelegte Einträge durch OARs eigene zu ersetzen, führe die Umstellung mit --replace aus:

oar autostart boot --replace

Sie legt zuerst eine Kopie jedes Eintrags an, als <name>.bak im OAR-Ordner (%APPDATA%\oar): die des Launchers daneben, das exportierte XML einer Aufgabe als <task>.task.xml.bak, das schtasks /create /xml zurücknimmt, und die eines Autostart-Eintrags ebenfalls dort, weil Windows eine im Autostart-Ordner gelassene Kopie bei der Anmeldung öffnen würde. Eine frühere Kopie wird nie überschrieben: Die nächste heißt .bak-2. Nur --replace ersetzt einen von Hand angelegten Eintrag.

Ein Start-Task, den OAR nicht lesen kann, zum Beispiel einer, der das Passwort eines anderen Kontos speichert und mit Access is denied antwortet, gilt nie als fehlend. Status meldet unknown, the boot task could not be read (<reason>), und jede Umstellung, --replace eingeschlossen, bricht mit Nothing changed: the boot task could not be read (<reason>). ab.

Warten auf TEMP und das Datenlaufwerk Neu in 0.9.14 #

Beide Modi warten, bevor sie das Relay starten: insgesamt bis zu 5 Minuten auf den Ordner %TEMP% und auf das Laufwerk des Datenordners, zum Beispiel eine RAM-Disk oder ein Laufwerk, das ein Startskript später einbindet. Vor 0.9.14 wartete der Launcher für den Systemstart 2 Minuten nur auf %TEMP% und der Anmeldeeintrag gar nicht. Auf einen Datenordner auf einer Netzwerkfreigabe wird nicht gewartet. Ein mit Anführungszeichen gesetztes TEMP oder TMP ("D:\My Temp") oder eines, das einen nicht vorhandenen Ordner nennt, wird für das Relay korrigiert: Die Anführungszeichen fallen weg, oder es nutzt deinen eigenen Temp-Ordner.

Läuft die Wartezeit ab, nennt eine Zeile, was noch fehlt, und das Relay startet trotzdem:

[<date> <time>] Still missing after 300 s: data drive "R:\"; starting the relay anyway.

Die Zeile geht nach oar-web-relay-launcher.log neben dem Launcher für den Systemstart, oder für den Anmeldeeintrag nach oar-web-relay.log im OAR-Ordner (%APPDATA%\oar). Ein Relay, dessen Datenordner sich dann immer noch nicht anlegen lässt, beendet sich mit einer Zeile, die den Ordner nennt, und Exit-Code 78, statt mit einem Fehler-Trace.

Datenordner der Windows-Einträge Neu in 0.9.14 #

Beide Einträge starten das Relay mit der Config, dem Datenordner und dem Log-Ordner, die oar start nutzt: %APPDATA%\oar\config.json, %APPDATA%\oar\data und %APPDATA%\oar\logs bei einer globalen Installation. Vor 0.9.14 setzten sie nur die Config-Datei, sodass ein von ihnen gestartetes Relay seine Datenbank, Uploads und Logs in server\data, server\uploads und server\logs im installierten Paket hielt: andere Konversationen als mit oar start, und mit dem nächsten Update weg. Aktualisiere von diesen Versionen so, wie es der Upgrade-Hinweis beschreibt.

Das Relay bringt einen Eintrag oder Launcher, den OAR erzeugt hat (ab 0.9.0, auch das copilot-remote-web-relay.cmd aus der Zeit vor der Umbenennung), bei seinem ersten Start nach dem Update von selbst auf den neuesten Stand, ohne Admin-Bestätigung. Ein Eintrag, den du bearbeitet hast, einer, der auf eine andere Config-Datei zeigt, und einer eines Relays, das mit eigenen Datenordnern gestartet wurde, bleiben unberührt. Neu in 0.9.15 Sie gelten als von Hand angelegt: oar autostart <mode> --replace ersetzt sie und behält eine Kopie (siehe Einträge, die OAR nicht angelegt hat). Einen Launcher neu zu schreiben, während das von ihm gestartete Relay noch läuft, ist unbedenklich. Die Launcher stellen die Konsole auf UTF-8 um, sodass ein Benutzerordner mit Nicht-ASCII-Zeichen im Namen seine Pfade unversehrt behält.

macOS #

Den Dienst gibt es auf macOS noch nicht. oar service sagt das und nennt oar start. Nach einem Neustart führst du oar start aus, um das Relay wieder zu starten. Der Installer startet es im Hintergrund.

WSL #

Der Linux-Dienst braucht eine systemd-Benutzersession. Eine WSL-Distro hat eine nur, wenn systemd eingeschaltet ist. Ist es das nicht, bricht oar service install mit einem Hinweis ab: Setze systemd=true unter [boot] in /etc/wsl.conf und starte die Distro dann aus Windows mit wsl --terminate <distro> neu. Bis dahin nutze oar start. Dasselbe gilt für einen Container oder jedes Linux ohne systemd-Benutzersession.

Updates #

oar update bittet das laufende Relay, sich selbst neu zu starten, und das tut es, sobald seine Queue leer ist. Das gilt auch mit dem Linux-Dienst: Das Update läuft nicht über systemd und schneidet daher keine Turns ab. Siehe Neustarts und Fortsetzen. Der Dienst und die Autostart-Einträge starten das installierte Paket und laufen nach diesem Neustart daher mit der neuen Version. Ein Update des Pakets berührt nie die Config oder die Daten. Neu in 0.9.14 Die einzige Ausnahme ist das Update auf 0.9.14 von einem Windows-Autostart-Relay, dessen Daten im Paket lagen: siehe den Upgrade-Hinweis.

Nach Plattform #

Wenn es nicht funktioniert #

Weitere Startprobleme behandelt Erster Start. Um OAR überhaupt erst zu installieren, siehe Installation.