Skip to content

ecosystem.md

Latest commit

 

History

History
102 lines (74 loc) · 4.57 KB

ecosystem.md

File metadata and controls

102 lines (74 loc) · 4.57 KB
Raw

Ecosystem

Connect, deploy and operate with tools built around Nowhere's public interfaces.

Contents

Projects

Use the layer that fits your workflow. Each project's documentation describes the protocol and interfaces it supports.

Project Purpose Get started
Anywhere Native connections on iOS, iPadOS and tvOS App Store · Import guide
Vector Built-in SOCKS5 ingress for desktop and server applications Quick start · Configuration
nowhere-sh Linux VPS deployment and service management Quick start · Commands
OpenCtrl Local process supervision through REST and SSE Run · API reference
NowhereDash Portal fleet operations through OpenCtrl Quick start · Product tour

Connections and management

Client traffic, deployment and process management use separate interfaces:

Connect

+----------+                 +----------+                 +----------+
| Anywhere |-- wire protocol>|  Portal  |<-- wire protocol|  Vector  |
+----------+                 +----------+                 +----------+

Deploy

+------------+     installs and operates      +----------+
| nowhere-sh |------------------------------->|  Portal  |
+------------+                                +----------+

Manage

+-------------+       REST + SSE       +----------+
| NowhereDash |----------------------->| OpenCtrl |
+-------------+                        +-----+----+
                                            |
                                            | supervises
                                            v
                              +---------------------------+
                              |  Portal / Vector / Egress |
                              +---------------------------+

Connect

Anywhere connects directly to Portal and imports nowhere:// links. Vector ships in the nowhere binary and exposes a local SOCKS5 endpoint. Client peers implement Nowhere Protocol (NW3) independently of the Rust runtime. Nowhere also provides an Egress Extension; ordinary client peers do not need that extension when connecting to a Portal using a remote exit.

Deploy

nowhere-sh installs and manages one systemd Portal on a Linux VPS. Its interactive workflow covers release selection, upgrades, transport and Portal configuration, service lifecycle, logs and generated Anywhere or Vector links. It operates Portal directly.

Manage

OpenCtrl runs beside the Portal, Vector or Egress processes it supervises. It stores process definitions and exposes lifecycle, logs and telemetry through a versioned REST API and Server-Sent Events. The controller and its children share a host or container, operating-system user and telemetry namespace.

NowhereDash connects to multiple OpenCtrl endpoints. It operates Portal instances, displays live telemetry and publishes protected subscriptions with QR codes and mobile import links. Its management model is Portal-only.

Share links

Use share links to distribute Portal connections. Client import guides describe any additional fields.

Service configuration

The CLI runs portal://, vector:// and egress:// URLs:

portal://KEY@HOST/tcp:2000/udp:2001?out=egress
vector://KEY@HOST/tcp:2000?in=127.0.0.1:1080
egress://KEY@HOST/udp:2001

Use a key from nowhere generate-key. Vector requires in for its local listener and selects one carrier through its endpoint path. Egress uses QUIC and registers only with a Portal configured for out=egress.

Configuration defines the complete CLI grammar, defaults, listener options and environment variables. Integrations describes service supervision and third-party Telemetry subscribers.