Skip to content
Gerhard Tan edited this page May 26, 2025 · 8 revisions

To create a proxy, click the Add button above the proxy table, or you can edit a proxy by double-clicking an item in the proxy table.

The proxy status is one of the following values:

  • Unknown
  • Running
  • Error

Please note that the proxy status is only displayed while the configuration is running.

Hot reload

While the configuration is running, any changes to the proxy will trigger a hot reload of the configuration. This means you can apply proxy changes to a running configuration without restarting the service and without losing other proxy state.

Show error message

If a proxy reports an error, you can hover over the proxy name to view the error message. Also, if the proxy uses port ranges, you can find out which port the error is coming from based on the source of the error.

Show remote address

Right-click the proxy table and select the "Show Remote Address" menu, a Remote Address column will be added to the proxy table.

Enable or disable proxy

To disable a proxy, click the Disable button above the proxy table and the text color and background color of the proxy will turn gray. The status of a disabled proxy is always unknown.

Please note that you can't disable all proxies. If the proxy table is not empty, at least one proxy is enabled.

To enable a proxy, click the Enable button above the proxy table.

Port range

Port ranges are only supported for proxy types tcp and udp. You can define multiple port ranges in the Local Port field and the Remote Port field, separated by commas.

Please note that for each port range pair, the number of ports in the Local Port field must equal the number of ports in the Remote Port field.

Batch operations

To operate multiple proxies at once, hold down the Ctrl key and then click on each item you want to operate.

The following operations are supported:

  • Enable: All selected proxies are disabled, otherwise this operation is disabled.
  • Disable: All selected proxies are enabled and at least one unselected proxy is enabled, otherwise this operation is disabled.
  • Delete

Import proxy

This feature allows you to import a single proxy from the clipboard, its text must be in INI or TOML format.

For example, a valid proxy in TOML format:

[[proxies]]
name = "ssh"
type = "tcp"
localIP = "127.0.0.1"
localPort = 22
remotePort = 6000

and a valid proxy in INI format:

[ssh]
type = tcp
local_ip = 127.0.0.1
local_port = 22
remote_port = 6000

Copy the text and right click on the proxy table and select the "Import from Clipboard" menu.

Clone this wiki locally