Docs

Documentation from setup to operations

For the MVP, prioritize the topics that get users to a successful first tunnel as quickly as possible.

/docs/getting-started

Getting Started

Start with account creation and your first public tunnel.

/docs/installation

Installation

Install the CLI on Windows, macOS, and Linux.

/docs/http-tunnel

HTTP Tunnels

Expose a local web app through a public URL.

/docs/tcp-tunnel

TCP Tunnels

Publish game servers or SSH through an external port.

/docs/configuration

Configuration

Manage domains, authentication, and runtime settings.

/docs/api

API

Overview of the control plane endpoints.

/docs/docker

Docker

Run retproxy with a Docker Compose based workflow.

/docs/troubleshooting

Troubleshooting

Common connection issues and checks.