{"id":13455789,"url":"https://github.com/FranzKafkaYu/x-ui","last_synced_at":"2025-03-24T09:30:44.012Z","repository":{"id":37476698,"uuid":"469051838","full_name":"FranzKafkaYu/x-ui","owner":"FranzKafkaYu","description":"Lightweight Xray panel with multi-protocol and multi-user on the same port,supports English language and Telegram bot. Easy to use and easy to manage.","archived":true,"fork":true,"pushed_at":"2024-11-13T16:02:11.000Z","size":16533,"stargazers_count":8196,"open_issues_count":83,"forks_count":1694,"subscribers_count":73,"default_branch":"main","last_synced_at":"2025-01-19T14:32:12.409Z","etag":null,"topics":["grpc","proxy","reality","shadowsocks","shadowsocks2022","telegram-bot","trojan","v2ray","vless","vmess","vpn","x-ui","xray","xray-core","xtls","xtls-rprx-vision"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"vaxilu/x-ui","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FranzKafkaYu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-03-12T10:36:25.000Z","updated_at":"2025-01-19T10:48:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"ad179130-7a16-4df9-a9f3-ef58128622e1","html_url":"https://github.com/FranzKafkaYu/x-ui","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranzKafkaYu%2Fx-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranzKafkaYu%2Fx-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranzKafkaYu%2Fx-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FranzKafkaYu%2Fx-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FranzKafkaYu","download_url":"https://codeload.github.com/FranzKafkaYu/x-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245243130,"owners_count":20583566,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grpc","proxy","reality","shadowsocks","shadowsocks2022","telegram-bot","trojan","v2ray","vless","vmess","vpn","x-ui","xray","xray-core","xtls","xtls-rprx-vision"],"created_at":"2024-07-31T08:01:11.109Z","updated_at":"2025-03-24T09:30:44.005Z","avatar_url":"https://github.com/FranzKafkaYu.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# X-UI\r\n简体中文|[ENGLISH](./README_EN.md)  \r\n\r\n\u003e 声明：该项目仅供个人学习、交流，请遵守当地法律法规,勿用于非法用途;请勿用于生产环境  \r\n\u003e 声明：该项目已闭源，介意者请勿使用；如您需要开源代码，请附上您的Github Profile邮箱联系  \r\n\r\n支持单端口多用户、多协议的 xray 面板，究极缝合怪    \r\n通过免费的Telegram bot方便快捷地进行监控、管理你的代理服务  \r\n\u0026#x26A1;`xtls-rprx-vision`与`reality`快速入手请看[这里](https://github.com/FranzKafkaYu/x-ui/wiki/%E8%8A%82%E7%82%B9%E9%85%8D%E7%BD%AE)  \r\n欢迎大家使用并反馈意见或提交Pr,帮助项目更好的改善  \r\n如果您觉得本项目对您有所帮助,不妨给个star:star2:支持我  \r\n或者你恰巧有购买服务器的需求,可以通过文末的赞助部分支持我~ \r\n\r\n# 文档目录  \r\n- [功能介绍](#功能介绍)  \r\n- [一键安装](#一键安装)  \r\n- [效果预览](#效果预览)  \r\n- [快捷方式](#快捷方式)  \r\n- [变更记录](#变更记录)\r\n\r\n# 功能介绍\r\n\r\n- 系统状态监控\r\n- 支持单端口多用户、多协议，网页可视化操作\r\n- 支持的协议：vmess、vless、trojan、shadowsocks、shadowsocks 2022、dokodemo-door、socks、http\r\n- 支持配置更多传输配置：http、tcp、ws、grpc、kcp、quic\r\n- 流量统计，限制流量，限制到期时间，一键重置与设备监控\r\n- 可自定义 xray 配置模板\r\n- 支持 https 访问面板（自备域名 + ssl 证书）\r\n- 支持一键SSL证书申请且自动续签\r\n- Telegram bot通知、控制功能\r\n- 更多高级配置项，详见面板 \r\n\r\n:bulb:具体**使用、配置细节以及问题排查**请点击这里:point_right:[WIKI](https://github.com/FranzKafkaYu/x-ui/wiki):point_left:  \r\n Specific **Usages、Configurations and Debug** please refer to [WIKI](https://github.com/FranzKafkaYu/x-ui/wiki)    \r\n# 一键安装\r\n在安装前请确保你的系统支持`bash`环境,且系统网络正常  \r\n\r\n\u0026#x26A1;从原版升级也可使用该命令，数据不会丢失\u0026#x26A1;\r\n\r\n```\r\nbash \u003c(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install.sh)\r\n```    \r\nFor English Users,please use the following command to install English supported version:  \r\n```\r\nbash \u003c(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install_en.sh)\r\n```\r\n如需安装指定的版本,可以在上述命令中指定版本号,如指定版本为`0.3.4.4`,安装命令如下：    \r\n```\r\nbash \u003c(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install.sh) 0.3.4.4   \r\n```\r\n\r\n# 效果预览  \r\n`面板使用`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e  \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/180629631-f76a05c8-ecf0-4685-bbc7-a7058747d213.png)  \r\n![image](https://user-images.githubusercontent.com/38254177/180629662-b7a325fc-1ebb-47c9-992c-1e7c758a326b.png)\r\n\r\n\r\n \u003c/details\u003e  \r\n \r\n`Bot使用`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e  \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/178551055-893936b7-b75f-4ee8-a773-eee7c6f43f51.png)  \r\n \r\n\u003c/details\u003e  \r\n\r\n`流量提醒`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/180039760-dc987a30-e21c-49a3-8e03-19666566a822.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n`SSH提醒`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/180040129-2ec1a7c0-abd3-41dc-aab0-8cd22415c943.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n`限额提醒`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/180040521-af6e9ef8-d7e5-44e8-834e-25b3b8e3e1b5.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n`到期提醒`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/180041690-90ca4b1f-3a2d-470b-bc0c-eca9261a739a.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n`登录提醒`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/180040913-b8bf2fe1-6fc1-43ab-a683-ae23db1866b2.png)  \r\n![image](https://user-images.githubusercontent.com/38254177/180041179-a5f4cd52-a1ba-4aa9-abb2-b94e36722385.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n`用户速览`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/230761101-20431dd7-5bce-489e-9139-0ceb9ab9a2dc.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n`用户查询`:  \r\n\u003cdetails\u003e\r\n\u003csummary\u003e\u003cb\u003e点击查看效果预览\u003c/b\u003e\u003c/summary\u003e \r\n  \r\n![image](https://user-images.githubusercontent.com/38254177/230761252-c283c02d-82a4-46ce-a180-dfab4048180d.png)\r\n\r\n\u003c/details\u003e  \r\n\r\n\r\n\r\n# 快捷方式\r\n安装成功后，通过键入`x-ui`进入控制选项菜单，目前菜单内容：\r\n```\r\n  x-ui 面板管理脚本\r\n  0. 退出脚本\r\n————————————————\r\n  1. 安装 x-ui\r\n  2. 更新 x-ui\r\n  3. 卸载 x-ui\r\n————————————————\r\n  4. 重置用户名密码\r\n  5. 重置面板设置\r\n  6. 设置面板端口\r\n  7. 查看当前面板设置\r\n————————————————\r\n  8. 启动 x-ui\r\n  9. 停止 x-ui\r\n  10. 重启 x-ui\r\n  11. 查看 x-ui 状态\r\n  12. 查看 x-ui 日志\r\n————————————————\r\n  13. 设置 x-ui 开机自启\r\n  14. 取消 x-ui 开机自启\r\n————————————————\r\n  15. 一键安装 bbr (最新内核)\r\n  16. 一键申请SSL证书(acme申请)\r\n \r\n面板状态: 已运行\r\n是否开机自启: 是\r\nxray 状态: 运行\r\n\r\n请输入选择 [0-16]: \r\n```\r\n# 配置要求  \r\n## 内存  \r\n- 128MB minimal/256MB+ recommend  \r\n## OS  \r\n- CentOS 7+\r\n- Ubuntu 16+\r\n- Debian 8+\r\n\r\n# 变更记录   \r\n- 2023.07.18：随机生成Reality dest与serverNames,去除微软域名;细化sniffing配置  \r\n- 2023.06.10：开启TLS时自动复用面板证书与域名;增加证书热重载设定;优化设备限制功能  \r\n- 2023.04.09：支持Reality;支持新的telegram bot控制指令  \r\n- 2023.03.05：支持用户到期时间限制;随机用户名、密码与端口生成\r\n- 2023.02.09：支持单端口内用户流量限制与统计；支持VLESS utls配置与分享链接导出  \r\n- 2022.12.07：添加设备并发限制;细化tls配置,支持minVersion、maxVersion与cipherSuites选择    \r\n- 2022.11.14：添加xtls-rprx-vision流控选项;定时自动更新geo与清除日志  \r\n- 2022.10.23：实现全英文支持;增加批量导出分享链接功能；优化页面细节与Telegram通知    \r\n- 2022.08.11：实现Vmess/Vless/Trojan单端口多用户；增加CPU使用超限提醒  \r\n- 2022.07.28：增加acme standalone模式申请证书;增加x-ui自动保活机制;优化编译选项以适配更多系统  \r\n- 2022.07.24：增加自动生成面板根路径，节点流量自动重置功能，设备IP接入变化通知功能\r\n- 2022.07.21：增加节点IP接入变化提醒，Web面板增加停止/重启xray功能，优化部分翻译\r\n- 2022.07.11：增加节点到期提醒、流量预警策略，增加Telegram bot节点复制、获取分享链接等\r\n- 2022.07.03：重构Telegram bot功能，指令控制不再需要键盘输入;增加Trojan底层传输配置\r\n- 2022.06.19：增加Shadowsocs2022新的Cipher，增加节点搜索、一键清除流量功能\r\n- 2022.05.14：增加Telegram bot Command控制功能，支持关闭/开启/删除节点等\r\n- 2022.04.25：增加SSH登录提醒、面板登录提醒\r\n- 2022.04.23：增加更多Telegram bot提醒功能\r\n- 2022.04.16：增加面板设置Telegram bot功能\r\n- 2022.04.12：优化Telegram Bot通知提醒\r\n- 2022.04.06：优化安装/更新流程，增加证书签发功能，添加Telegram bot机器人推送功能\r\n# Telegram\r\n\r\n[订阅频道](https://t.me/CoderfanBaby)  \r\n[讨论群组](https://t.me/franzkafayu)\r\n\r\n# 致谢\r\n\r\n- [vaxilu/x-ui](https://github.com/vaxilu/x-ui)\r\n- [XTLS/Xray-core](https://github.com/XTLS/Xray-core)\r\n- [telegram-bot-api](https://github.com/go-telegram-bot-api/telegram-bot-api)  \r\n\r\n# 广告赞助  \r\n\r\n如果你觉得本项目对你有用,而且你也恰巧有这方面的需求,你也可以选择通过我的购买链接赞助我  \r\n- [搬瓦工GIA高端线路](https://bandwagonhost.com/aff.php?aff=65703),仅推荐购买GIA套餐      \r\n- [Cloudcone性价比主机提供商](https://app.cloudcone.com/?ref=7536)  \r\n- [Spartan三网4837性价比主机](https://billing.spartanhost.net/aff.php?aff=1875)\r\n\r\n  \r\n如果你希望购买一些现成的代理服务,可选择下述代理服务\r\n- [搬瓦工关联机场](https://justmysocks.net/members/aff.php?aff=18177)  \r\n- [高端奶昔机场](https://nxboom.com/signupbyemail.aspx?MemberCode=2fd79885e45549049c66698f1eea154620230921234746)\r\n\r\nVPS推送可关注电报[频道](https://t.me/VpsReStockAlert)  \r\n\r\n## Stargazers over time\r\n\r\n[![Stargazers over time](https://starchart.cc/FranzKafkaYu/x-ui.svg)](https://starchart.cc/FranzKafkaYu/x-ui)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFranzKafkaYu%2Fx-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFranzKafkaYu%2Fx-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFranzKafkaYu%2Fx-ui/lists"}