CLI

Manage the edge

Set up the reverse proxy, attach domains, apply rules, and inspect traffic.

The edge is Openship's reverse proxy and TLS layer. Use these commands with an authorized HTTP context on a self-hosted installation. See the edge guide for the routing model.

Inspect and set up

openship edge status
openship edge up

Running openship edge opens the interactive panel. The up command configures the managed edge; its reference lists target and setup options.

If another reverse proxy owns the HTTP/HTTPS ports, inspect its sites before taking over. Use edge takeover or edge migrate only after reviewing their detected configuration and options. The existing-proxy guide explains the workflow.

Domains and rules

openship edge domains list
openship edge rules list
openship edge sites
TaskReference
Add or remove edge hostnamesDomain commands
Add or remove access, redirect, or traffic rulesRule commands
Inspect sites managed outside project recordsSites
Repair managed edge configurationRepair

Project-owned custom domains can also be managed with domain commands.

Inspect traffic

openship edge logs
openship edge traffic
openship edge analytics

The command reference lists filters, time windows, and target options. For certificate failures, see DNS and TLS troubleshooting.

On this page