• Stars
    star
    8,360
  • Rank 4,399 (Top 0.09 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created about 1 year ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

该项目可以让你通过订阅的方式使用Cloudflare WARP+,自动获取流量。This project enables you to use Cloudflare WARP+ through subscription, automatically acquiring traffic.

WARP Clash API

GitHub License Codacy Badge GitHub Repo stars

中文 | English

Warning

本项目是完全非商业项目,仅供学习交流使用,请勿用于非法用途,否则后果自负。

🤔 这是什么?

该项目可以让你通过订阅的方式使用WARP+,支持ClashShadowrocket等客户端。项目内置了 刷取WARP+流量的功能,可以让你的WARP+流量不再受限制(每18秒可获得1GB流量),同时, 配备了IP选优功能。支持Docker compose一键部署,无需额外操作,即可享受你自己的WARP+私 有高速节点!

💡 特色功能

  • 💻 支持ClashSurgeShadowrocket等客户端
  • 🔑 支持设置您自己的LicenseKey
  • 🌏 支持IP选优
  • 🐋 支持Docker compose一键部署
  • 📕 全自动刷取WARP+流量,请求经过代理,防封IP
  • ❓ 每次更新订阅随机节点,让你体验抽卡的乐趣

🚀 快速上手

1. 安装DockerDocker compose

2. 下载项目

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

3. [可选] 配置SECRET_KEY

若您需要在公网上部署该项目,建议您配置SECRET_KEYPUBLIC_URL。在项目目录下创建 .env.local文件,写入如下内容:

SECRET_KEY=your_secret_key

关于环境变量的更多信息,请参考环境变量

4. 编译并运行

docker-compose up -d

5. 获取订阅链接

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

🎉 大功告成

🌏 手动IP选优

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

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

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

否则,可以在项目目录下执行以下命令:

python3 app.py optimize

🔧 环境变量

没错,您可以通过环境变量来配置该项目,在配置时,只需新建一个.env.local文件,写入您需要的环境 变量即可。

以下是可用的环境变量:

变量名 默认值 说明
DELAY_THRESHOLD 500 延迟阈值,超过该阈值的IP将被剔除
DO_GET_WARP_DATA True 是否刷取WARP+流量,若不需要刷取流量,则设置为False即可
GET_WARP_DATA_INTERVAL 18 刷取WARP+流量的时间间隔,单位为秒,每隔该时间间隔会刷取一次WARP+流量,不建议间隔设置过短。
LOSS_THRESHOLD 10 丢包率阈值,超过该阈值的IP将被剔除
PROXY_POOL_URL https://getproxy.bzpl.tech/get/ IP代理池地址,用于刷取WARP+流量,您可以自行搭建,参照proxy_pool
PUBLIC_URL 部署在公网上时,填写公网IP或域名,用于生成订阅链接,比如 https://subs.zeabur.app
RANDOM_COUNT 10 每次更新订阅随机节点的数量
REOPTIMIZE_INTERVAL -1 重新选优的时间间隔,单位为秒,若小于等于0,则不会重新选优,否则每隔该时间间隔会重新选优一次,不建议间隔设置过短。
REQUEST_RATE_LIMIT 0 限制X秒一次请求,该功能不太稳定,建议不要开启
SECRET_KEY 用于保护订阅链接,若不配置,则不需要输入SECRET_KEY即可获取订阅链接
SHARE_SUBSCRIPTION False 若您的站点想要向社区分享订阅,但不想让自己的账户信息被公开或修改,可以设置为True,此时,访问订阅链接时,不需要输入SECRET_KEY即可获取,而对于其他的操作,仍然需要输入SECRET_KEY

📝 配置示例

例如,您设置SECRET_KEY123456,并打算将订阅分享给社区,那么您的.env.local文件应该 如下:

SECRET_KEY=123456
SHARE_SUBSCRIPTION=True

🧰 进阶操作

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

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

重置账户的PublicKeyPrivateKey

项目支持您通过请求以下接口来重置PublicKeyPrivateKey

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

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

设置自己的LicenseKey

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

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

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

🗂️ 引用项目

本项目的开发参照了以下项目,感谢这些开源项目的作者:

More Repositories

1

qndxxAutoStudy

支持Github托管自动学习的上海地区青年大学习自动学习脚本,青春上海;无需访问微信,无需任何多余的操作即可实现自动完成青年大学习(上海地区)
Python
72
star
2

USST_Auto_Health_Clock_In

USST健康打卡,支持HTTP API
Python
23
star
3

onedrive-index

☁ OneDrive public directory listing, based on onedrive-vercel-index, the secondary development Onedrive project fixes security vulnerabilities and improves performance, and provides Docker environment deployment solutions. 基于onedrive-vercel-index,修复安全漏洞并提升性能的二次开发Onedrive项目,提供Docker环境部署方案。
TypeScript
17
star
4

USST-Lecture-Table-Calendar

基于next.js的上海理工大学课程表日历订阅服务,支持将课表导入日历APP,并保持更新。
JavaScript
13
star
5

vvbbnn00

5
star
6

goflet

Goflet is a lightweight file upload and download service written in Go, featuring authentication, resumable uploads, file integrity verification, image processing, and OnlyOffice integration for a comprehensive file management solution.
Go
5
star
7

USST-Datastruct_CourseSystem

上海理工大学数据结构课程设计项目:课程信息管理系统
C
4
star
8

JavaWeb-CanteenSystem

USST JavaWeb大作业:上海理工大学食堂点评交流社区
Java
4
star
9

usst-91-backend

USST就业日历轻应用后端
Python
3
star
10

e-hentaiReader

【未完成勿下载】一款支持iOS/安卓/H5(需要配置跨域插件)/小程序(理论支持)的ehentai网站画廊阅读器。
Vue
3
star
11

homewksys-uniapp

作业任务系统前端-移动版
Vue
3
star
12

python_proxy_protocol

一种通过魔改代码实现让Python Web服务器支持Proxy Protocol的方法,支持flask
Python
2
star
13

Proj-Homo-Next

使用next.js实现的“田所浩二.我爱你”站点。
JavaScript
2
star
14

CourseSystem_python

学生选课系统后端,大一C语言课设
Python
2
star
15

malody-stats-card

Display Malody user game data seamlessly on blogs, websites, or other platforms. Open-source and customizable. 年轻人的第一款Malody状态卡片,在博客、网站或其他平台上轻松显示 Malody 用户的游戏数据。开源且可自定义。
JavaScript
2
star
16

CourseSystem

学生选课系统,大一C语言课设
C
2
star
17

USST-Datastruct_schoolNavigator

上海理工大学数据结构课程设计:校园导航系统的设计实现
C
2
star
18

Homework_PictureDataHider

Java
2
star
19

MangaHelper

您可以通过本网站下载漫画,并在线转为pdf格式,发送至kindle或直接下载。您可以直接通过kindle访问我架设的官网,也可以下载python源代码自行编译使用。
Python
2
star
20

smfms2020Grade12SummerVacationHomeworkSystem

上闵外2020年暑假高三作业任务系统
JavaScript
1
star
21

bzpl_login

自己编写的用户登录中心模块
HTML
1
star
22

QndxxScreenShotCreater

【青年大学习截图生成器】刷新一次更换一次截屏样式,基于python-flask的青年大学习截屏生成器后端
Python
1
star
23

USST-DistributedSystem-RPC

上海理工大学 分布式系统实验 RPC框架实现
Java
1
star
24

Homework-VideoPlayer

Kotlin
1
star
25

Homework-VideoPlayer-Backend

移动应用开发-视频后端
Python
1
star
26

jd_song_pack_1

jsdelivr专用,存放网站内的歌曲
JavaScript
1
star
27

PersonalWebsite

网站http://vvbbnn00.cn
SCSS
1
star
28

6.824

An implementation of MIT-6.824-2021
Go
1
star