Skip to content

Commit

Permalink
Some README updates (#2562)
Browse files Browse the repository at this point in the history
* Update README.ru_RU.md

Fixed some typos here and there

* Add info about docker image autoupdate

* Update Russian translation

* Add info on Portuguese (Brazip) translation
  • Loading branch information
laperuz92 authored Sep 13, 2024
1 parent 2938694 commit 9c4fa23
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ systemctl restart x-ui
docker compose up -d
```

Add ```--pull always``` flag to make docker automatically recreate container if a newer image is pulled. See https://docs.docker.com/reference/cli/docker/container/run/#pull for more info.

**OR**

```sh
Expand Down
19 changes: 11 additions & 8 deletions README.ru_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

> **Отказ от ответственности:** Этот проект предназначен только для личного обучения и общения. Пожалуйста, не используйте его в незаконных целях и не применяйте в производственной среде.
**Если этот проект оказался полезным для вас, вы можете оценить его, постативив звёздочку** :star2:
**Если этот проект оказался полезным для вас, вы можете оценить его, поставив звёздочку** :star2:

<p align="left">
<a href="https://buymeacoffee.com/mhsanaei" target="_blank">
Expand Down Expand Up @@ -53,7 +53,7 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.

- **Get SSL:** Получить SSL сертификаты.
- **Revoke:** Отозвать существующие SSL сертификаты.
- **Force Renew:** Принудительно превыпустить SSL сертификаты.
- **Force Renew:** Принудительно перевыпустить SSL сертификаты.

### Certbot

Expand All @@ -76,7 +76,7 @@ certbot renew --dry-run
**Как получить глобальный API-ключ Cloudflare:**

1. Выполните команду `x-ui` в терминале, затем выберите `Cloudflare SSL Certificate`.
2. Посетите ссылку: [Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens).
2. Перейдите по ссылке: [Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens).
3. Нажмите на "View Global API Key" (см. скриншот ниже):
![](media/APIKey1.PNG)
4. Возможно, вам потребуется повторно пройти аутентификацию. После этого ключ API будет отображён (см. скриншот ниже):
Expand Down Expand Up @@ -168,6 +168,8 @@ systemctl restart x-ui
docker compose up -d
```

Добавьте параметр ```--pull always``` для автоматического обновления контейнера, когда публикуется новый образ. Подробности: https://docs.docker.com/reference/cli/docker/container/run/#pull

**ИЛИ**

```sh
Expand Down Expand Up @@ -285,6 +287,7 @@ location /sub {
- Индонезийский
- Украинский
- Турецкий
- Португальский (Бразилия)

## Возможности

Expand Down Expand Up @@ -329,7 +332,7 @@ location /sub {
- Выберите опцию `Reset Web Base Path`.

2. **Генерация или настройка пути:**
- Путь будет случайным образом сгенерирован, или вы можете ввести пользовательский путь.
- Путь будет сгенерирован случайным образом, или вы можете ввести собственный путь.

3. **Просмотр текущих настроек:**
- Чтобы просмотреть текущие настройки, используйте команду `x-ui settings` в терминале или опцию `View Current Settings` в `x-ui`.
Expand Down Expand Up @@ -430,7 +433,7 @@ WARP встроен, и дополнительная установка не т

- Периодические отчеты
- Уведомления о входе
- Уведомления о пороге CPU
- Уведомления о пороге загруженности процессора
- Уведомления о времени истечения и трафике заранее
- Поддерживает меню отчетов клиента, если имя пользователя телеграм клиента добавлено в конфигурации пользователя
- Поддержка отчета о трафике через Telegram, поиск по UUID (VMESS/VLESS) или паролю (TROJAN) - анонимно
Expand All @@ -444,7 +447,7 @@ WARP встроен, и дополнительная установка не т

### Настройка телеграм-бота

- Запустить [Botfather](https://t.me/BotFather) в вашем аккаунте Telegram:
- Запустите [Botfather](https://t.me/BotFather) в вашем аккаунте Telegram:
![Botfather](./media/botfather.png)

- Создайте нового бота с помощью команды /newbot: у вас спросят 2 вопроса: отображаемое имя и имя пользователя для вашего бота. Обратите внимание, что имя пользователя должно заканчиваться на слово "bot".
Expand All @@ -459,7 +462,7 @@ WARP встроен, и дополнительная установка не т
Введите токен вашего бота в поле ввода номер 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)

</details>
Expand Down Expand Up @@ -493,7 +496,7 @@ WARP встроен, и дополнительная установка не т
| `POST` | `"/resetAllTraffics"` | Сбросить трафик всех входящих соединений
| `POST` | `"/resetAllClientTraffics/:id"` | Сбросить трафик всех клиентов в входящем соединении
| `POST` | `"/delDepletedClients/:id"` | Удалить истекших клиентов в входящем соединении (-1: всех)
| `POST` | `"/onlines"` | Получить пользователей, которые онлайн (список email'ов)
| `POST` | `"/onlines"` | Получить пользователей, которые находятся онлайн (список email'ов)
\*- Поле `clientId` должно быть заполнено следующим образом:
Expand Down

0 comments on commit 9c4fa23

Please sign in to comment.