Port Bridge Documentation

Port Bridge

Port Bridge connects your local Minecraft Java server to friends through a public TCP relay. Keep the world on your own computer, open a managed Bore tunnel, and share the connection address from chat or the console. The plugin checks the Minecraft route, shows connection details, and reconnects after interruptions.

Follow the installation guide to share your first address, or read tunnels and relays to understand how the connection works. Select the cover to enlarge it without leaving the documentation.

Port Bridge supports Paper and compatible forks for Minecraft 1.21.11 and later and requires Java 25 or newer. Folia and Spigot are not supported. Managed Bore downloads are available for Windows x64/x86 and Linux/macOS x64/ARM64.

---

Download Port Bridge

Download the latest plugin JAR from Hub, SpigotMC or GitHub Releases, then follow the installation guide. Install port-bridge-<version>.jar; you do not need to compile the plugin yourself.

The plugin is free and open source under GPL-3.0-or-later. The plain and Javadoc JARs are developer artifacts.

---

Start Sharing

Getting Started Install the plugin, check requirements, and share your first connection address.

Tunnels and Relays Understand local listeners, public ports, route checks, and private relays.

Compatibility Check Minecraft and Java versions, supported platforms, and network requirements.

Troubleshooting Diagnose listener failures, download errors, and unavailable public routes.

---

Server Administration

Commands Every command, accepted alias, permission, and practical example.

Permissions Choose who can view addresses, manage tunnels, and reload settings.

config.yml Configure startup, Bore installation, relays, retries, and public health checks.

messages.yml Customize chat panels, colors, buttons, hover text, and command feedback.

---

Development and Resources

The implementation uses immutable settings and tunnel snapshots, a worker for native processes and network checks, and server-thread callbacks for Bukkit interactions. Browse the implementation reference when building from source or contributing.

Developer Reference Build the plugin and understand service ownership, lifecycle, and thread rules.

Javadocs Browse the generated class, method, and package documentation.

Source Code Read the implementation or contribute to Port Bridge on GitHub.

Issue Tracker Report a reproducible problem with your server version and relevant logs.