From 91c891ce8e998e20827281a860db1a7c43ade68e Mon Sep 17 00:00:00 2001 From: Hossin Asaadi Date: Sat, 5 Nov 2022 14:55:48 +0400 Subject: [PATCH] Update README.md --- README.md | 141 +++++++++++++++++++++++++++++------------------------- 1 file changed, 77 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 80a9e302..5f65d263 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,45 @@ # x-ui -支持多协议多用户的 xray 面板 +xray panel supporting multi-protocol multi-user -# 功能介绍 +# Features -- 系统状态监控 -- 支持多用户多协议，网页可视化操作 -- 支持的协议：vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http -- 支持配置更多传输配置 -- 流量统计，限制流量，限制到期时间 -- 可自定义 xray 配置模板 -- 支持 https 访问面板（自备域名 + ssl 证书） -- 支持一键SSL证书申请且自动续签 -- 更多高级配置项，详见面板 +- System Status Monitoring +- Support multi-user multi-protocol, web page visualization operation +- Supported protocols: vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http +- Support for configuring more transport configurations +- Traffic statistics, limit traffic, limit expiration time +- Customizable xray configuration templates +- Support https access panel (self-provided domain name + ssl certificate) +- Support one-click SSL certificate application and automatic renewal +- For more advanced configuration items, please refer to the panel -# 安装&升级 +# Enable IP Restrictions Per Inbound +1 - open panel settings and tab xray related settings put this to first of json : + ``` + { + "log": { + "loglevel": "warning", + "access": "./access.log" + }, ``` -bash <(curl -Ls https://raw.githubusercontent.com/vaxilu/x-ui/master/install.sh) +- change access log path as you want + +2 - add **IP limit and Email** for inbound(vmess & vless) + +# Install & Upgrade + +``` +bash <(curl -Ls https://raw.githubusercontent.com/hossinasaadi/x-ui/master/install.sh) ``` -## 手动安装&升级 +## Manual install & upgrade -1. 首先从 https://github.com/vaxilu/x-ui/releases 下载最新的压缩包，一般选择 `amd64`架构 -2. 然后将这个压缩包上传到服务器的 `/root/`目录下，并使用 `root`用户登录服务器 +1. First download the latest compressed package from https://github.com/hossinasaadi/x-ui/releases , generally choose Architecture `amd64` +2. Then upload the compressed package to the server's `/root/` directory and `root` rootlog in to the server with user -> 如果你的服务器 cpu 架构不是 `amd64`，自行将命令中的 `amd64`替换为其他架构 +> If your server cpu architecture is not `amd64` replace another architecture ``` cd /root/ @@ -40,17 +54,17 @@ systemctl enable x-ui systemctl restart x-ui ``` -## 使用docker安装 +## Install using docker -> 此 docker 教程与 docker 镜像由[Chasing66](https://github.com/Chasing66)提供 +> This docker tutorial and docker image are provided by [Chasing66](https://github.com/Chasing66) -1. 安装docker +1. install docker ```shell curl -fsSL https://get.docker.com | sh ``` -2. 安装x-ui +2. install x-ui ```shell mkdir x-ui && cd x-ui @@ -61,83 +75,82 @@ docker run -itd --network=host \ enwaiax/x-ui:latest ``` -> Build 自己的镜像 +> Build your own image ```shell docker build -t x-ui . ``` -## SSL证书申请 +## SSL certificate application -> 此功能与教程由[FranzKafkaYu](https://github.com/FranzKafkaYu)提供 +> This feature and tutorial are provided by [FranzKafkaYu](https://github.com/FranzKafkaYu) -脚本内置SSL证书申请功能，使用该脚本申请证书，需满足以下条件: +The script has a built-in SSL certificate application function. To use this script to apply for a certificate, the following conditions must be met: -- 知晓Cloudflare 注册邮箱 -- 知晓Cloudflare Global API Key -- 域名已通过cloudflare进行解析到当前服务器 +- Know the Cloudflare registered email +- Know the Cloudflare Global API Key +- The domain name has been resolved to the current server through cloudflare -获取Cloudflare Global API Key的方法: +How to get the Cloudflare Global API Key: ![](media/bda84fbc2ede834deaba1c173a932223.png) ![](media/d13ffd6a73f938d1037d0708e31433bf.png) -使用时只需输入 `域名`, `邮箱`, `API KEY`即可，示意图如下： +When using, just enter `email`, `domain`, `API KEY` and the schematic diagram is as follows： ![](media/2022-04-04_141259.png) -注意事项: +Precautions: -- 该脚本使用DNS API进行证书申请 -- 默认使用Let'sEncrypt作为CA方 -- 证书安装目录为/root/cert目录 -- 本脚本申请证书均为泛域名证书 +- The script uses DNS API for certificate request +- By default, Let'sEncrypt is used as the CA party +- The certificate installation directory is the /root/cert directory +- The certificates applied for by this script are all generic domain name certificates -## Tg机器人使用（开发中，暂不可使用） +## Tg robot use (under development, temporarily unavailable) -> 此功能与教程由[FranzKafkaYu](https://github.com/FranzKafkaYu)提供 +> This feature and tutorial are provided by [FranzKafkaYu](https://github.com/FranzKafkaYu) -X-UI支持通过Tg机器人实现每日流量通知，面板登录提醒等功能，使用Tg机器人，需要自行申请 -具体申请教程可以参考[博客链接](https://coderfan.net/how-to-use-telegram-bot-to-alarm-you-when-someone-login-into-your-vps.html) -使用说明:在面板后台设置机器人相关参数，具体包括 +X-UI supports daily traffic notification, panel login reminder and other functions through the Tg robot. To use the Tg robot, you need to apply for the specific application tutorial. You can refer to the [blog](https://coderfan.net/how-to-use-telegram-bot-to-alarm-you-when-someone-login-into-your-vps.html) +Set the robot-related parameters in the panel background, including: -- Tg机器人Token -- Tg机器人ChatId -- Tg机器人周期运行时间，采用crontab语法 +- Tg Robot Token +- Tg Robot ChatId +- Tg robot cycle runtime, in crontab syntax -参考语法： -- 30 * * * * * //每一分的第30s进行通知 -- @hourly //每小时通知 -- @daily //每天通知（凌晨零点整） -- @every 8h //每8小时通知 -TG通知内容： -- 节点流量使用 -- 面板登录提醒 -- 节点到期提醒 -- 流量预警提醒 +Reference syntax: -更多功能规划中... -## 建议系统 +- 30 * * * * * //Notify at the 30s of each point +- @hourly // hourly notification +- @daily // Daily notification (00:00 in the morning) +- @every 8h // notify every 8 hours +- TG notification content: + +- Node traffic usage +- Panel login reminder +- Node expiration reminder +- Traffic warning reminder + +More features are planned... + + +## suggestion system - CentOS 7+ - Ubuntu 16+ - Debian 8+ -# 常见问题 +# common problem -## 从 v2-ui 迁移 +## Migrating from v2-ui -首先在安装了 v2-ui 的服务器上安装最新版 x-ui，然后使用以下命令进行迁移，将迁移本机 v2-ui 的 `所有 inbound 账号数据`至 x-ui，`面板设置和用户名密码不会迁移` +First install the latest version of x-ui on the server where v2-ui is installed, and then use the following command to migrate, which will migrate the native v2-ui `All inbound account data` to x-ui，`Panel settings and username passwords are not migrated` -> 迁移成功后请 `关闭 v2-ui`并且 `重启 x-ui`，否则 v2-ui 的 inbound 会与 x-ui 的 inbound 会产生 `端口冲突` +> Please `Close v2-ui` and `restart x-ui`, otherwise the inbound of v2-ui will cause a `port conflict with the inbound of x-ui` ``` x-ui v2-ui ``` -## issue 关闭 - -各种小白问题看得血压很高 - ## Stargazers over time -[![Stargazers over time](https://starchart.cc/vaxilu/x-ui.svg)](https://starchart.cc/vaxilu/x-ui) +[![Stargazers over time](https://starchart.cc/hossinasaadi/x-ui.svg)](https://starchart.cc/hossinasaadi/x-ui)