Skip to content

Configuration

Jump to bottom
Gerhard Tan edited this page Jul 8, 2025 · 14 revisions

You can edit a configuration by double-clicking an item in the configuration list. Any changes to a running configuration will cause the underlying service to be restarted.

The configuration status is one of the following values:

  • Unknown
  • Started
  • Stopped
  • Starting
  • Stopping

Please note that the "Started" status does not mean that the client has successfully connected to the server. It only indicates that the client process is running.

Import configuration

The configuration file must be in one of the following formats:

  • TOML
  • JSON
  • YAML
  • INI

You can import configuration in three ways:

  • Import from File: One or more configuration files or a ZIP file containing configuration files.
  • Import from URL: Similar to Import from File, but the files are downloaded via HTTP URLs.
  • Import from Clipboard: A configuration file in plain text format or a share link starting with frp://.

Metadata

Edit the configuration and navigate to the Advanced tab and click the Metadata link. In the pop-up dialog box, enter the key and value pairs.

Convert INI to TOML

TOML is the default format when you create a blank configuration. However, if you import a configuration from an external source, the final format is the same as the original.

If you want to upgrade your legacy format, edit the configuration and navigate to the Advanced tab and deselect the "Use legacy file format" option.

Disable auto-start

Auto-start is the default behavior for all launched configurations. If you want to disable auto-start for a configuration, edit the configuration and navigate to the Advanced tab and select the "Disable auto-start at boot" option. If the operation is successful, the text color of the configuration name changes to blue.

Self-destructing configuration

A self-destructing configuration is a special configuration that is automatically deleted after a certain amount of time, including process and logs, and is suitable for temporary use.

There're two deletion modes:

  • Absolute: The configuration will be deleted on a specific date.
  • Relative: The configuration will be deleted after a certain number of days from the file modification date.

To create a self-destructing configuration, edit the configuration and navigate to the Admin tab and select your preferred mode in the Auto Delete option. Enter a specific date or a certain number of days and press OK to complete the configuration.

Connect via proxy

Edit the configuration and navigate to the Connection tab and click the Advanced Options link. In the pop-up dialog box, enter the proxy url (e.g., socks5://127.0.0.1:8080) in the Proxy URL field.

Batch deletion

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

Create a copy

You can copy a configuration by right-clicking the configuration name and selecting "Create a Copy".

There're two options:

  • All: Copy the entire configuration, including proxies.
  • Common only: Only common options are copied, excluding proxies.

Enter a new configuration name in the pop-up dialog box.

Share link

A share link is a base64-encoded string of a configuration file, with the frp:// identifier added at the beginning.

WARNING: The share link may contain secret keys, be cautious about posting it on public websites.

To copy the share link of the configuration, right-click the configuration and select the "Copy Share Link" menu.

Clone this wiki locally