Help Center / api

Eine lokale Anwendung mit osir tunnel teilen

osir tunnel gibt einer Web-Anwendung, die auf Ihrem eigenen Rechner läuft, eine öffentliche HTTPS-Adresse. So zeigen Sie Zwischenstände, empfangen Webhooks oder öffnen die Anwendung auf einem echten Telefon, ohne etwas zu deployen.

Bevor Sie beginnen

Installieren Sie die OSIR-CLI 1.3.0 oder neuer und prüfen Sie die Version:

osir --version

Melden Sie sich anschließend einmalig an:

osir auth login

Einen Tunnel öffnen

osir tunnel 3000

+------------------------------------------+
|  https://crisp-willow-knix.osir.run      |
+------------------------------------------+
Forwarding https://crisp-willow-knix.osir.run -> http://localhost:3000
Anyone with this link can reach your app. Press Ctrl+C to stop.

Teilen Sie den Link. Er funktioniert, bis Sie Strg+C drücken.

Auswählen, was freigegeben wird

Sie geben ein	Weiterleitung an
`osir tunnel 3000`	`http://localhost:3000`
`osir tunnel localhost:8080`	`http://localhost:8080`
`osir tunnel http://127.0.0.1:5000`	`http://127.0.0.1:5000`
`osir tunnel https://localhost:8443`	einen lokalen Server, der HTTPS spricht

Bei HTTPS-Zielen auf dem eigenen Rechner werden selbstsignierte Zertifikate akzeptiert. Bei jedem anderen Host wird das Zertifikat normal geprüft.

Skripte und CI

Mit -o json erhalten Sie eine maschinenlesbare Zeile, sobald der Tunnel bereit ist:

osir tunnel 3000 -o json

{"status": "ready", "target": "http://localhost:3000", "url": "https://crisp-willow-knix.osir.run"}

Dev-Server, die den Hostnamen prüfen

Ihre Anwendung erhält den öffentlichen Hostnamen im Host-Header. Lehnt sie ihn ab, erlauben Sie .osir.run:

Vite: server: { allowedHosts: ['.osir.run'] }
webpack-dev-server: devServer: { allowedHosts: ['.osir.run'] }

Neuverbindung und Wartung

Bricht die Verbindung ab, verbindet sich die CLI automatisch neu und behält Ihre Adresse, wann immer das möglich ist. Vor geplanter Wartung warnt osir.run die CLI und hält Ihre Adresse 120 Sekunden lang. Sie sehen dann:

The edge is restarting; your address is held for 120s

Ihre Anmeldung wird automatisch erneuert. Eine kurze Netzwerkunterbrechung, etwa durch das Zuklappen des Laptops, meldet Sie nicht ab.

Wenn Ihre Anwendung nicht läuft

Besucher sehen eine osir.run-Seite mit dem Hinweis, dass der Tunnel steht, unter Ihrer lokalen Adresse aber nichts antwortet. Starten Sie Ihre Anwendung, dann genügt ein Neuladen.

Referenz

osir tunnel <port | host:port | url> [flags]

Flag	Beschreibung
`-o json`	Maschinenlesbare Ausgabe
`--server`	Zu verwendender Tunneldienst (Standard https://osir.run, Umgebungsvariable `OSIR_TUNNEL_SERVER`)
`--auth`	Gemeinsames Geheimnis für einen privaten Tunneldienst (Umgebungsvariable `OSIR_TUNNEL_AUTH`)

Gut zu wissen

Die Adresse ist zufällig und ändert sich bei jedem neuen Tunnel.
Jeder mit dem Link erreicht Ihre Anwendung. Geben Sie keine Admin-Oberflächen oder Datenbanken frei.
Jeder Tunnel wird dem Konto zugeordnet, das ihn geöffnet hat.
Missbrauch melden Sie an abuse@osir.com.

Siehe auch: Osir Tunnel vorgestellt und die Entwicklerdokumentation.