1
1
# x-ui
2
+
2
3
支持多协议多用户的 xray 面板
3
4
4
5
# 功能介绍
6
+
5
7
- 系统状态监控
6
8
- 支持多用户多协议,网页可视化操作
7
9
- 支持的协议:vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http
12
14
- 支持一键SSL证书申请且自动续签
13
15
- 更多高级配置项,详见面板
14
16
15
-
16
17
# 安装&升级
18
+
17
19
```
18
20
bash <(curl -Ls https://raw.githubusercontent.com/vaxilu/x-ui/master/install.sh)
19
21
```
20
22
21
23
## 手动安装&升级
22
- 1 . 首先从 https://github.com/vaxilu/x-ui/releases 下载最新的压缩包,一般选择` amd64 ` 架构
23
- 2 . 然后将这个压缩包上传到服务器的` /root/ ` 目录下,并使用` root ` 用户登录服务器
24
24
25
- > 如果你的服务器 cpu 架构不是` amd64 ` ,自行将命令中的` amd64 ` 替换为其他架构
25
+ 1 . 首先从 https://github.com/vaxilu/x-ui/releases 下载最新的压缩包,一般选择 ` amd64 ` 架构
26
+ 2 . 然后将这个压缩包上传到服务器的 ` /root/ ` 目录下,并使用 ` root ` 用户登录服务器
27
+
28
+ > 如果你的服务器 cpu 架构不是 ` amd64 ` ,自行将命令中的 ` amd64 ` 替换为其他架构
26
29
27
30
```
28
31
cd /root/
@@ -42,10 +45,13 @@ systemctl restart x-ui
42
45
> 此 docker 教程与 docker 镜像由[ Chasing66] ( https://github.com/Chasing66 ) 提供
43
46
44
47
1 . 安装docker
48
+
45
49
``` shell
46
50
curl -fsSL https://get.docker.com | sh
47
51
```
52
+
48
53
2 . 安装x-ui
54
+
49
55
``` shell
50
56
mkdir x-ui && cd x-ui
51
57
docker run -itd --network=host \
@@ -54,64 +60,82 @@ docker run -itd --network=host \
54
60
--name x-ui --restart=unless-stopped \
55
61
enwaiax/x-ui:latest
56
62
```
57
- > Build 自己的镜像
63
+
64
+ > Build 自己的镜像
65
+
58
66
``` shell
59
67
docker build -t x-ui .
60
68
```
69
+
61
70
## SSL证书申请
62
- > 此功能与教程由[ FranzKafkaYu] ( https://github.com/FranzKafkaYu ) 提供
63
71
64
- 脚本内置SSL证书申请功能,使用该脚本申请证书,需满足以下条件:
72
+ > 此功能与教程由[ FranzKafkaYu] ( https://github.com/FranzKafkaYu ) 提供
73
+
74
+ 脚本内置SSL证书申请功能,使用该脚本申请证书,需满足以下条件:
75
+
65
76
- 知晓Cloudflare 注册邮箱
66
77
- 知晓Cloudflare Global API Key
67
- - 域名已通过cloudflare进行解析到当前服务器
78
+ - 域名已通过cloudflare进行解析到当前服务器
68
79
69
80
获取Cloudflare Global API Key的方法:
70
81
![ ] ( media/bda84fbc2ede834deaba1c173a932223.png )
71
- ![ ] ( media/d13ffd6a73f938d1037d0708e31433bf.png )
82
+ ![ ] ( media/d13ffd6a73f938d1037d0708e31433bf.png )
72
83
73
- 使用时只需输入` 域名 ` , ` 邮箱 ` , ` API KEY ` 即可,示意图如下:
74
- ![ ] ( media/2022-04-04_141259.png )
84
+ 使用时只需输入 ` 域名 ` , ` 邮箱 ` , ` API KEY ` 即可,示意图如下:
85
+ ![ ] ( media/2022-04-04_141259.png )
75
86
76
87
注意事项:
77
- - 该脚本使用DNS API进行证书申请
88
+
89
+ - 该脚本使用DNS API进行证书申请
78
90
- 默认使用Let'sEncrypt作为CA方
79
- - 证书安装目录为/root/cert目录
91
+ - 证书安装目录为/root/cert目录
80
92
- 本脚本申请证书均为泛域名证书
81
93
82
94
## Tg机器人使用(开发中,暂不可使用)
83
- > 此功能与教程由[ FranzKafkaYu] ( https://github.com/FranzKafkaYu ) 提供
84
95
85
- X-UI支持通过Tg机器人实现每日流量通知,面板登录提醒等功能,使用Tg机器人,需要自行申请
86
- 具体申请教程可以参考[ 博客链接] ( https://coderfan.net/how-to-use-telegram-bot-to-alarm-you-when-someone-login-into-your-vps.html )
87
- 使用说明:在面板后台或通过脚本设置机器人相关参数,具体包括
96
+ > 此功能与教程由[ FranzKafkaYu] ( https://github.com/FranzKafkaYu ) 提供
97
+
98
+ X-UI支持通过Tg机器人实现每日流量通知,面板登录提醒等功能,使用Tg机器人,需要自行申请
99
+ 具体申请教程可以参考[ 博客链接] ( https://coderfan.net/how-to-use-telegram-bot-to-alarm-you-when-someone-login-into-your-vps.html )
100
+ 使用说明:在面板后台设置机器人相关参数,具体包括
101
+
88
102
- Tg机器人Token
89
103
- Tg机器人ChatId
90
- - Tg机器人周期运行时间,采用crontab语法
104
+ - Tg机器人周期运行时间,采用crontab语法
105
+
106
+ 参考语法:
107
+ - 30 * * * * * //每一分的第30s进行通知
108
+ - @hourly //每小时通知
109
+ - @daily //每天通知(凌晨零点整)
110
+ - @every 8h //每8小时通知
91
111
92
- 参考示例:
93
- 每小时定时通知
94
- ![ ] ( media/2022-04-17_110907.png )
95
- 每分钟的第30s通知
96
- ![ ] ( media/2022-04-17_111321.png )
97
- 效果示意图:
98
- ![ ] ( media/2022-04-17_111705.png )
112
+ TG通知内容:
113
+ - 节点流量使用
114
+ - 面板登录提醒
115
+ - 节点到期提醒
116
+ - 流量预警提醒
99
117
118
+ 更多功能规划中...
100
119
## 建议系统
120
+
101
121
- CentOS 7+
102
122
- Ubuntu 16+
103
123
- Debian 8+
104
124
105
125
# 常见问题
106
126
107
127
## 从 v2-ui 迁移
108
- 首先在安装了 v2-ui 的服务器上安装最新版 x-ui,然后使用以下命令进行迁移,将迁移本机 v2-ui 的` 所有 inbound 账号数据 ` 至 x-ui,` 面板设置和用户名密码不会迁移 `
109
- > 迁移成功后请` 关闭 v2-ui ` 并且` 重启 x-ui ` ,否则 v2-ui 的 inbound 会与 x-ui 的 inbound 会产生` 端口冲突 `
128
+
129
+ 首先在安装了 v2-ui 的服务器上安装最新版 x-ui,然后使用以下命令进行迁移,将迁移本机 v2-ui 的 ` 所有 inbound 账号数据 ` 至 x-ui,` 面板设置和用户名密码不会迁移 `
130
+
131
+ > 迁移成功后请 ` 关闭 v2-ui ` 并且 ` 重启 x-ui ` ,否则 v2-ui 的 inbound 会与 x-ui 的 inbound 会产生 ` 端口冲突 `
132
+
110
133
```
111
134
x-ui v2-ui
112
135
```
113
136
114
137
## issue 关闭
138
+
115
139
各种小白问题看得血压很高
116
140
117
141
## Stargazers over time
0 commit comments