OpenFRP Game Tunnels

Use OpenFRP TCP/UDP tunnels with a client running inside the game workspace. Multiple tunnels in the same workspace can share one client.

Before you start

• Install and enable the plugin, with an online Linux amd64/arm64 workspace.
• The container needs /bin/sh, base64, tr, and access to OpenFRP and client downloads.
• Prepare an OpenFRP account and check node, protocol, quota, and pricing requirements. A platform super administrator connects the account. Workspace operators and platform administrators can start or stop the client; read-only members can view status.

Connect and start

1. Open the workspace OpenFRP view. Click 连接账号 → 打开授权页面 (Connect account → Open authorization page) and authorize within five minutes.
2. Use 管理线路 (Manage tunnels) to open the OpenFRP console and create or inspect a tunnel. Use an enabled TCP/UDP tunnel, with local address 127.0.0.1 and the game's container port.
3. Return to the plugin and click 启动 (Start) for the tunnel. First use downloads and installs the client in the background.
4. Wait for that tunnel to show 运行中 (Running), copy its public address, and test with a game client. The game must be listening on the selected port.

The account is shared by the same plugin installation. Only platform super administrators can connect, cancel authorization, or disconnect it. Do not expose management ports as game ports.

Add or stop tunnels

• Starting another tunnel adds it to the current client. Adding or removing tunnels restarts the client and briefly interrupts existing connections.
• 停止 (Stop) removes one tunnel. Removing the last tunnel exits the client. 停止客户端 (Stop client) stops all tunnels.
• Stopping the client preserves the main game service and remote tunnel configuration. Start the client again after container restarts.
• Closing the page does not stop submitted startup tasks. If state is unknown or a tunnel is already online remotely, inspect operations and 运行日志 (Runtime logs) before starting again.

Secrets and chat

Startup saves the client token as the workspace secret OPENFRP_TOKEN. Secret changes affect new processes only. Disconnecting the shared account does not stop existing connections; stop the client first when you need to disconnect players.

Select manage-openfrp in workspace chat to create, edit, or use a specific tunnel. Token configuration from chat requires manual approval; no plaintext token needs to be sent in chat.

An already bound client version is not automatically upgraded. See Remote Login for account authorization and the official client guide for client usage.

Common problems

• Cannot connect account: check administrator permissions and authorization expiry.
• Cannot start a tunnel: check local address, port, protocol, enabled state, and whether another client already uses it.
• Running but players cannot join: check the game service, listening port, tunnel node, and logs, then test from a player's client.