amalshaji/portr

Portrは、ローカルのHTTP、TCP、またはWebSocketサービスをパブリックインターネットに公開できるトンネルソリューションです。サーバーはクライアント間トンネルトランスポートとしてSSHまたはWebSocketのいずれかを実行し、生成されたクライアント設定がクライアントにどのトランスポートを使うかを指示します。

Portrは主に、開発サーバーを公開URLで公開したい小規模チーム向けに設計されています。本番サーバーと併用することは推奨されていません。

特徴

• 🎉 ローカルHTTP、TCP、WebSocketサービスを公開URLに公開すること。
• 🚨 http://localhost:7777に内蔵されたローカルインスペクタで、リクエスト検査、リプレイ、WebSocketセッションのデバッグが可能です。動画を視聴してください。
• 🤖 portr logsを裏付けるエージェントフレンドリーなローカルリクエストログ。
• 👾 チーム、ユーザー、接続管理用の管理ダッシュボード。動画を見る。

クイックスタート

1. Portrサーバーを設置するか、既存のサーバーを使用する。
2. Portrクライアントをマシンにインストールします。
3. ローカルサービスを開始し、それを公開します:

トンネルをサブドメインにピン留めるには:

HTTPトンネルを開始すると、すぐに3つの有用な効果が得られます:

• ローカルサービスに転送する公開HTTPSURLを作成すること。
• ポルト検査官は[[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