Uplink Docs

Share a local port — with the world or just your team — in one command.

Install the Uplink CLI or run the desktop app from this workspace.

Log in, serve a port, and share a private app.

Devices, namespaces, edges, app names, OpenTunnels, and the optional control plane.

Use uplink serve for one local port.

How Uplink derives public hostnames.

Private, password, public, and policy access.

Share and unshare private apps with guest emails.

Serve a complete uplink.yaml formation.

The current uplink.yaml schema.

Per-service options in uplink.yaml.

Status, stop, logs, reload, and down.

Choose the smallest access mode that fits.

Reusable account and rule policies.

Identity-gated private routes and account membership.

Bearer/password mode and local hashing.

Block requests by path, query, header, or method.

Per-IP and per-route budgets.

Desktop WAF rule registry and edge enforcement.

Local request capture and inspect commands.

View local app logs.

Control-plane metrics and local dashboard analytics.

WAF, policy, and reject events.

Usage metering and plan-oriented limits.

The Tauri desktop app and shared Uplink core.

Tunnels, details, settings, account, rules, and inspector.

Serve the desktop UI over HTTP from the CLI.

Edges, key mode, and the optional management stack.

Start a key-mode self-hosted edge.

Use the *.localhost preset for local integration.

Add, list, remove, and select edges.

Run the product stack locally.

What the optional control plane adds.

Accounts, invites, member roles, and web dashboard ownership.

Product-planning tiers and metering.

Operator and cross-tenant administration.

Beta direct Iroh peer path with edge fallback.

Use the explicit Direct Connect CLI.

login and logout.

serve, up, reload, down, and stop.

status, share, unshare, and logs.

inspect and inspect stats.

tunnels and edges.

edge and agent.

ui and connect.

Request path and trust boundaries.

QUIC, TLS 1.3, channel binding, and stream registration.

Holder-of-key binding, edge enforcement, and fail-closed behavior.

Common CLI, connector, and edge variables.

Common local and edge issues.

Short answers to common Uplink questions.