amalshaji/portr

Portr — это туннельное решение, позволяющее предоставлять локальные HTTP, TCP или WebSocket сервисы в публичном интернете. Серверы могут запускать либо SSH, либо WebSocket в качестве клиент-серверного туннельного транспорта, а сгенерированные клиентские конфигурации указывают клиенту, какой транспорт использовать.

Portr в первую очередь предназначен для небольших команд, желающих размещать серверы разработки по публичному URL. Его не рекомендуется использовать вместе с продакшн-серверами.

Особенности

• 🎉 Отображать локальные HTTP, TCP и WebSocket сервисы на публичных URL.
• 🚨 Встроенный локальный инспектор на http://localhost:7777 для проверки запросов, повтора и отладки сессии WebSocket. Смотреть видео.
• 🤖 Логи локальных запросов, дружественные агентам с portr logs, поддерживаемые ~/.portr/db.sqlite.
• 👾 Панель администратора для управления командой, пользователями и соединениями. Смотреть видео.

Быстрый старт

1. Настройте сервер Portr или используйте существующий.
2. Установите клиент Portr на свой компьютер.
3. Запустите локальную службу, а затем разоблачите его:

Чтобы закрепить туннель с поддоменом:

Запуск HTTP-туннеля сразу же делает три полезные вещи:

• Создаёт публичный HTTPS-адрес, который пересылает на ваш локальный сервис.
• Запускает инспектора Портер локально в http://localhost:7777.

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