Docs
Start with your first tunnel, then continue into configuration and operational checks.
/docs/getting-started
Start with account creation and your first public tunnel.
1. Create your account and sign in to the dashboard.
2. Check your API token and run `retproxy login`.
3. Start a tunnel with `retproxy http 3000` or `retproxy tcp 25565`.
Read the full guide/docs/installation
Install the CLI on Windows, macOS, and Linux.
Download the installer for your OS from the public download page.
Verify the install with `retproxy version`.
Use `retproxy login` for the initial browser-based sign-in flow.
Read the full guide/docs/http-tunnel
Expose a local web app through a public URL.
Run `retproxy http 3000` to expose a local HTTP port.
Use the generated URL for reviews, webhooks, and staging previews.
Track traffic and recent state changes from the dashboard.
Read the full guide/docs/tcp-tunnel
Publish game servers or SSH through an external port.
Use `retproxy tcp 25565` to expose a TCP service on an external port.
It works well for Minecraft, SSH, and custom TCP services.
Review connection counts and transfer volume from the dashboard.
Read the full guide/docs/configuration
Manage domains, authentication, and runtime settings.
Manage public domains, relay targets, and auth settings from deployment config and the dashboard.
For the MVP, it is safest to document only the options that already exist in production.
Future settings should preserve compatibility with existing CLI clients.
Read the full guide/docs/api
Overview of the control plane endpoints.
This page is the entry point for auth, exchange, and state sync APIs used by the CLI and control plane.
Right now the product is focused more on integrated CLI and web workflows than a broad public API.
Any externally documented API should grow behind explicit versioning.
Read the full guide/docs/docker
Run retproxy with a Docker Compose based workflow.
Run the UI, relay, and database together with a Compose-based setup.
The repository can host both the public site and downloadable client artifacts.
Production is intended to sit behind Caddy or Cloudflare.
Read the full guide/docs/troubleshooting
Common connection issues and checks.
Start by checking the `retproxy login` auth state and basic network reachability.
Confirm that the public routing information is correct for HTTP or TCP mode.
Compare server-side logs with recent tunnel state in the dashboard to narrow issues down quickly.
Read the full guide