diff --git a/README.md b/README.md index 62aa18c3..33e18dfb 100644 --- a/README.md +++ b/README.md @@ -415,13 +415,13 @@ The web panel supports daily traffic, panel login, database backup, system statu - Threshold for Expiration time and Traffic to report in advance - Support client report menu if client's telegram username added to the user's configurations - Support telegram traffic report searched with UUID (VMESS/VLESS) or Password (TROJAN) - anonymously -- Menu based bot -- Search client by email ( only admin ) +- Menu-based bot +- Search client by email (only admin) - Check all inbounds - Check server status - Check depleted users - Receive backup by request and in periodic reports -- Multi language bot +- Multi-language bot ### Setting up Telegram bot diff --git a/README.ru_RU.md b/README.ru_RU.md index de689930..4e890a18 100644 --- a/README.ru_RU.md +++ b/README.ru_RU.md @@ -12,7 +12,7 @@ > **Отказ от ответственности:** Этот проект предназначен только для личного обучения и общения. Пожалуйста, не используйте его в незаконных целях и не применяйте в производственной среде. -**Если этот проект оказался полезным для вас, вы можете оценить его:** :star2: +**Если этот проект оказался полезным для вас, вы можете оценить его, постативив звёздочку** :star2:

@@ -30,9 +30,9 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) ``` -## Установка пользовательской версии +## Установка определённой версии -Чтобы установить нужную вам версию, добавьте номер версии в конец команды установки, например, версия `v2.3.13`: +Чтобы установить нужную вам версию, добавьте номер версии в конец команды установки. Например, `v2.3.13`: ``` bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v2.3.13 @@ -41,19 +41,19 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install. ## SSL Сертификат

- Нажмите для получения информации о SSL сертификате + Нажмите для получения информации об SSL сертификате ### ACME Для управления SSL сертификатами с помощью ACME: 1. Убедитесь, что ваш домен правильно настроен и указывает на сервер. -2. Выполните команду `x-ui` в терминале, затем выберите «Управление SSL сертификатами». +2. Выполните команду `x-ui` в терминале, затем выберите `SSL Certificate Management`. 3. Вам будут предложены следующие опции: - - **Получить SSL:** Получить SSL сертификаты. - - **Отозвать:** Отозвать существующие SSL сертификаты. - - **Принудительное обновление:** Принудительно обновить SSL сертификаты. + - **Get SSL:** Получить SSL сертификаты. + - **Revoke:** Отозвать существующие SSL сертификаты. + - **Force Renew:** Принудительно превыпустить SSL сертификаты. ### Certbot @@ -61,7 +61,7 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install. ```sh apt-get install certbot -y -certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com +certbot certonly --standalone --agree-tos --register-unsafely-without-email -d вашдомен.com certbot renew --dry-run ``` @@ -69,20 +69,20 @@ certbot renew --dry-run Скрипт управления включает встроенное приложение для получения SSL сертификата через Cloudflare. Чтобы использовать этот скрипт для запроса сертификата, вам потребуется следующее: -- Электронная почта, зарегистрированная в Cloudflare +- Email, зарегистрированный в Cloudflare - Глобальный API-ключ Cloudflare -- Доменное имя должно быть разрешено на текущий сервер через Cloudflare +- Доменное имя должно указывать на текущий сервер через Cloudflare **Как получить глобальный API-ключ Cloudflare:** -1. Выполните команду `x-ui` в терминале, затем выберите «Cloudflare SSL Certificate». +1. Выполните команду `x-ui` в терминале, затем выберите `Cloudflare SSL Certificate`. 2. Посетите ссылку: [Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens). 3. Нажмите на "View Global API Key" (см. скриншот ниже): ![](media/APIKey1.PNG) -4. Возможно, вам потребуется повторно пройти аутентификацию. После этого ключ API будет отображен (см. скриншот ниже): +4. Возможно, вам потребуется повторно пройти аутентификацию. После этого ключ API будет отображён (см. скриншот ниже): ![](media/APIKey2.png) -При использовании просто введите ваше `доменное имя`, `электронную почту` и `API KEY`. Схема приведена ниже: +При использовании просто введите ваше `доменное имя`, `email` и `API-ключ`. Схема приведена ниже: ![](media/DetailEnter.png)
@@ -94,7 +94,7 @@ certbot renew --dry-run #### Использование -1. Чтобы скачать последнюю версию сжатого пакета напрямую на ваш сервер, выполните следующую команду: +1. Чтобы скачать последнюю версию архива напрямую на ваш сервер, выполните следующую команду: ```sh ARCH=$(uname -m) @@ -113,7 +113,7 @@ esac wget https://github.com/MHSanaei/3x-ui/releases/latest/download/x-ui-linux-${XUI_ARCH}.tar.gz ``` -2. После загрузки сжатого пакета выполните следующие команды для установки или обновления x-ui: +2. После загрузки архива выполните следующие команды для установки или обновления x-ui: ```sh ARCH=$(uname -m) @@ -155,7 +155,7 @@ systemctl restart x-ui bash <(curl -sSL https://get.docker.com) ``` -2. **Клонируйте репозиторий проекта:** +2. **Склонируйте репозиторий проекта:** ```sh git clone https://github.com/MHSanaei/3x-ui.git @@ -168,7 +168,7 @@ systemctl restart x-ui docker compose up -d ``` - **OR** + **ИЛИ** ```sh docker run -itd \ @@ -181,7 +181,7 @@ systemctl restart x-ui ghcr.io/mhsanaei/3x-ui:latest ``` -4. **Обновите до последней версии:** +4. **Обновление до последней версии:** ```sh cd 3x-ui @@ -190,7 +190,7 @@ systemctl restart x-ui docker compose up -d ``` -5. **Удалите 3x-ui из Docker:** +5. **Удаление 3x-ui из Docker:** ```sh docker stop 3x-ui @@ -202,7 +202,7 @@ systemctl restart x-ui -## Рекомендуемая ОС +## Рекомендуемые ОС - Ubuntu 20.04+ - Debian 11+ @@ -232,9 +232,9 @@ systemctl restart x-ui - **armv7 / arm / arm32**: Служит архитектурой для старых мобильных и встроенных устройств, оставаясь широко используемой в таких устройствах, как Orange Pi Zero LTS, Orange Pi PC Plus, Raspberry Pi 2 и других. -- **armv6 / arm / arm32**: Ориентирована на очень старые встроенные устройства, эта архитектура, хотя и менее распространенная, все еще используется. Например, такие устройства, как Raspberry Pi 1, Raspberry Pi Zero/Zero W, полагаются на эту архитектуру. +- **armv6 / arm / arm32**: Ориентирована на очень старые встроенные устройства, эта архитектура, хотя и менее распространенная, всё ещё используется. Например, такие устройства, как Raspberry Pi 1, Raspberry Pi Zero/Zero W, полагаются на эту архитектуру. -- **armv5 / arm / arm32**: Более старая архитектура, ассоциируемая с ранними встроенными системами, сегодня менее распространена, но все еще может быть найдена в устаревших устройствах, таких как ранние версии Raspberry Pi и некоторые старые смартфоны. +- **armv5 / arm / arm32**: Более старая архитектура, ассоциируемая с ранними встроенными системами, сегодня менее распространена, но всё ещё может быть найдена в устаревших устройствах, таких как ранние версии Raspberry Pi и некоторые старые смартфоны. - **s390x**: Эта архитектура обычно используется в мейнфреймах IBM и обеспечивает высокую производительность и надежность для корпоративных рабочих нагрузок. @@ -251,20 +251,20 @@ systemctl restart x-ui - Украинский - Турецкий -## Функции +## Возможности - Мониторинг состояния системы - Поиск по всем входящим подключениям и клиентам -- Темная/светлая тема +- Тёмная/светлая тема - Поддержка нескольких пользователей и протоколов - Поддержка протоколов, включая VMESS, VLESS, Trojan, Shadowsocks, Dokodemo-door, Socks, HTTP, WireGuard - Поддержка протоколов XTLS, включая RPRX-Direct, Vision, REALITY - Статистика трафика, ограничение трафика, ограничение по времени истечения - Настраиваемые шаблоны конфигурации Xray -- Поддержка панели доступа через HTTPS (самостоятельно предоставленное доменное имя + SSL сертификат) -- Поддержка установки SSL-сертификата в один клик и автоматического обновления -- Для получения более продвинутых настроек обратитесь к панели -- Исправлены маршруты API (настройка пользователя будет создана с API) +- Поддержка HTTPS доступа к панели (ваше доменное имя + SSL сертификат) +- Поддержка установки SSL-сертификата в один клик и автоматического перевыпуска +- Для получения более продвинутых настроек обращайтесь к панели +- Исправляет маршруты API (настройка пользователя будет создана через API) - Поддержка изменения конфигураций по различным элементам, предоставленным в панели - Поддержка экспорта/импорта базы данных из панели @@ -286,12 +286,12 @@ systemctl restart x-ui - **Путь к базе данных:** - `/etc/x-ui/x-ui.db` -### Веб-базовый путь +### Webbasepath -1. **Сбросить веб-базовый путь:** +1. **Сбросить webbasepath:** - Откройте терминал. - Выполните команду `x-ui`. - - Выберите опцию `Сбросить веб-базовый путь`. + - Выберите опцию `Reset Web Base Path`. 2. **Генерация или настройка пути:** - Путь будет случайным образом сгенерирован, или вы можете ввести пользовательский путь. @@ -303,8 +303,8 @@ systemctl restart x-ui - Для повышения безопасности используйте длинное случайное слово в структуре вашего URL. **Примеры:** -- `http://ip:port/*webbasepath*/panel` -- `http://domain:port/*webbasepath*/panel` +- `http://ip_адрес:порт/*webbasepath*/panel` +- `http://домен:порт/*webbasepath*/panel` @@ -321,12 +321,12 @@ WARP встроен, и дополнительная установка не т **Для версий до `v2.1.0`:** -1. Выполните команду `x-ui` в терминале, затем выберите «Управление WARP». +1. Выполните команду `x-ui` в терминале, затем выберите `WARP Management`. 2. Вам будут предложены следующие опции: - - **Тип учетной записи (free, plus, team):** Выберите соответствующий тип учетной записи. - - **Включить/Выключить WireProxy:** Включите или отключите WireProxy. - - **Удалить WARP:** Удалите приложение WARP. + - **Account Type (free, plus, team):** Выбрать соответствующий тип учетной записи. + - **Enable/Disable WireProxy:** Включить или отключить WireProxy. + - **Uninstall WARP:** Удалить приложение WARP. 3. Настройте параметры по мере необходимости в панели. @@ -348,15 +348,15 @@ WARP встроен, и дополнительная установка не т Чтобы включить функциональность ограничения IP, вам нужно установить `fail2ban` и его необходимые файлы, выполнив следующие шаги: -1. Выполните команду `x-ui` в терминале, затем выберите «Управление ограничением IP». +1. Выполните команду `x-ui` в терминале, затем выберите `IP Limit Management`. 2. Вам будут предложены следующие опции: - - **Изменить длительность блокировки:** Отрегулируйте длительность блокировок. - - **Разблокировать всех:** Снять все текущие блокировки. - - **Проверить логи:** Просмотреть логи. - - **Статус Fail2ban:** Проверьте статус `fail2ban`. - - **Перезапустить Fail2ban:** Перезапустите службу `fail2ban`. - - **Удалить Fail2ban:** Удалите Fail2ban с конфигурацией. + - **Change Ban Duration:** Отрегулировать длительность блокировок. + - **Unban Everyone:** Снять все текущие блокировки. + - **Check Logs:** Просмотреть логи. + - **Fail2ban Status:** Проверить статус `fail2ban`. + - **Restart Fail2ban:** Перезапустить службу `fail2ban`. + - **Uninstall Fail2ban:** Удалить Fail2ban с его конфигурацией. 3. Добавьте путь к логам доступа в панели, установив `Xray Configs/log/Access log` в `./access.log`, затем сохраните и перезапустите xray. @@ -379,11 +379,11 @@ WARP встроен, и дополнительная установка не т ## Телеграм-бот
- Нажмите для получения информации о Телеграм-боте + Нажмите для получения информации о телеграм-боте #### Использование -Веб-панель поддерживает уведомления и функции, такие как ежедневный трафик, вход в панель, резервное копирование базы данных, состояние системы, информация о клиентах и другие, через Телеграм-бота. Чтобы использовать бота, вам нужно настроить параметры, связанные с ботом, в панели, включая: +Веб-панель поддерживает уведомления и функции, такие как ежедневный трафик, вход в панель, резервное копирование базы данных, состояние системы, информация о клиентах и другие, через телеграм-бота. Чтобы использовать бота, вам нужно настроить параметры, связанные с ботом, в панели, включая: - Токен Telegram - ID чата админа(-ов) @@ -391,85 +391,85 @@ WARP встроен, и дополнительная установка не т - Уведомления о дате истечения - Уведомления о лимите трафика - Резервное копирование базы данных -- Уведомления о загрузке ЦП +- Уведомления о загрузке CPU -**Синтаксис примеров:** +**Примеры синтаксиса:** -- `30 * * * * *` - Уведомление на 30-й секунде каждого часа -- `0 */10 * * * *` - Уведомление на первой секунде каждых 10 минут +- `30 * * * * *` - Уведомлять на 30-й секунде каждого часа +- `0 */10 * * * *` - Уведомлять на первой секунде каждых 10 минут - `@hourly` - Ежечасное уведомление -- `@daily` - Ежедневное уведомление (00:00 утра) +- `@daily` - Ежедневное уведомление (в 00:00) - `@weekly` - Еженедельное уведомление -- `@every 8h` - Уведомление каждые 8 часов +- `@every 8h` - Уведомлять каждые 8 часов -### Возможности Телеграм-бота +### Возможности телеграм-бота - Периодические отчеты - Уведомления о входе -- Уведомления о пороге ЦП +- Уведомления о пороге CPU - Уведомления о времени истечения и трафике заранее -- Поддержка меню отчета о клиентах, если имя пользователя клиента добавлено в конфигурацию пользователя +- Поддерживает меню отчетов клиента, если имя пользователя телеграм клиента добавлено в конфигурации пользователя - Поддержка отчета о трафике через Telegram, поиск по UUID (VMESS/VLESS) или паролю (TROJAN) - анонимно -- Меню-бот -- Поиск клиента по электронной почте (только администратор) +- Бот, основанный на меню +- Поиск клиента по email (только администратор) - Проверка всех входящих соединений - Проверка состояния сервера - Проверка истекших пользователей -- Получение резервных копий по запросу и в периодических отчетах +- Получение резервных копий по запросу и в периодических отчётах - Многоязычный бот -### Настройка Телеграм-бота +### Настройка телеграм-бота -- Начните [Botfather](https://t.me/BotFather) в вашем аккаунте Telegram: +- Запустить [Botfather](https://t.me/BotFather) в вашем аккаунте Telegram: ![Botfather](./media/botfather.png) -- Создайте новый бот с помощью команды /newbot: Вас попросят ввести 2 вопроса, имя и имя пользователя для вашего бота. Обратите внимание, что имя пользователя должно заканчиваться на слово "bot". +- Создайте нового бота с помощью команды /newbot: у вас спросят 2 вопроса: отображаемое имя и имя пользователя для вашего бота. Обратите внимание, что имя пользователя должно заканчиваться на слово "bot". ![Создать нового бота](./media/newbot.png) - Запустите созданного бота. Ссылку на вашего бота можно найти здесь. ![токен](./media/token.png) -- Перейдите в панель и настройте параметры Телеграм-бота следующим образом: +- Перейдите в панель и настройте параметры телеграм-бота следующим образом: ![Настройки панели](./media/panel-bot-config.png) Введите токен вашего бота в поле ввода номер 3. Введите ID пользователя в поле ввода номер 4. Telegram-аккаунты с этим ID будут администраторами бота. (Вы можете ввести несколько ID, разделяя их запятой) -- Как получить ID пользователя Telegram? Используйте этот [бот](https://t.me/useridinfobot), начните бота, и он предоставит вам ID пользователя Telegram. +- Как получить ID пользователя Telegram? Используйте этого [бота](https://t.me/useridinfobot). Запустите бота, и он предоставит вам ваше ID пользователя Telegram. ![ID пользователя](./media/user-id.png)
-## API маршруты +## Маршруты API
Нажмите для получения информации о маршрутах API #### Использование -- `/login` с `POST` данными пользователя: `{username: '', password: ''}` для входа -- `/panel/api/inbounds` базовый маршрут для следующих действий: +- `/login` с `POST`-данными: `{username: '', password: ''}` для входа +- `/panel/api/inbounds` это базовый путь для следующих действий: | Метод | Путь | Действие -| :---: | -----------------------------------| ------------------------------------------- +| :----: | -----------------------------------| ------------------------------------------- | `GET` | `"/list"` | Получить все входящие соединения | `GET` | `"/get/:id"` | Получить входящее соединение с inbound.id -| `GET` | `"/getClientTraffics/:email"` | Получить трафик клиента по электронной почте +| `GET` | `"/getClientTraffics/:email"` | Получить трафик клиента по email | `GET` | `"/getClientTrafficsById/:id"` | Получить трафик клиента по ID -| `GET` | `"/createbackup"` | Бот Telegram отправляет резервную копию администраторам +| `GET` | `"/createbackup"` | Telegram-бот отправит резервную копию администраторам | `POST` | `"/add"` | Добавить входящее соединение | `POST` | `"/del/:id"` | Удалить входящее соединение | `POST` | `"/update/:id"` | Обновить входящее соединение | `POST` | `"/clientIps/:email"` | IP-адрес клиента -| `POST` | `"/clearClientIps/:email"` | Очистить IP-адрес клиента +| `POST` | `"/clearClientIps/:email"` | Очистить IP-адреса клиента | `POST` | `"/addClient"` | Добавить клиента к входящему соединению | `POST` | `"/:id/delClient/:clientId"` | Удалить клиента по clientId\* | `POST` | `"/updateClient/:clientId"` | Обновить клиента по clientId\* | `POST` | `"/:id/resetClientTraffic/:email"` | Сбросить трафик клиента | `POST` | `"/resetAllTraffics"` | Сбросить трафик всех входящих соединений | `POST` | `"/resetAllClientTraffics/:id"` | Сбросить трафик всех клиентов в входящем соединении -| `POST` | `"/delDepletedClients/:id"` | Удалить истекших клиентов в входящем соединении (-1: все) -| `POST` | `"/onlines"` | Получить онлайн пользователей (список электронных почт) +| `POST` | `"/delDepletedClients/:id"` | Удалить истекших клиентов в входящем соединении (-1: всех) +| `POST` | `"/onlines"` | Получить пользователей, которые онлайн (список email'ов) \*- Поле `clientId` должно быть заполнено следующим образом: @@ -484,7 +484,7 @@ WARP встроен, и дополнительная установка не т - [Run In Postman](https://app.getpostman.com/run-collection/16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415%26entityType%3Dcollection%26workspaceId%3D2cd38c01-c851-4a15-a972-f181c23359d9)
-## Переменные Среды +## Переменные среды
Нажмите для получения информации о переменных среды @@ -521,11 +521,11 @@ XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go - [alireza0](https://github.com/alireza0/) -## Подтверждение +## Благодарности - [Iran v2ray rules](https://github.com/chocolate4u/Iran-v2ray-rules) (License: **GPL-3.0**): _Enhanced v2ray/xray and v2ray/xray-clients routing rules with built-in Iranian domains and a focus on security and adblocking._ - [Vietnam Adblock rules](https://github.com/vuong2023/vn-v2ray-rules) (License: **GPL-3.0**): _A hosted domain hosted in Vietnam and blocklist with the most efficiency for Vietnamese._ -## Звездочеты со временем +## Число звёзд со временем [![Stargazers over time](https://starchart.cc/MHSanaei/3x-ui.svg)](https://starchart.cc/MHSanaei/3x-ui)