Repolode
Submit
zywe03

zywe03/realm-xwPF

Interactive Bash script that installs Realm and manages port-forwarding and relay rules from a terminal menu on Linux VPS servers.

View on GitHubWebsite
Stars
1,268
Forks
173
Open issues
1
Last commit
2 months ago

What is it?

realm-xwPF is a shell script that installs the Realm network relay on a Linux server and wraps it in a terminal menu for creating and managing forwarding rules. It supports Realm's TCP and UDP forwarding, WebSocket and TLS transports, load balancing with round-robin and IP-hash strategies, and failover via a systemd-timed health check. The script runs on Debian/Ubuntu, Alpine and CentOS/RHEL families and detects whether the host uses systemd or OpenRC.

Beyond rule management, the project bundles a port traffic monitor that counts per-port and whole-machine traffic and can apply rate limits with Telegram or webhook notifications. It also includes a network link test script that measures latency, bandwidth and packet loss with hping3, iperf3 and nexttrace, and provides import and export of the full configuration for migration between servers.

Key features

  • 01Manages Realm TCP, UDP, WebSocket and TLS forwarding rules from an interactive menu.
  • 02Supports load balancing with round-robin and IP-hash strategies and weighted targets.
  • 03Automatic failover through a systemd-timed health check.
  • 04Port and whole-machine traffic statistics with rate limiting and notifications.
  • 05Export and import of full configuration, including rule notes, for server migration.

Use cases

  • Relaying traffic through a VPS to a backend server on a different network.
  • Setting up a two-hop tunnel between a relay host and an exit host using TLS or WebSocket.
  • Monitoring per-port bandwidth usage on a shared Linux server.

Quick start

  1. 1

    Run the one-line install command from the README (requires sudo; it pipes a remote script into bash, so run it yourself)

  2. 2

    Open the management menu with the pf shortcut

    pf

Things to know

  • Targets Linux VPS servers only.
  • Requires root or sudo because it installs Realm and modifies system services and network settings.
  • Installation downloads and runs a script from GitHub, so it needs network access or an accelerated mirror.

Topics

#network#relay#port-forwarding#shell#linux#load-balancing#traffic-monitoring#vps#iproute2#monitoring-tool

FAQ

What is realm-xwPF?
Interactive Bash script that installs Realm and manages port-forwarding and relay rules from a terminal menu on Linux VPS servers. realm-xwPF is a shell script that installs the Realm network relay on a Linux server and wraps it in a terminal menu for creating and managing forwarding rules. It supports Realm's TCP and UDP forwarding, WebSocket and TLS transports, load balancing with round-robin and IP-hash strategies, and failover via a systemd-timed health check. The script runs on Debian/Ubuntu, Alpine and CentOS/RHEL families and detects whether the host uses systemd or OpenRC.
Is realm-xwPF free to use? What license does it have?
realm-xwPF is open source under the MIT license. Check the license terms before using it in commercial products.
Is realm-xwPF still maintained?
Updated within 6 months. The last commit to realm-xwPF was on Sep 3, 2026.
What can I use realm-xwPF for?
Relaying traffic through a VPS to a backend server on a different network. Setting up a two-hop tunnel between a relay host and an exit host using TLS or WebSocket. Monitoring per-port bandwidth usage on a shared Linux server.
How do I install realm-xwPF?
Run the one-line install command from the README (requires sudo; it pipes a remote script into bash, so run it yourself) Open the management menu with the pf shortcut: pf
Where can I get realm-xwPF?
The source code and installation instructions are on GitHub: https://github.com/zywe03/realm-xwPF

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects