amalshaji/portr

Portr는 로컬 HTTP, TCP, 또는 WebSocket 서비스를 공용 인터넷에 노출할 수 있게 해주는 터널 솔루션입니다. 서버는 클라이언트 간 터널 전송으로 SSH 또는 WebSocket을 실행할 수 있으며, 생성된 클라이언트 설정은 클라이언트에게 어떤 전송을 사용할지 알려줍니다.

Portr는 주로 개발 서버를 공개 URL로 노출하려는 소규모 팀을 위해 설계되었습니다. 운영 서버와 함께 사용하는 것은 권장되지 않습니다.

특징

• 🎉 공개 URL에 로컬 HTTP, TCP, WebSocket 서비스를 노출합니다.
• 🚨 http://localhost:7777에 내장된 로컬 인스펙터, 요청 검사, 재생, WebSocket 세션 디버깅을 지원합니다. 영상 시청.
• 🤖 portr logs로 지원되는 에이전트 친화적인 로컬 요청 로그.
• 👾 팀, 사용자 및 연결 관리를 위한 관리자 대시보드. 영상 시청.

퀵 스타트

1. Portr 서버를 설정하거나 기존 서버를 사용하기.
2. 컴퓨터에 Portr 클라이언트를 설치하세요.
3. 로컬 서비스를 시작한 후 노출:

터널을 서브도메인에 핀 고정하려면:

HTTP 터널을 시작하면 즉시 세 가지 유용한 일이 일어납니다:

• 로컬 서비스로 전달되는 공개 HTTPS URL을 생성합니다.
• 포터 검사관은 [[T3]에서 로컬 시작)

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.

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. Watch video.
• 🐳 Tunnel Docker Compose services by adding a portr.enable label. Docker Compose guide.
• 🤖 Agent-friendly local request logs with portr logs, backed by ~/.portr/db.sqlite.
• 👾 Admin dashboard for team, user, and connection management. Watch video.

Quick Start

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:

portr http 9000

To pin the tunnel to a subdomain:

portr http 9000 -s amal-test
# or
portr http 9000 --subdomain amal-test

Starting an HTTP tunnel does three useful things immediately:

• Creates a public HTTPS URL that forwards to your local service.
• Starts the Portr inspector locally at http://localhost:7777.
• Persists HTTP request logs locally so they can be queried from the CLI.

HTTP tunnels also support WebSocket upgrades, so a local WebSocket endpoint behind the tunneled HTTP service can be reached with wss://.. HTTP tunnels start two tunnel workers by default; set pool_size in the client config when you need a different worker count.

Inspector And Logs

The local inspector lets you:

• inspect incoming HTTP requests and responses
• replay stored requests as-is or edit method, path, headers, and body before replaying
• inspect headers and payloads
• monitor upgraded WebSocket sessions and captured frames

The same stored request data is available from the CLI:

# Show the latest logs for a subdomain