PortBuddy is a powerful yet simple tool that allows you to expose a port opened on your local host or in a private network to the public internet. It works as a secure tunnel, similar to ngrok, providing a public URL for your local services.

Whether you're developing a web app, testing webhooks, or sharing access to a local database, PortBuddy makes it easy and secure.

• Multi-protocol support: Tunnel HTTP, TCP, and UDP traffic.
• SSL by default: All HTTP tunnels are automatically secured with SSL.
• Customizable: Support for static subdomains and custom domains.
• Websocket support: Full support for real-time applications.
• Private tunnels: Secure your tunnels with passcodes.
• Cross-platform CLI: Lightweight CLI built with Java 25 and GraalVM (native executable).
• Web Dashboard: Manage your tunnels, subscriptions, and team members easily.

Download the latest version of the portbuddy CLI for your platform (Windows, Linux, or Mac).

Before exposing ports, you need to authenticate your CLI.

1. Log in to your account at portbuddy.dev.
2. Generate an API Token in your dashboard.
3. Run the following command:

   portbuddy init {YOUR_API_TOKEN}

Expose a local web server running on port 3000:

portbuddy 3000

Output: http://localhost:3000 exposed to: https://abc123.portbuddy.dev

Expose a local PostgreSQL database:

portbuddy tcp 5432

Output: tcp localhost:5432 exposed to: net-proxy-3.portbuddy.dev:43452

Expose a local UDP service:

portbuddy udp 9000

Usage: portbuddy [options] [mode] [host:][port]

Modes:
  http (default), tcp, udp

Options:
  -d,  --domain=<domain>        Requested static subdomain (e.g. my-app)
  -pr, --port-reservation=<hp>  Use specific port reservation host:port for TCP/UDP
  -pc, --passcode=<passcode>    Protect tunnel with a passcode
  -v,  --verbose                Enable verbose logging
  -h,  --help                   Show help message
  -V,  --version                Show version info

PortBuddy is built as a multi-modular system:

• cli: GraalVM-native command-line application (Java 25).
• server: Spring Boot 3.5.7 API & Tunnel Management.
• net-proxy: High-performance TCP/UDP proxy.
• gateway: Webflux-based API Gateway.
• web: React-based dashboard (TypeScript + TailwindCSS).
• eureka: Service discovery.
• ssl-service: Automated SSL certificate management.
• common: Shared DTOs and utilities.

• Java 25
• Docker & Docker Compose
• Spring Boot 3
• Maven 3.9+
• Node.js & npm (for web module)

To build the entire project:

./mvnw clean install

docker-compose up -d

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.