/en/docs/reference/ Recent content in Reference on frp Hugo en /en/docs/reference/common/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/common/ LogConfig Field Type Description Required to string Log output file path. If set to console, logs will be printed to standard output. No level string Log level. Options are trace, debug, info, warn, error. Default level is info. No maxDays int Maximum days to retain log files, default is 3 days. No disablePrintColor bool Disable log colors in standard output. No WebServerConfig Field Type Description Required addr string webServer listening address, default is 127. /en/docs/reference/server-configures/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/server-configures/ ServerConfig Field Type Description Required auth AuthServerConfig Authentication configuration. No bindAddr string Server listening address for receiving frpc connections, default listens on 0.0.0.0. No bindPort int Server listening port, default value is 7000. No kcpBindPort int Server listening port for KCP protocol, used to receive frpc connections configured to use KCP protocol. No quicBindPort int Server listening port for QUIC protocol, used to receive frpc connections configured to use QUIC protocol. /en/docs/reference/client-configures/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/client-configures/ ClientConfig Field Type Description Required ClientCommonConfig Client common configuration. Yes proxies []ProxyConfig Proxy configuration. Different proxy types correspond to different configurations, such as TCPProxyConfig or HTTPProxyConfig. No visitors []VisitorConfig Visitor configuration. Different visitor types correspond to different configurations, such as STCPVisitorConfig. No ClientCommonConfig Field Type Description Required auth AuthClientConfig Client authentication configuration. No user string Username. After setting this parameter, proxy names will be modified to {user}.{proxyName} to avoid proxy name conflicts with other users. /en/docs/reference/proxy/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/proxy/ ProxyBaseConfig Field Type Description Required name string Proxy name. Yes type string Proxy type. Options are tcp, udp, http, https, tcpmux, stcp, sudp, xtcp. Yes enabled *bool Whether this proxy is enabled, default is true. Set to false to disable this proxy, allowing individual control over each proxy’s enabled state. No annotations map[string]string Proxy annotation information that will be displayed in the server’s dashboard. No transport ProxyTransport Proxy network layer configuration. /en/docs/reference/visitor/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/visitor/ VisitorBaseConfig Field Type Description Required name string Visitor name. Yes type string Visitor type. Options are stcp, sudp, xtcp. Yes enabled *bool Whether this visitor is enabled, default is true. Set to false to disable this visitor, allowing individual control over each visitor’s enabled state. No transport VisitorTransport Visitor network layer configuration. No secretKey string Secret key. The secret key between server and access side must be consistent for the access side to access the server. /en/docs/reference/client-plugin/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/client-plugin/ HTTPProxyPluginOptions Field Type Description Required type string Plugin type, set to “http_proxy”. Yes httpUser string HTTP proxy username. No httpPassword string HTTP proxy password. No Socks5PluginOptions Field Type Description Required type string Plugin type, set to “socks5”. Yes username string Username. No password string Password. No StaticFilePluginOptions Field Type Description Required type string Plugin type, set to “static_file”. Yes localPath string Local path where static files are located. Yes stripPrefix string Remove specific prefix from user HTTP request Path. /en/docs/reference/visitor-plugin/ Mon, 01 Jan 0001 00:00:00 +0000 /en/docs/reference/visitor-plugin/ VirtualNetVisitorPluginOptions Field Type Description Required type string Plugin type, set to “virtual_net”. Yes destinationIP string Target virtual IP address to access. Usually the server’s virtual network address. Yes