portr

Expose local http, tcp or websocket connections to the public internet

What is portr?

Expose local http, tcp or websocket connections to the public internet

Overview of portr

What it is

Portr is a tunnel solution that allows you to expose local HTTP, TCP, or WebSocket services to the public internet. Servers can run either SSH or WebSocket as the client-to-server tunnel transport, and generated client configs tell the client which transport to use. Portr is primarily designed for small teams looking to expose development servers on a public URL. It is not recommended for use alongside production servers.

Key features

  • Expose local HTTP, TCP, and WebSocket services on public URLs.
  • Built-in local inspector on http://localhost:7777 for request inspection, replay, and WebSocket session debugging.
  • Tunnel Docker Compose services by adding a portr.enable label.
  • Agent-friendly local request logs with portr logs, backed by ~/.portr/db.sqlite.
  • Admin dashboard for team, user, and connection management.

Use cases

Portr is intended for small teams to expose local development servers to the public internet for testing, sharing, and debugging. It supports exposing HTTP, TCP, and WebSocket services. The built-in inspector allows inspecting and replaying HTTP requests and debugging WebSocket sessions. Docker Compose services can be tunneled by adding a label. Local request logs are persisted and queryable from the CLI.

Getting started

  1. Set up a Portr server or use an existing one. 2. Install the Portr client on your machine. 3. Start a local service, then expose it: bash portr http 9000 To pin the tunnel to a subdomain: bash portr http 9000 -s amal-test # or portr http 9000 --subdomain amal-test Starting an HTTP tunnel creates a public HTTPS URL, starts the inspector at http://localhost:7777, and persists HTTP request logs locally. HTTP tunnels also support WebSocket upgrades.

License and pricing

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). It is open source.

Based on the project's public README and repository metadata.

Add this badge to your README

Featured on YunoDB Badge styles & help

Maintain this project? Show that it is featured on YunoDB.

Markdown[![Featured on YunoDB](https://yunodb.com/badge/amalshajiportr.svg)](https://yunodb.com/tools/amalshajiportr?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/amalshajiportr?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/amalshajiportr.svg" alt="Featured on YunoDB" height="20"></a>