Portr

GitHubamalshaji/portr

2.9K

Portr Documentation

Self-hosted tunnel solution designed for teams. Expose local HTTP, TCP, or WebSocket connections to the public internet with admin dashboard, request inspector, and team collaboration.

Portr is a self-hosted tunnel solution designed for teams. It lets you expose local HTTP, TCP, or WebSocket connections to the internet with a simple command-line interface.

You can use the client to quickly tunnel HTTP, TCP, or WebSocket connections:

portr http 9000

This command exposes your local HTTP server running at port 9000 on a public HTTPS URL.

Demo Videos

Check out these videos to see Portr in action and learn how to use its key features.

Portr Inspector - Request Debugging

See how to quickly create a tunnel and inspect HTTP requests using the built-in Portr inspector:

Admin Dashboard Overview

A quick walkthrough of the admin dashboard where you can monitor connections, create and manage teams and team members:

Key Features

Admin Dashboard

Complete web interface to monitor active connections, manage teams, and control access permissions.

Request Inspector

Built-in HTTP request inspector to debug, analyze, and replay requests in real-time.

Multiple Protocols

Support for HTTP, TCP, and WebSocket tunnels with custom subdomain support.

Team Collaboration

Create teams, invite members, and share tunnel access across your organization.

Self-Hosted

Deploy on your own infrastructure with full control over your tunneling solution.

Easy Setup

Simple installation with homebrew, install script, or direct binary download.

Use Cases

Portr is perfect for:

  • Local Development: Share your development server with teammates or clients
  • Webhook Testing: Receive webhooks from external services during development
  • API Integration: Test API integrations with third-party services
  • Demo Presentations: Show your work to clients without complex deployments
  • IoT Development: Expose local services for IoT device communication
  • Database Access: Tunnel database connections for remote development

Quick Start Guide

1. Get Started

Learn what Portr is and how it can help your development workflow.

2. Install Client

Download and set up the Portr client on your machine.

3. Deploy Server

Set up your own Portr server or connect to an existing one.

4. Create Tunnels

Start creating secure tunnels to expose your local services.

Community & Resources

GitHub Repository

View source code, report issues, and contribute to the project.

Hacker News Discussion

Join the community discussion with 172+ comments and feedback.

Local Development

Set up Portr for development and contribute to the project.

Additional Resources

Extra guides, integrations, and advanced configuration options.

Getting Started with Portr

Learn what Portr is and how to get started with this self-hosted tunnel solution. Perfect for exposing local HTTP, TCP, or WebSocket connections to the internet.