{"id":13455895,"url":"https://github.com/vaxilu/x-ui","last_synced_at":"2025-05-13T00:27:13.602Z","repository":{"id":37347382,"uuid":"368390355","full_name":"vaxilu/x-ui","owner":"vaxilu","description":"支持多协议多用户的 xray 面板","archived":false,"fork":false,"pushed_at":"2024-08-19T10:14:30.000Z","size":15938,"stargazers_count":17490,"open_issues_count":54,"forks_count":7756,"subscribers_count":179,"default_branch":"main","last_synced_at":"2025-04-08T17:13:39.864Z","etag":null,"topics":["v2-ui","x-ui","xray","xray-core","xray-panel"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vaxilu.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-18T03:32:01.000Z","updated_at":"2025-04-08T13:45:35.000Z","dependencies_parsed_at":"2024-01-13T17:48:16.644Z","dependency_job_id":"4f7ab115-5712-490f-9a98-eea14c41d797","html_url":"https://github.com/vaxilu/x-ui","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaxilu%2Fx-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaxilu%2Fx-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaxilu%2Fx-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaxilu%2Fx-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaxilu","download_url":"https://codeload.github.com/vaxilu/x-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250492396,"owners_count":21439522,"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":["v2-ui","x-ui","xray","xray-core","xray-panel"],"created_at":"2024-07-31T08:01:13.041Z","updated_at":"2025-04-23T18:40:07.995Z","avatar_url":"https://github.com/vaxilu.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","其他_安全与渗透"],"sub_categories":["网络服务_其他"],"readme":"# x-ui\n\n支持多协议多用户的 xray 面板\n\n# 功能介绍\n\n- 系统状态监控\n- 支持多用户多协议，网页可视化操作\n- 支持的协议：vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http\n- 支持配置更多传输配置\n- 流量统计，限制流量，限制到期时间\n- 可自定义 xray 配置模板\n- 支持 https 访问面板（自备域名 + ssl 证书）\n- 支持一键SSL证书申请且自动续签\n- 更多高级配置项，详见面板\n\n# 安装\u0026升级\n\n```\nbash \u003c(curl -Ls https://raw.githubusercontent.com/vaxilu/x-ui/master/install.sh)\n```\n\n## 手动安装\u0026升级\n\n1. 首先从 https://github.com/vaxilu/x-ui/releases 下载最新的压缩包，一般选择 `amd64`架构\n2. 然后将这个压缩包上传到服务器的 `/root/`目录下，并使用 `root`用户登录服务器\n\n\u003e 如果你的服务器 cpu 架构不是 `amd64`，自行将命令中的 `amd64`替换为其他架构\n\n```\ncd /root/\nrm x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -rf\ntar zxvf x-ui-linux-amd64.tar.gz\nchmod +x x-ui/x-ui x-ui/bin/xray-linux-* x-ui/x-ui.sh\ncp x-ui/x-ui.sh /usr/bin/x-ui\ncp -f x-ui/x-ui.service /etc/systemd/system/\nmv x-ui/ /usr/local/\nsystemctl daemon-reload\nsystemctl enable x-ui\nsystemctl restart x-ui\n```\n\n## 使用docker安装\n\n\u003e 此 docker 教程与 docker 镜像由[Chasing66](https://github.com/Chasing66)提供\n\n1. 安装docker\n\n```shell\ncurl -fsSL https://get.docker.com | sh\n```\n\n2. 安装x-ui\n\n```shell\nmkdir x-ui \u0026\u0026 cd x-ui\ndocker run -itd --network=host \\\n    -v $PWD/db/:/etc/x-ui/ \\\n    -v $PWD/cert/:/root/cert/ \\\n    --name x-ui --restart=unless-stopped \\\n    enwaiax/x-ui:latest\n```\n\n\u003e Build 自己的镜像\n\n```shell\ndocker build -t x-ui .\n```\n\n## SSL证书申请\n\n\u003e 此功能与教程由[FranzKafkaYu](https://github.com/FranzKafkaYu)提供\n\n脚本内置SSL证书申请功能，使用该脚本申请证书，需满足以下条件:\n\n- 知晓Cloudflare 注册邮箱\n- 知晓Cloudflare Global API Key\n- 域名已通过cloudflare进行解析到当前服务器\n\n获取Cloudflare Global API Key的方法:\n    ![](media/bda84fbc2ede834deaba1c173a932223.png)\n    ![](media/d13ffd6a73f938d1037d0708e31433bf.png)\n\n使用时只需输入 `域名`, `邮箱`, `API KEY`即可，示意图如下：\n        ![](media/2022-04-04_141259.png)\n\n注意事项:\n\n- 该脚本使用DNS API进行证书申请\n- 默认使用Let'sEncrypt作为CA方\n- 证书安装目录为/root/cert目录\n- 本脚本申请证书均为泛域名证书\n\n## Tg机器人使用（开发中，暂不可使用）\n\n\u003e 此功能与教程由[FranzKafkaYu](https://github.com/FranzKafkaYu)提供\n\nX-UI支持通过Tg机器人实现每日流量通知，面板登录提醒等功能，使用Tg机器人，需要自行申请\n具体申请教程可以参考[博客链接](https://coderfan.net/how-to-use-telegram-bot-to-alarm-you-when-someone-login-into-your-vps.html)\n使用说明:在面板后台设置机器人相关参数，具体包括\n\n- Tg机器人Token\n- Tg机器人ChatId\n- Tg机器人周期运行时间，采用crontab语法  \n\n参考语法：\n- 30 * * * * * //每一分的第30s进行通知\n- @hourly      //每小时通知\n- @daily       //每天通知（凌晨零点整）\n- @every 8h    //每8小时通知  \n\nTG通知内容：\n- 节点流量使用\n- 面板登录提醒\n- 节点到期提醒\n- 流量预警提醒  \n\n更多功能规划中...\n## 建议系统\n\n- CentOS 7+\n- Ubuntu 16+\n- Debian 8+\n\n# 常见问题\n\n## 从 v2-ui 迁移\n\n首先在安装了 v2-ui 的服务器上安装最新版 x-ui，然后使用以下命令进行迁移，将迁移本机 v2-ui 的 `所有 inbound 账号数据`至 x-ui，`面板设置和用户名密码不会迁移`\n\n\u003e 迁移成功后请 `关闭 v2-ui`并且 `重启 x-ui`，否则 v2-ui 的 inbound 会与 x-ui 的 inbound 会产生 `端口冲突`\n\n```\nx-ui v2-ui\n```\n\n## issue 关闭\n\n各种小白问题看得血压很高\n\n## Stargazers over time\n\n[![Stargazers over time](https://starchart.cc/vaxilu/x-ui.svg)](https://starchart.cc/vaxilu/x-ui)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaxilu%2Fx-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaxilu%2Fx-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaxilu%2Fx-ui/lists"}