Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tg #172

Open
wants to merge 86 commits into
base: main
Choose a base branch
from
Open

tg #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
edbb8b3
update
FranzKafkaYu Jul 1, 2022
07add3c
Update README.md
FranzKafkaYu Jul 1, 2022
f781025
Update README_EN.md
FranzKafkaYu Jul 1, 2022
88166ce
Update shell script
FranzKafkaYu Jul 2, 2022
c331375
Upload shell scripts
FranzKafkaYu Jul 2, 2022
82cc83e
Update README.md
FranzKafkaYu Jul 3, 2022
f61b7a8
Update README.md
FranzKafkaYu Jul 6, 2022
678ac92
Update README.md
FranzKafkaYu Jul 6, 2022
ad832bd
Update README.md
FranzKafkaYu Jul 12, 2022
dd6b490
Update README.md
FranzKafkaYu Jul 20, 2022
05a206b
Update README.md
FranzKafkaYu Jul 20, 2022
cce9a34
Update README.md
FranzKafkaYu Jul 21, 2022
11d49be
Update README.md
FranzKafkaYu Jul 24, 2022
6d67708
Update README.md
FranzKafkaYu Jul 24, 2022
bb22179
Update README.md
FranzKafkaYu Jul 24, 2022
e15ca7f
Update README.md
FranzKafkaYu Jul 26, 2022
e63c3d4
Update x-ui.sh for standalone mode cert issue
FranzKafkaYu Jul 28, 2022
99cfb5d
fix log print
FranzKafkaYu Jul 28, 2022
af98a18
Optimize info
FranzKafkaYu Jul 28, 2022
970646a
Update README.md
FranzKafkaYu Aug 1, 2022
54ad70f
Update x-ui.sh
FranzKafkaYu Aug 1, 2022
c9a7c26
Update README.md
FranzKafkaYu Aug 10, 2022
b502595
Update README.md
FranzKafkaYu Aug 12, 2022
dc18439
Update README_EN.md
FranzKafkaYu Aug 12, 2022
e505d97
优化证书申请提示文案
FranzKafkaYu Sep 5, 2022
a3bb1ac
Update x-ui.sh
FranzKafkaYu Oct 10, 2022
42f934f
修复证书签发失败导致后续申请时域名合法性校验失败问题
FranzKafkaYu Oct 10, 2022
b4ccca1
Create bug_report.yml
FranzKafkaYu Oct 19, 2022
13ce290
Delete ------.md
FranzKafkaYu Oct 19, 2022
e22efd6
Update bug_report.yml
FranzKafkaYu Oct 19, 2022
a2515c2
Update bug_report.yml
FranzKafkaYu Oct 19, 2022
42a2549
Support for English
FranzKafkaYu Oct 23, 2022
9e73c8b
Update README.md
FranzKafkaYu Oct 23, 2022
a964138
Update README.md
FranzKafkaYu Oct 23, 2022
d0b98f4
update README
FranzKafkaYu Oct 24, 2022
53efeb7
Update bug_report.yml
FranzKafkaYu Oct 25, 2022
6bb012e
Update README.md
FranzKafkaYu Oct 25, 2022
a208b63
check if acme.sh already installed
tacrazymage Oct 25, 2022
8d1009a
check if acme already installed
tacrazymage Oct 25, 2022
67d34bd
Update
FranzKafkaYu Oct 25, 2022
7dfce14
Update x-ui.sh
FranzKafkaYu Nov 2, 2022
2ca93eb
Merge pull request #125 from tacrazymage/patch-1
FranzKafkaYu Nov 2, 2022
8be5f2d
format scripts
FranzKafkaYu Nov 2, 2022
cf841ea
Update README.md
FranzKafkaYu Nov 9, 2022
b6e1a10
fix install shell for English version
FranzKafkaYu Nov 12, 2022
1b088fb
Update README
FranzKafkaYu Nov 15, 2022
fabc6ce
add cron job setting for updating geo data and xray log clear
FranzKafkaYu Nov 22, 2022
39ee5e0
fix for geosite url
FranzKafkaYu Nov 22, 2022
5665073
update shell script
FranzKafkaYu Dec 4, 2022
aabe4e9
fix typo
FranzKafkaYu Dec 5, 2022
9ee2582
Update README.md
FranzKafkaYu Dec 7, 2022
25b6bd5
Update README.md
FranzKafkaYu Dec 8, 2022
6483514
Update README.md
FranzKafkaYu Dec 12, 2022
b7f3a1d
Update README.md
FranzKafkaYu Feb 9, 2023
dc7eb47
初次安装时增加随机用户名与密码、端口的设定
FranzKafkaYu Feb 14, 2023
c6fd02a
Update README.md
FranzKafkaYu Apr 9, 2023
1e2cde2
Update README.md
FranzKafkaYu Apr 9, 2023
e3977d7
Update README.md
FranzKafkaYu Apr 9, 2023
4b444b3
Update README.md
FranzKafkaYu Apr 9, 2023
a2c68ae
Update README.md
FranzKafkaYu Apr 10, 2023
d817bbb
Update install.sh
PIDAN-HEIDASHUAI Apr 10, 2023
9971053
Merge pull request #333 from PIDAN-HEIDASHUAI/patch-1
FranzKafkaYu Apr 10, 2023
3ee3380
Update README.md
FranzKafkaYu Apr 17, 2023
4b3e19f
Update README.md
FranzKafkaYu May 5, 2023
08a73f7
Update README.md
FranzKafkaYu May 5, 2023
078efe1
Update README_EN.md
FranzKafkaYu May 5, 2023
7520286
optimize for log auto clear in Chinese Version
FranzKafkaYu May 6, 2023
204edd3
Fix multi certs issue
FranzKafkaYu Jun 9, 2023
4930655
Update README.md
FranzKafkaYu Jun 11, 2023
0c13410
Update README_EN.md
FranzKafkaYu Jun 11, 2023
a00f9d0
Update README.md
FranzKafkaYu Jun 12, 2023
908de64
Update README_EN.md
FranzKafkaYu Jun 12, 2023
c3c010c
Update README.md
FranzKafkaYu Jul 18, 2023
51d9ff6
Update README_EN.md
FranzKafkaYu Jul 18, 2023
7f0eb6b
update geo & clear xray logs and cron jobs support for En Version
FranzKafkaYu Jul 18, 2023
956bf85
Update install.sh for curl related
FranzKafkaYu Jul 19, 2023
8fe0dd1
Update README.md
FranzKafkaYu Jul 20, 2023
6f885aa
Update README.md
FranzKafkaYu Aug 8, 2023
461a840
Update README.md
FranzKafkaYu Sep 20, 2023
3512ac8
Update README.md
FranzKafkaYu Sep 21, 2023
8a8faae
Update README.md
FranzKafkaYu Sep 26, 2023
25a0a42
Update README.md
FranzKafkaYu Oct 26, 2023
00b9e5e
Update README.md
FranzKafkaYu Oct 26, 2023
a549504
Update README.md
FranzKafkaYu Oct 26, 2023
2c50105
Update README.md
FranzKafkaYu Dec 5, 2023
9fc75e8
Update README.md
FranzKafkaYu Mar 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/------.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Issue Report
description: "Create a report to help us improve."
body:
- type: checkboxes
id: terms
attributes:
label: Welcome
options:
- label: Yes, I'm using the latest major release. Only such installations are supported.
required: true
- label: Yes, I'm using the supported system. Only such systems are supported.
required: true
- label: Yes, I have read all WIKI document,nothing can help me in my problem.
required: true
- label: Yes, I've searched similar issues on GitHub and didn't find any.
required: true
- label: Yes, I've included all information below (version, config, log, etc).
required: true

- type: textarea
id: problem
attributes:
label: Description of the problem,screencshot would be good
placeholder: Your problem description
validations:
required: true

- type: textarea
id: version
attributes:
label: Version of x-ui
value: |-
<details>

```console
$ x-ui version
# Paste output here
```

</details>
validations:
required: true

- type: textarea
id: log
attributes:
label: x-ui log or xray log
value: |-
<details>

```console
# paste log here
```

</details>
validations:
required: true
298 changes: 219 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,219 @@
# x-ui
支持多协议多用户的 xray 面板

# 功能介绍
- 系统状态监控
- 支持多用户多协议,网页可视化操作
- 支持的协议:vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http
- 支持配置更多传输配置
- 流量统计,限制流量,限制到期时间
- 可自定义 xray 配置模板
- 支持 https 访问面板(自备域名 + ssl 证书)
- 更多高级配置项,详见面板

# 安装&升级
```
bash <(curl -Ls https://raw.githubusercontent.com/vaxilu/x-ui/master/install.sh)
```

## 手动安装&升级
1. 首先从 https://github.com/vaxilu/x-ui/releases 下载最新的压缩包,一般选择`amd64`架构
2. 然后将这个压缩包上传到服务器的`/root/`目录下,并使用`root`用户登录服务器

> 如果你的服务器 cpu 架构不是`amd64`,自行将命令中的`amd64`替换为其他架构

```
cd /root/
rm x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -rf
tar zxvf x-ui-linux-amd64.tar.gz
chmod +x x-ui/x-ui x-ui/bin/xray-linux-* x-ui/x-ui.sh
cp x-ui/x-ui.sh /usr/bin/x-ui
cp -f x-ui/x-ui.service /etc/systemd/system/
mv x-ui/ /usr/local/
systemctl daemon-reload
systemctl enable x-ui
systemctl restart x-ui
```

## 使用docker安装

> 此 docker 教程与 docker 镜像由[Chasing66](https://github.com/Chasing66)提供

1. 安装docker
```shell
curl -fsSL https://get.docker.com | sh
```
2. 安装x-ui
```shell
mkdir x-ui && cd x-ui
docker run -itd --network=host \
-v $PWD/db/:/etc/x-ui/ \
-v $PWD/cert/:/root/cert/ \
--name x-ui --restart=unless-stopped \
enwaiax/x-ui:latest
```
>Build 自己的镜像
```shell
docker build -t x-ui .
```

## 建议系统
- CentOS 7+
- Ubuntu 16+
- Debian 8+

# 常见问题

## 从 v2-ui 迁移
首先在安装了 v2-ui 的服务器上安装最新版 x-ui,然后使用以下命令进行迁移,将迁移本机 v2-ui 的`所有 inbound 账号数据`至 x-ui,`面板设置和用户名密码不会迁移`
> 迁移成功后请`关闭 v2-ui`并且`重启 x-ui`,否则 v2-ui 的 inbound 会与 x-ui 的 inbound 会产生`端口冲突`
```
x-ui v2-ui
```

## issue 关闭
各种小白问题看得血压很高

## Stargazers over time

[![Stargazers over time](https://starchart.cc/vaxilu/x-ui.svg)](https://starchart.cc/vaxilu/x-ui)
# X-UI
简体中文|[ENGLISH](./README_EN.md)

> 声明:该项目仅供个人学习、交流,请遵守当地法律法规,勿用于非法用途;请勿用于生产环境
> 声明:该项目已闭源,介意者请勿使用;如您需要开源代码,请附上您的Github Profile邮箱联系

支持单端口多用户、多协议的 xray 面板,究极缝合怪
通过免费的Telegram bot方便快捷地进行监控、管理你的代理服务
&#x26A1;`xtls-rprx-vision`与`reality`快速入手请看[这里](https://github.com/FranzKafkaYu/x-ui/wiki/%E8%8A%82%E7%82%B9%E9%85%8D%E7%BD%AE)
欢迎大家使用并反馈意见或提交Pr,帮助项目更好的改善
如果您觉得本项目对您有所帮助,不妨给个star:star2:支持我
或者你恰巧有购买服务器的需求,可以通过文末的赞助部分支持我~

# 文档目录
- [功能介绍](#功能介绍)
- [一键安装](#一键安装)
- [效果预览](#效果预览)
- [快捷方式](#快捷方式)
- [变更记录](#变更记录)

# 功能介绍

- 系统状态监控
- 支持单端口多用户、多协议,网页可视化操作
- 支持的协议:vmess、vless、trojan、shadowsocks、shadowsocks 2022、dokodemo-door、socks、http
- 支持配置更多传输配置:http、tcp、ws、grpc、kcp、quic
- 流量统计,限制流量,限制到期时间,一键重置与设备监控
- 可自定义 xray 配置模板
- 支持 https 访问面板(自备域名 + ssl 证书)
- 支持一键SSL证书申请且自动续签
- Telegram bot通知、控制功能
- 更多高级配置项,详见面板

:bulb:具体**使用、配置细节以及问题排查**请点击这里:point_right:[WIKI](https://github.com/FranzKafkaYu/x-ui/wiki):point_left:
Specific **Usages、Configurations and Debug** please refer to [WIKI](https://github.com/FranzKafkaYu/x-ui/wiki)
# 一键安装
在安装前请确保你的系统支持`bash`环境,且系统网络正常

&#x26A1;从原版升级也可使用该命令,数据不会丢失&#x26A1;

```
bash <(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install.sh)
```
For English Users,please use the following command to install English supported version:
```
bash <(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install_en.sh)
```
如需安装指定的版本,可以在上述命令中指定版本号,如指定版本为`0.3.4.4`,安装命令如下:
```
bash <(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install.sh) 0.3.4.4
```

# 效果预览
`面板使用`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/180629631-f76a05c8-ecf0-4685-bbc7-a7058747d213.png)
![image](https://user-images.githubusercontent.com/38254177/180629662-b7a325fc-1ebb-47c9-992c-1e7c758a326b.png)


</details>

`Bot使用`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/178551055-893936b7-b75f-4ee8-a773-eee7c6f43f51.png)

</details>

`流量提醒`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/180039760-dc987a30-e21c-49a3-8e03-19666566a822.png)

</details>

`SSH提醒`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/180040129-2ec1a7c0-abd3-41dc-aab0-8cd22415c943.png)

</details>

`限额提醒`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/180040521-af6e9ef8-d7e5-44e8-834e-25b3b8e3e1b5.png)

</details>

`到期提醒`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/180041690-90ca4b1f-3a2d-470b-bc0c-eca9261a739a.png)

</details>

`登录提醒`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/180040913-b8bf2fe1-6fc1-43ab-a683-ae23db1866b2.png)
![image](https://user-images.githubusercontent.com/38254177/180041179-a5f4cd52-a1ba-4aa9-abb2-b94e36722385.png)

</details>

`用户速览`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/230761101-20431dd7-5bce-489e-9139-0ceb9ab9a2dc.png)

</details>

`用户查询`:
<details>
<summary><b>点击查看效果预览</b></summary>

![image](https://user-images.githubusercontent.com/38254177/230761252-c283c02d-82a4-46ce-a180-dfab4048180d.png)

</details>



# 快捷方式
安装成功后,通过键入`x-ui`进入控制选项菜单,目前菜单内容:
```
x-ui 面板管理脚本
0. 退出脚本
————————————————
1. 安装 x-ui
2. 更新 x-ui
3. 卸载 x-ui
————————————————
4. 重置用户名密码
5. 重置面板设置
6. 设置面板端口
7. 查看当前面板设置
————————————————
8. 启动 x-ui
9. 停止 x-ui
10. 重启 x-ui
11. 查看 x-ui 状态
12. 查看 x-ui 日志
————————————————
13. 设置 x-ui 开机自启
14. 取消 x-ui 开机自启
————————————————
15. 一键安装 bbr (最新内核)
16. 一键申请SSL证书(acme申请)

面板状态: 已运行
是否开机自启: 是
xray 状态: 运行

请输入选择 [0-16]:
```
# 配置要求
## 内存
- 128MB minimal/256MB+ recommend
## OS
- CentOS 7+
- Ubuntu 16+
- Debian 8+

# 变更记录
- 2023.07.18:随机生成Reality dest与serverNames,去除微软域名;细化sniffing配置
- 2023.06.10:开启TLS时自动复用面板证书与域名;增加证书热重载设定;优化设备限制功能
- 2023.04.09:支持Reality;支持新的telegram bot控制指令
- 2023.03.05:支持用户到期时间限制;随机用户名、密码与端口生成
- 2023.02.09:支持单端口内用户流量限制与统计;支持VLESS utls配置与分享链接导出
- 2022.12.07:添加设备并发限制;细化tls配置,支持minVersion、maxVersion与cipherSuites选择
- 2022.11.14:添加xtls-rprx-vision流控选项;定时自动更新geo与清除日志
- 2022.10.23:实现全英文支持;增加批量导出分享链接功能;优化页面细节与Telegram通知
- 2022.08.11:实现Vmess/Vless/Trojan单端口多用户;增加CPU使用超限提醒
- 2022.07.28:增加acme standalone模式申请证书;增加x-ui自动保活机制;优化编译选项以适配更多系统
- 2022.07.24:增加自动生成面板根路径,节点流量自动重置功能,设备IP接入变化通知功能
- 2022.07.21:增加节点IP接入变化提醒,Web面板增加停止/重启xray功能,优化部分翻译
- 2022.07.11:增加节点到期提醒、流量预警策略,增加Telegram bot节点复制、获取分享链接等
- 2022.07.03:重构Telegram bot功能,指令控制不再需要键盘输入;增加Trojan底层传输配置
- 2022.06.19:增加Shadowsocs2022新的Cipher,增加节点搜索、一键清除流量功能
- 2022.05.14:增加Telegram bot Command控制功能,支持关闭/开启/删除节点等
- 2022.04.25:增加SSH登录提醒、面板登录提醒
- 2022.04.23:增加更多Telegram bot提醒功能
- 2022.04.16:增加面板设置Telegram bot功能
- 2022.04.12:优化Telegram Bot通知提醒
- 2022.04.06:优化安装/更新流程,增加证书签发功能,添加Telegram bot机器人推送功能
# Telegram

[订阅频道](https://t.me/CoderfanBaby)
[讨论群组](https://t.me/franzkafayu)

# 致谢

- [vaxilu/x-ui](https://github.com/vaxilu/x-ui)
- [XTLS/Xray-core](https://github.com/XTLS/Xray-core)
- [telegram-bot-api](https://github.com/go-telegram-bot-api/telegram-bot-api)

# 广告赞助

如果你觉得本项目对你有用,而且你也恰巧有这方面的需求,你也可以选择通过我的购买链接赞助我
- [搬瓦工GIA高端线路](https://bandwagonhost.com/aff.php?aff=65703),仅推荐购买GIA套餐
- [Cloudcone性价比主机提供商](https://app.cloudcone.com/?ref=7536)
- [Spartan三网4837性价比主机](https://billing.spartanhost.net/aff.php?aff=1875)


如果你希望购买一些现成的代理服务,可选择下述代理服务
- [搬瓦工关联机场](https://justmysocks.net/members/aff.php?aff=18177)
- [高端奶昔机场](https://nxboom.com/signupbyemail.aspx?MemberCode=2fd79885e45549049c66698f1eea154620230921234746)

## Stargazers over time

[![Stargazers over time](https://starchart.cc/FranzKafkaYu/x-ui.svg)](https://starchart.cc/FranzKafkaYu/x-ui)
Loading