客户端插件配置

frp 客户端插件的详细配置说明。

HTTPProxyPluginOptions

Field Type Description Required
httpUser string HTTP 代理用户名。 No
httpPassword string HTTP 代理密码。 No

Socks5PluginOptions

Field Type Description Required
username string 用户名。 No
password string 密码。 No

StaticFilePluginOptions

Field Type Description Required
localPath string 静态文件所在本地路径。 Yes
stripPrefix string 去除用户 HTTP 请求 Path 的特定前缀。 No
httpUser string HTTP Basic Auth 用户名。 No
httpPassword string HTTP Basic Auth 密码。 No

UnixDomainSocketPluginOptions

Field Type Description Required
unixPath string UNIX 域套接字的地址。 Yes

HTTP2HTTPSPluginOptions

Field Type Description Required
localAddr string 本地 HTTPS 服务地址。 Yes
hostHeaderRewrite string 替换 Host header。 No
requestHeaders HeaderOperations 对请求 Header 的操作配置。 No

HTTPS2HTTPPluginOptions

Field Type Description Required
localAddr string 本地 HTTPS 服务地址。 Yes
hostHeaderRewrite string 替换 Host header。 No
requestHeaders HeaderOperations 对请求 Header 的操作配置。 No
crtPath string TLS 证书文件路径。 No
keyPath string TLS 密钥文件路径。 No

HTTPS2HTTPSPluginOptions

Field Type Description Required
localAddr string 本地 HTTPS 服务地址。 Yes
hostHeaderRewrite string 替换 Host header。 No
requestHeaders HeaderOperations 对请求 Header 的操作配置。 No
crtPath string TLS 证书文件路径。 No
keyPath string TLS 密钥文件路径。 No
最后修改 November 15, 2023: fix 404 (#71) (626ce4d)

ClientPlug-inConfiguration

Detailed Configuration description of the frp ClientPlug-in.

HTTPProxyPluginOptions

Field Type Description Required
httpUser string HTTP Agent User name. No
httpPassword string HTTP Agent Password. No

Socks5PluginOptions

Field Type Description Required
username string User name No
password string Password No

StaticFilePluginOptions

Field Type Description Required
localPath string The local path where the static file is located. Yes
stripPrefix string Remove the specific prefix of the user HTTP request Path. No
httpUser string HTTP Basic Auth User name. No
httpPassword string HTTP Basic Auth Password. No

UnixDomainSocketPluginOptions

Field Type Description Required
unixPath string UNIX The address of the domain socket. Yes

HTTP2HTTPSPluginOptions

Field Type Description Required
localAddr string Local HTTPS service address。 Yes
hostHeaderRewrite string Replace Host header。 No
requestHeaders HeaderOperations The operation Configuration for the request Header. No

HTTPS2HTTPPluginOptions

Field Type Description Required
localAddr string Local HTTPS service address。 Yes
hostHeaderRewrite string Replace Host header。 No
requestHeaders HeaderOperations The operation Configuration for the request Header. No
crtPath string TLS Certificate file path. No
keyPath string TLS Key file path. No

HTTPS2HTTPSPluginOptions

Field Type Description Required
localAddr string Local HTTPS service address。 Yes
hostHeaderRewrite string Replace Host header. No
requestHeaders HeaderOperations The operation Configuration for the request Header. No
crtPath string The path to the TLS certificate file. No
keyPath string TLS key file path. No
Last modified November 15, 2023: fix 404 (#71) (626ce4d)