Documentation

Find the path, then the reference.

Documentation is grouped for operators and embedders. Start with a first tunnel, learn the compile model, then open protocol and embedding references.

Get started Architecture Go SDK

Getting started

Docs

Setup wizard

First tunnel with install, generate, check, run.

Docs

CLI quickstart

Commands for run, check, generate, import.

Docs

Install & download

npm package binaries and installer.

Concepts

Docs

Architecture

FileConfig → RuntimeConfig → serve.

Docs

Configuration

Topology fields, carrier.mode, resume, reverse publish.

Docs

FAQ

Common operational questions.

Advanced

Docs

Native protocol

Carriers, mux, resume, reverse.

Docs

Protocols

Native tunnels; mixed/socks5 local hops.

Docs

Examples

Copy-ready topologies.

Docs

Resumable streams

mux.resume scope and bounds.

Docs

Reverse publish

NAT-side TCP/UDP exposure.

Embedding

Docs

Go SDK

pkg.tcptun.com/net and net contracts.

Docs

Android integration

VPN-oriented platform path.

External

Runtime source

gostartkit/tcptun-go on GitHub.

Tools

Docs

Config generator

Browser-local key generation.

Docs

URI / QR tools

Import and export endpoints.

Docs

Setup wizard

Guided first tunnel.

Trust

Docs

Security & trust

Supply chain and install safety.

Docs

Legal

Disclaimer and lawful use.

Docs

Privacy

Cookies and local processing.