记录部署WARP-Clash-API

项目介绍

🆔 项目名称：WARP-Clash-API

⭐️ 项目功能：使用 Cloudflare WARP+

📁 项目简介：一个开源的允许通过订阅方式使用 Cloudflare WARP+的工具。内置功能可刷取 WARP+ 流量，每18秒可获得1GB流量，无流量限制。

提供IP选优功能，兼容Clash、Shadowrocket等多种客户端。支持Docker compose一键部署，简化安装和使用过程。

🌐 项目地址：点击直达

首先ssh命令

 git clone https://github.com/vvbbnn00/WARP-Clash-API.git

然后在项目目录下创建 .env.local文件，填入以下变量

SECRET_KEY=xxx
#选填#密码，用于保护订阅链接，若不配置，则不需要输入SECRET_KEY即可获取订阅链接
PUBLIC_URL=192.0.0.0
#选填##不填默认IP，部署在公网上时，填写公网IP或域名，用于生成订阅链接

继续ssh命令

cd /root/WARP-Clash-API#进入文件夹
docker-compose up -d#运行

访问http://你的IP:21001，输入SECRET_KEY（若没有配置，则可以留空），即可获取订阅链接

项目本身包含了一个选优过的IP列表，但是由于WARP的IP是动态的，所以可能会出现IP不可用的情况。若您需要手动选优，可以遵循以下步骤：

若您通过docker-compose部署，可以在项目目录下通过以下命令手动执行IP选优：

docker-compose exec warp-clash python3 app.py optimize

否则，可以在项目目录下执行以下命令：

python3 app.py optimize

例如，您设置SECRET_KEY为123456，并打算将订阅分享给社区，那么您的.env.local文件应该如下：

SECRET_KEY=123456
SHARE_SUBSCRIPTION=True

请注意，如果您设置了SECRET_KEY，需要在URL的末尾添加key参数，例如：

http://your_IP:21001/some/api/actions?key=your_secret_key

项目支持您通过请求以下接口来重置PublicKey和PrivateKey：

curl -X POST http://host:port/api/account/reset_key

重置过后，需要重新获取订阅内容，否则可能无法使用。

若您已经拥有了WARP+的LicenseKey，可以通过以下接口来设置：

curl -X POST http://host:port/api/account/update_license -H "Content-Type: application/json" -d "{\"license_key\": \"your_license_key\"}"

请注意，当您设置了LicenseKey后，其PublicKey和PrivateKey将会被重置，需要重新获取订阅内容。