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.
Portr is a self-hosted tunnel solution designed for teams. It lets you expose local http, tcp or websocket connections to the internet.
You can use the client to quickly tunnel http, tcp or websocket connections
portr http 9000This command exposes your local http server running at port 9000 on a public https url.
Check out how to quickly create a tunnel and inspect requests using portr inspector in the HTTP tunnel guide.
What you'll need
To get started with Portr, you'll need:
- A Portr server - Either set up your own or use an existing one
- The Portr client - Install it on your local machine
- A local service - Something running on your machine that you want to expose
Next Steps
Install the Client
Download and set up the Portr client on your machine.
Set up a Server
Deploy your own Portr server with Docker.
Create HTTP Tunnels
Learn how to expose HTTP services to the internet.
Local Development
Set up Portr for local development and contribution.
Key Features
- Multiple tunnel types: HTTP, TCP, and WebSocket support
- Admin dashboard: Monitor connections and manage teams
- Request inspector: Debug HTTP requests with built-in inspector
- Team management: Collaborate with team members
- Self-hosted: Full control over your tunneling infrastructure