diff --git a/README.md b/README.md index b09b0df..cf612de 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 3x-ui-pro +🇬🇧 [English version](README_EN.md) + Автоматическая установка панели [3x-ui](https://github.com/MHSanaei/3x-ui) с nginx, SSL, Clash-подпиской и диагностикой сети. - Debian 12 / Ubuntu 24 @@ -34,11 +36,9 @@ wget -qO x-ui-latest.sh https://raw.githubusercontent.com/mozaroc/3x-ui-pro/main **Шаг 2 — запустить** ```bash -bash x-ui-latest.sh -install y -subdomain panel.example.com -reality_domain r.example.com +bash x-ui-latest.sh -install y ``` -Замените `panel.example.com` на домен панели, `r.example.com` — на домен для REALITY. - --- ## Патч diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..f8a37e8 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,120 @@ +# 3x-ui-pro + +🇷🇺 [Русская версия](README.md) + +Automated installer for the [3x-ui](https://github.com/MHSanaei/3x-ui) panel with nginx, SSL, Clash subscription and network diagnostics. + +- Debian 12 / Ubuntu 24 +- Two domains or subdomains (one for the panel, one for REALITY) +- Automatic SSL certificate renewal +- VLESS+REALITY, VLESS+WebSocket, VLESS+XHTTP, Trojan+gRPC — all through port 443 + +--- + +## What gets installed + +| Component | Description | +|-----------|-------------| +| 3x-ui | VPN panel with web UI | +| nginx | Reverse proxy, SNI routing | +| certbot | Let's Encrypt SSL | +| Clash subscription | Serves `clash.yaml` based on User-Agent | +| Diagnostics | MTR tracer + in-browser speed test | +| Fake site | Random HTML cover site | +| Backup | Backup / restore script | + +--- + +## Installation + +**Step 1 — download the script** + +```bash +wget -qO x-ui-latest.sh https://raw.githubusercontent.com/mozaroc/3x-ui-pro/main/x-ui-latest.sh +``` + +**Step 2 — run it** + +```bash +bash x-ui-latest.sh -install y +``` + +--- +## Patch + +Apply current fixes to an existing installation (no DB changes): + +```bash +bash <(curl -fsSL https://raw.githubusercontent.com/mozaroc/3x-ui-pro/main/x-ui-patch.sh) +``` + +--- + +## Uninstall + +```bash +bash x-ui-latest.sh -uninstall y +``` + +--- + +## Command-line options + +| Option | Description | +|--------|-------------| +| `-install y` | Install | +| `-subdomain ` | Panel and subscription domain | +| `-reality_domain ` | REALITY destination domain | +| `-auto_domain y` | Auto-detect domain (no manual input) | +| `-uninstall y` | Full uninstall | + +--- + +## Clash subscription + +Works via User-Agent detection — one URL, different behavior: + +- **Clash / Mihomo / Stash** → get a ready-to-use `clash.yaml` config +- **Regular browser / other clients** → get the standard 3x-ui subscription page + +The import link is printed by the script after installation. + +--- + +## Backup and restore + +**Install the backup script** + +```bash +wget -qO /usr/local/bin/x-ui-backup https://raw.githubusercontent.com/mozaroc/3x-ui-pro/main/assets/backup/x-ui-backup.sh +chmod +x /usr/local/bin/x-ui-backup +``` + +**Create a backup** + +```bash +x-ui-backup backup +``` + +**List backups** + +```bash +x-ui-backup list +``` + +**Restore from a backup** (on a clean server; packages are installed automatically) + +```bash +x-ui-backup restore /var/backups/x-ui/x-ui-backup-20260101-120000.tar.gz +``` + +The backup includes: nginx configs, panel DB, 3x-ui binary, SSL certificates, web content, systemd units, cron, UFW rules. + +--- + +## Network diagnostics + +Available after installation at the link printed by the script. Includes: + +- MTR trace to your IP +- Download and upload speed test (512 MB test files)