Gradio 共享服务器 (FRP)
这个仓库是 Fast Reverse Proxy (FRP) 的一个分支,运行在 Gradio 的共享服务器上,用于启用 Gradio 的共享链接。以下是如何设置自己的共享服务器以生成自定义共享链接的说明 🔥
背景
当你创建一个 Gradio 应用并通过 share=True
启动它时,如下所示:
import gradio as gr
app = gr.Interface(lambda x: x, "image", "image")
app.launch(share=True)
你会得到一个类似 https://07ff8706ab.gradio.live
的共享链接,你的 Gradio 应用现在可以通过互联网被任何人访问(最多 72 小时)。
这是如何实现的? 你的 Gradio 应用在本地运行在 Python 服务器上,但我们使用 FRP 将本地服务器暴露给互联网。FRP 由两部分组成:
- FRP 客户端:运行在你的机器上。我们为最常见的操作系统打包了二进制文件,你系统的 FRP 客户端会在你首次在你的机器上创建共享链接时下载。
- FRP 服务器:运行在 Gradio 的共享服务器上,但由于 FRP 服务器是开源的,你也可以在自己的服务器上运行它!
FRP 客户端从你的本地机器建立到 FRP 服务器的连接,FRP 服务器可以在互联网上访问。然后 FRP 服务器提供一个公共 URL,将传入的请求转发到 FRP 客户端,后者再将请求发送到你本地运行的 Web 应用。
为什么要运行自己的共享服务器?
你可能出于以下几个原因想要运行自己的服务器:
- 自定义域名:你可以使用任何你喜欢的域名,只要你拥有它,而不是
*.gradio.live
- 更长时间的链接:当你运行自己的共享服务器时,你不需要限制共享链接在 72 小时后过期
- 安全/隐私:通过在你的虚拟私有云中设置自己的共享服务器,你可以让你的信息安全团队满意
这也相当简单。在你的 Gradio 应用中,你只需要在 launch()
中传入共享服务器的 IP 地址作为 share_server_address
参数:
import gradio as gr
app = gr.Interface(lambda x: x, "image", "image")
app.launch(share=True, share_server_address="my-gpt-wrapper.com:7000")
瞧!
Running on public URL: http://07f56cd0f87061c8a1.my-gpt-wrapper.com
设置共享服务器
先决条件
- 一个服务器(例如 AWS 上的 EC2 机器),运行 Linux 并连接到互联网。大多数云提供商提供的服务器(例如 AWS 上的
t2-small
)应该足够了,我们建议至少有 2 GB 的 RAM 和 8 GB 的磁盘空间。你需要能够 SSH 到你的服务器。 - 服务器应该有一个弹性 IP 地址和一个域名。具体说明取决于你使用的域名注册商和云提供商。例如,这里是 AWS 使用 EC2 和 Route53 的说明。
重要:不仅是根域名,所有子域名都应该路由到你服务器的 IP 地址。这通常意味着你应该在 DNS 记录中有一个通配符条目,如这里最下面的条目所示:
1. 安装 Docker(20.10 版本或更高)
你可以在 SSH 到服务器后,在终端中依次运行这些命令(本指南假设你运行的是 Ubuntu):
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"
apt-cache policy docker-ce
sudo apt install docker-ce
通过在终端中运行 docker version
确认已安装 Docker 并且运行的版本是 20.10
或更高。你应该看到类似这样的内容:
Client: Docker Engine - Community
Version: 24.0.6
...
2. 克隆此仓库
git clone git@github.com:huggingface/frp.git
cd frp
3. 编辑 FRP 服务器配置文件
打开 scripts/frps.ini
文件,编辑 subdomain_host
属性的值以反映你的域名(不带任何前缀)。
你还可以设置 bind_port
,这是用于 FRP 连接的默认端口,可以设置为 7000
以外的值,或自定义 404 页面(custom_404_page
),当没有活动的 Gradio 应用连接到共享服务器时会显示该页面。
这里是一个自定义的 .ini
文件示例:
[common]
log_level = trace
tcp_mux = true
bind_port = 7000
dashboard_port = 7001
vhost_http_port = 80
subdomain_host = my-gpt-wrapper.com
detailed_errors_to_client = false
custom_404_page = /etc/frp/my-404.html
注意:如果你想更改共享链接的过期时间(默认为 72 小时),也要编辑 server/control.go
中的这一行。
4. 启动 FRP 服务器 Docker 容器
注意:这些命令可能需要 sudo
权限:
docker build -f dockerfiles/Dockerfile-for-frps -t frps:0.2 .
docker run --log-opt max-size=100m --memory=1G --cpus=1 --name frps3 -d --restart unless-stopped --network host -v ~/frp/scripts:/etc/frp frps:0.2 -c /etc/frp/frps.ini
5. 允许流量进入你的服务器
为了确保用户可以连接到你的共享服务器,你需要确保在正确的端口允许流量。你需要允许:
- TCP 流量到端口
7000
(或你在第 3 步中选择的bind_port
) - HTTP 流量到端口
80
- (可选,如果你的域名有 HTTPS 证书)HTTPS 流量到端口
443
注意:如果你愿意,你可以将前者规则的 IP 地址限制为那些应该能够创建共享链接的人,并将后两个规则的 IP 地址限制为那些应该能够查看共享链接的用户。
如果你使用的是 AWS,你的安全规则可能看起来像这样:
就是这样!你现在有了自己的小共享服务器!如前所述,你可以通过在 launch()
中将 IP 地址和 FRPS 端口作为单个字符串传递给 share_server_address
参数来使用它,如下所示:
import gradio as gr
app = gr.Interface(lambda x: x, "image", "image")
app.launch(share=True, share_server_address="my-gpt-wrapper.com:7000")
注意:如果你在共享服务器上安装了 HTTPS 证书,并且你的共享链接通过 HTTPS 提供服务,那么你还应该在 launch()
中设置 share_server_protocol="https"
。