/zh-cn/docs/examples/ Recent content in 示例 on frp Hugo zh-cn /zh-cn/docs/examples/ssh/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/ssh/ 步骤 在具有公网 IP 的机器上部署 frps 部署 frps 并编辑 frps.toml 文件。以下是简化的配置，其中设置了 frp 服务器用于接收客户端连接的端口： bindPort = 7000 在需要被访问的内网机器上部署 frpc 部署 frpc 并编辑 frpc.toml 文件，假设 frps 所在服务器的公网 IP 地址为 x.x.x.x。以下是示例配置： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "ssh" type = "tcp" localIP = "127.0.0.1" localPort = 22 remotePort = 6000 localIP 和 localPort 配置为需要从公网访问的内网服务的地址和端口。 remotePort 表示在 frp 服务端监听的端口，访问此端口的流量将被转发到本地服务的相应端口。 启动 frps 和 frpc 通过 SSH 访问内网机器 使用以下命令通过 SSH 访问内网机器，假设用户名为 test： ssh -o Port=6000 test@x. /zh-cn/docs/examples/multiple-ssh-over-same-port/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/multiple-ssh-over-same-port/ 步骤 在具有公网 IP 的机器上部署 frps 修改 frps.toml 文件以包含以下内容（这里使用了最简化的配置）： bindPort = 7000 tcpmuxHTTPConnectPort = 5002 在内网机器 A 上部署 frpc 创建 frpc 配置文件，例如 frpc.toml，然后将以下内容添加到配置文件中： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "ssh1" type = "tcpmux" multiplexer = "httpconnect" customDomains = ["machine-a.example.com"] localIP = "127.0.0.1" localPort = 22 在内网机器 B 上部署另一个 frpc 创建 frpc 配置文件，例如 frpc.toml，然后将以下内容添加到配置文件中： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "ssh2" type = "tcpmux" multiplexer = "httpconnect" customDomains = ["machine-b. /zh-cn/docs/examples/vhost-http/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/vhost-http/ HTTP 类型的代理非常适合将内网的 Web 服务通过自定义域名提供给外部用户。相比于 TCP 类型代理，HTTP 代理不仅可以复用端口，还提供了基于 HTTP 协议的许多功能。 HTTPS 与此类似，但是需要注意，frp 的 https 代理需要本地服务是 HTTPS 服务，frps 端不会做 TLS 终止。也可以结合 https2http 插件来实现将本地的 HTTP 服务以 HTTPS 协议暴露出去。 步骤 配置 frps.toml 在 frps.toml 文件中添加以下内容，以指定 HTTP 请求的监听端口为 8080： bindPort = 7000 vhostHTTPPort = 8080 如果需要配置 HTTPS 代理，还需要设置 vhostHTTPSPort。 配置 frpc.toml 在 frpc.toml 文件中添加以下内容，确保设置了正确的服务器 IP 地址、本地 Web 服务监听端口和自定义域名： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "web" type = "http" localPort = 80 customDomains = ["www. /zh-cn/docs/examples/dns/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/dns/ DNS 查询请求通常使用 UDP 协议，而 frp 支持对内网 UDP 服务的穿透，配置方式与 TCP 类似。 步骤 配置 frps.toml 在 frps.toml 文件中添加以下内容： bindPort = 7000 配置 frpc.toml 在 frpc.toml 文件中添加以下内容： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "dns" type = "udp" localIP = "8.8.8.8" localPort = 53 remotePort = 6000 请注意，这里示例中反代了 Google 的 DNS 查询服务器的地址，仅用于测试 UDP 代理，并没有实际意义。 启动 frps 和 frpc 分别启动 frps 和 frpc。 测试 DNS 查询请求 使用以下命令通过 dig 工具测试 UDP 包转发是否成功，预期会返回 www.baidu.com 域名的解析结果： /zh-cn/docs/examples/unix-domain-socket/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/unix-domain-socket/ 步骤 配置 frps.toml 在 frps.toml 文件中添加以下内容： bindPort = 7000 配置 frpc.toml 在 frpc.toml 文件中添加以下内容，确保设置正确的 Unix 域套接字路径： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "unix_domain_socket" type = "tcp" remotePort = 6000 [proxies.plugin] type = "unix_domain_socket" # Unix 域套接字路径 unixPath = "/var/run/docker.sock" 启动 frps 和 frpc 使用 curl 查看 Docker 版本信息 curl http://x.x.x.x:6000/version /zh-cn/docs/examples/static-file/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/static-file/ 通过使用 static_file 插件，您可以轻松地提供一个基于 HTTP 的文件访问服务，让其他人可以访问您指定的文件。 步骤 配置 frps.toml 在 frps.toml 文件中添加以下内容： bindPort = 7000 配置 frpc.toml 在 frpc.toml 文件中添加以下内容，确保设置合适的文件路径、用户名和密码： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "test_static_file" type = "tcp" remotePort = 6000 [proxies.plugin] type = "static_file" # 本地文件目录，对外提供访问 localPath = "/tmp/file" # URL 中的前缀，将被去除，保留的内容即为要访问的文件路径 stripPrefix = "static" httpUser = "abc" httpPassword = "abc" 请根据实际情况修改 localPath、stripPrefix、httpUser 和 httpPassword。 启动 frps 和 frpc 通过浏览器访问文件 使用浏览器访问 http://x.x.x.x:6000/static/，以查看位于 /tmp/file 目录下的文件。系统会要求输入您设置的用户名和密码。 /zh-cn/docs/examples/https2http/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/https2http/ 步骤 配置 frps.toml bindPort = 7000 vhostHTTPSPort = 443 配置 frpc.toml serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "test_htts2http" type = "https" customDomains = ["test.yourdomain.com"] [proxies.plugin] type = "https2http" localAddr = "127.0.0.1:80" # HTTPS 证书相关的配置 crtPath = "./server.crt" keyPath = "./server.key" hostHeaderRewrite = "127.0.0.1" requestHeaders.set.x-from-where = "frp" 请注意，您需要根据您的域名和证书路径自行更改上述配置。 启动 frps 和 frpc 访问 HTTPS 服务 打开您的 Web 浏览器，访问 https://test.yourdomain.com。 通过按照以上步骤进行配置，您将能够为本地 HTTP 服务启用 HTTPS，以实现安全的外部访问。 /zh-cn/docs/examples/stcp/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/stcp/ 某些内网服务，如果直接暴露在公网上，可能存在安全风险。使用 stcp(secret tcp) 类型的代理可以让您安全地将内网服务暴露给经过授权的用户，这需要访问者也部署 frpc 客户端。 步骤 配置 frps.toml 在 frps.toml 文件中添加以下内容： bindPort = 7000 部署 frpc 客户端并配置 在需要将内网服务暴露到公网的机器上部署 frpc，并创建如下配置： serverAddr = "x.x.x.x" serverPort = 7000 [[proxies]] name = "secret_ssh" type = "stcp" # 只有与此处设置的 secretKey 一致的用户才能访问此服务 secretKey = "abcdefg" localIP = "127.0.0.1" localPort = 22 在访问者机器上部署并配置 frpc 在想要访问内网服务的机器上也部署 frpc，并创建如下配置： serverAddr = "x.x.x.x" serverPort = 7000 [[visitors]] name = "secret_ssh_visitor" type = "stcp" # 要访问的 stcp 代理的名字 serverName = "secret_ssh" secretKey = "abcdefg" # 绑定本地端口以访问 SSH 服务 bindAddr = "127. /zh-cn/docs/examples/xtcp/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/xtcp/ frp 提供了一种新的代理类型 xtcp，用于在需要传输大量数据且不希望流量经过服务器的情况下实现内网穿透。 与 stcp 类似，使用 xtcp 需要在两端都部署 frpc 以建立直接连接。 需要注意的是，xtcp 并不适用于所有类型的 NAT 设备，如果穿透失败，可以尝试使用 stcp 代理。 步骤 配置需要暴露到外网的机器上的 frpc.toml 文件 在 frpc.toml 文件中添加以下内容，确保设置了正确的服务器地址和端口以及共享密钥 (secretKey)，以及本地服务的 IP 地址和端口： serverAddr = "x.x.x.x" serverPort = 7000 # 如果默认的 STUN 服务器不可用，可以配置一个新的 STUN 服务器 # natHoleStunServer = "xxx" [[proxies]] name = "p2p_ssh" type = "xtcp" # 只有共享密钥 (secretKey) 与服务器端一致的用户才能访问该服务 secretKey = "abcdefg" localIP = "127.0.0.1" localPort = 22 在想要访问内网服务的机器上部署 frpc 在 frpc.toml 文件中添加以下内容，确保设置了正确的服务器地址和端口，共享密钥 (secretKey) 以及要访问的 P2P 代理的名称： /zh-cn/docs/examples/virtualnet/ Mon, 01 Jan 0001 00:00:00 +0000 /zh-cn/docs/examples/virtualnet/ 注意：VirtualNet 是一个 Alpha 阶段的特性，目前不稳定，其配置方式和功能可能会在后续版本中随时调整变更。请勿在生产环境中使用此功能，仅建议用于测试和评估目的。 概述 虚拟网络（VirtualNet）功能是 frp v0.62.0 中引入的 Alpha 特性，它允许 frp 通过 TUN 接口创建和管理客户端与访问者之间的虚拟网络连接，实现设备间的完整网络连通性。 本示例将展示如何配置和使用 VirtualNet 功能。更多详细信息和工作原理，请参考 虚拟网络 (VirtualNet) 特性文档。 启用 VirtualNet 首先，由于 VirtualNet 目前是一个 Alpha 特性，您需要在配置中通过特性门控来启用它： # frpc.toml featureGates = { VirtualNet = true } 示例配置 以下示例展示如何在两台机器之间建立虚拟网络连接： 服务端配置 (机器 A) 在 frpc.toml 中配置虚拟网络地址 # frpc.toml (服务端) serverAddr = "x.x.x.x" serverPort = 7000 featureGates = { VirtualNet = true } # 配置虚拟网络接口 virtualNet.address = "100.86.0.1/24" [[proxies]] name = "vnet-server" type = "stcp" secretKey = "your-secret-key" [proxies.