mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-04 05:02:06 +03:00
bf7ce2daaa
* feat(discord): add Discord notification bot service, settings UI, and event subscriber - internal/web/service/discord: implement lightweight Discord REST API v10 client and EventBus subscriber - internal/web/service/setting: add discordBotEnable, discordBotToken, discordChannelId, discordEnabledEvents, discordCpu, discordMemory settings and secret protection - internal/web/controller: register POST /panel/api/setting/testDiscord endpoint - frontend: add Discord settings tab, notifications configuration, sidebar navigation, and command palette integration - translation: add localization keys across all 13 locales - tests: add comprehensive unit tests with httptest server and verify route/i18n contracts * fix(discord): address PR review findings on concurrency, linting, i18n, and stories - subscriber: eliminate unbounded goroutines, sending inline per EventBus contract - discord: accept context.Context in SendMessage, SendEmbed, SendTest with http.NewRequestWithContext - format: apply gofumpt to controller and entity struct alignments - i18n: localize testDiscord controller responses across all 13 locales - storybook: add DiscordNotifications.stories.tsx component story * docs: add Discord bot setup and operations guide - add docs/content/docs/en/operations/discord-bot.mdx with setup steps, event indicators, settings, and troubleshooting - add docs/content/docs/ru/operations/discord-bot.mdx with localized instructions - update operations/meta.json across en, ru, zh, fa - link Discord bot from panel configuration overview * feat(discord): add discordLang, discordRunTime, discordBotBackup settings and update settings UI - internal/web/entity: add DiscordRunTime, DiscordBotBackup, DiscordLang fields to AllSetting - internal/web/service/setting: add defaultValueMap entries, getters, and setters - frontend: update AllSetting schema, model defaults, and generate OpenAPI / Zod contracts - frontend: extract shared NotifyTimeField component and update DiscordTab with General and Notifications tabs - translation: add localization keys across all 13 locales * feat(discord): implement scheduled status reports and database backup attachments - internal/web/service/discord: add SendMessageWithFiles supporting multipart uploads - internal/web/service/discord: implement BuildReport and SendReport generating rich status embeds - internal/web/service/discord: attach database backup (and config.json) when discordBotBackup is enabled - internal/web/job: implement DiscordNotifyJob scheduled via robfig/cron - internal/web/locale: add LocalizerFor and I18nForLang helpers - internal/web/controller: trigger reloadDiscordFunc to dynamically reschedule cron upon setting changes - internal/web/web: register and reschedule DiscordNotifyJob - tests: comprehensive unit tests for multipart uploads, status reporting, and job execution * feat(discord): add interactive bot commands via Gateway WebSocket and update documentation - internal/web/service/discord/gateway: connect to Discord Gateway v10 via WebSocket (gorilla/websocket) - internal/web/service/discord/gateway: handle heartbeat loop, reconnection, and command dispatch - commands: implement !status, !report, !backup, !usage <email>, !inbounds, !restart, !help (with ! and / prefixes) - internal/web/web: start/stop Gateway client with server and reload dynamically on setting updates - docs: update operations guide (en, ru) with scheduled reports, backups, commands, and privileged intents - tests: add end-to-end WebSocket Gateway test verifying command handling * style(discord): fix goimports formatting and add 3x-ui to gitignore * fix(discord): stop gateway panics, reconnect storms and proxy bypass The Gateway client wrote to its websocket from both the heartbeat ticker and the read loop answering server-requested op 1 heartbeats. gorilla panics on concurrent writes and neither goroutine recovers, so a colliding heartbeat took the whole panel process down; writes now share writeMu. It also reconnected every 5s forever after close codes Discord marks non-reconnectable (4004 bad token, 4010-4014, including 4014 when Message Content Intent is off), re-identifying and logging a warning each time. The loop now stops on those codes; the docs say to restart the panel. The gateway dialed with websocket.DefaultDialer, bypassing the panel egress proxy the REST client already uses, so where Discord is filtered notifications arrived but commands never connected. * fix(discord): deliver the scheduled report when the backup upload fails SendReport posted the report embed and the x-ui.db/config.json attachments in one multipart request. Once the database outgrows Discord's upload cap (20 MiB by default) the request is rejected and the report embed is lost with it on every run, leaving only a log warning. Send the embed first and the attachments as a second message. * chore(discord): delete tests that pass whether or not the code works TestDiscordNotifyJob_NilServiceNoPanic and TestHandleEvent_NilDiscordService feed a nil DiscordService that web.go never passes, and TestDiscordNotifyJob_DisabledNoPanic passes with or without the enable guard because Xray is not running under test. * fix(discord): require admin user IDs for bot commands and honor discordLang Any member who could post in the configured channel could run !backup (the whole x-ui.db and config.json, even with discordBotBackup off), !restart and !usage. Commands now run only for the Discord user IDs in the new discordAdminIds setting; an empty list turns commands off. discordLang was saved and offered in the UI, but nothing read it, so every embed stayed English. The test message, alerts, the scheduled report and command replies now render through I18nForLang in the chosen language, with a discord section in all 13 locales. InitLocalizer takes an fs.FS so tests load the real translation files. --------- Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
79 lines
7.5 KiB
Plaintext
79 lines
7.5 KiB
Plaintext
---
|
|
title: Настройки панели
|
|
description: Все настройки панели 3x-ui — веб-сервер, TLS, отображение, безопасность и уведомления — со значениями по умолчанию из исходного кода.
|
|
icon: SlidersHorizontal
|
|
---
|
|
|
|
**Настройки панели** определяют, как сама панель обслуживается и защищается
|
|
(отдельно от ваших входящих подключений и клиентов). Настройки хранятся в виде
|
|
пар ключ/значение; приведённые ниже значения по умолчанию взяты напрямую из
|
|
исходного кода панели. Секреты (токены, пароли) отображаются только как индикатор
|
|
«задано / не задано» и никогда не передаются в браузер целиком.
|
|
|
|
## Веб-сервер
|
|
|
|
| Настройка | По умолчанию | Значение |
|
|
| ------------------- | ----------------------- | ----------------------------------------------------------------------- |
|
|
| `webPort` | `2053` | Порт панели (1–65535). Переменная окружения `XUI_PORT` переопределяет его во время выполнения. |
|
|
| `webListen` | _(все интерфейсы)_ | Привязка панели к конкретному IP. |
|
|
| `webBasePath` | `/` | URL-путь, по которому обслуживается панель (всегда нормализуется к `/…/`). |
|
|
| `webCertFile` / `webKeyFile` | _(нет)_ | Сертификат TLS + ключ. Когда заданы оба, панель обслуживается по **HTTPS**. |
|
|
| `sessionMaxAge` | `360` | Время жизни сессии в **минутах** (по умолчанию 6 часов). |
|
|
| `trustedProxyCIDRs` | `127.0.0.1/32,::1/128` | IP-адреса/CIDR, чьим переадресованным заголовкам (реальный IP клиента) можно доверять. Пользовательское значение также управляет пересылаемыми хостом и схемой в ссылках подписки; добавьте прокси подписки или задайте `subURI`, чтобы переопределить эти ссылки. |
|
|
| `panelOutbound` | _(нет)_ | Маршрутизация собственного исходящего трафика панели (проверка обновлений, Telegram, запросы geo/подписок) через именованный исходящий канал Xray. |
|
|
|
|
После изменения порта или базового пути URL панели становится
|
|
`http(s)://<server>:<port><web-base-path>`. Вы можете заранее задать базовый путь
|
|
при первом запуске с помощью [`XUI_INIT_WEB_BASE_PATH`](/docs/reference/env-vars).
|
|
|
|
### TLS
|
|
|
|
Обслуживание панели по HTTPS защищает ваши учётные данные при передаче. Либо
|
|
задайте `webCertFile` + `webKeyFile` — [меню SSL в `x-ui`](/docs/config/ssl-certificates)
|
|
может получить для вас сертификат Let's Encrypt — либо завершайте TLS на
|
|
[обратном прокси](/docs/operations/reverse-proxy).
|
|
|
|
<Callout type="warn">
|
|
Никогда не выставляйте панель по обычному HTTP в публичный интернет. Используйте
|
|
TLS, нестандартный порт и длинный случайный базовый путь.
|
|
</Callout>
|
|
|
|
## Отображение
|
|
|
|
| Настройка | По умолчанию | Значение |
|
|
| ---------------- | ------------------------------------------------ | ------------------------------------------------------------- |
|
|
| `pageSize` | `25` | Строк на странице в списках (`0` отключает разбивку на страницы). |
|
|
| `expireDiff` | `0` | За сколько дней до истечения срока начинать предупреждать. |
|
|
| `trafficDiff` | `0` | Процент оставшейся квоты, при котором начинать предупреждать. |
|
|
| `remarkTemplate` | `{{INBOUND}}-{{EMAIL}}\|📊{{TRAFFIC_LEFT}}\|⏳{{DAYS_LEFT}}D` | Шаблон примечания клиента по умолчанию (см. [Ссылки для обмена](/docs/config/share-links#remark-template-variables)). |
|
|
| `timeLocation` | `Local` | Часовой пояс для статистики и сроков истечения. |
|
|
| `datepicker` | `gregorian` | Календарь для ввода дат (григорианский или джалали/персидский). |
|
|
|
|
## Безопасность и аутентификация
|
|
|
|
Учётные данные, двухфакторная аутентификация, ограничитель перебора паролей,
|
|
сессии и LDAP описаны в разделах [Первый вход](/docs/guide/first-login) и
|
|
[Безопасность](/docs/operations/security). Вкратце:
|
|
|
|
- Пароли хранятся в виде хешей **bcrypt**; их изменение завершает все сессии.
|
|
- При входе может требоваться **2FA (TOTP)**.
|
|
- Резервный механизм **LDAP** может аутентифицировать пользователей, когда локальная проверка пароля не проходит.
|
|
- Доступ к API использует **токены API**, управляемые в разделе «Настройки панели» (см.
|
|
[справочник по API](/docs/reference/api/api-tokens)).
|
|
|
|
## Уведомления и подписка
|
|
|
|
У них есть собственные группы настроек и страницы:
|
|
|
|
<Cards>
|
|
<Card title="Бот Telegram" href="/docs/operations/telegram-bot" description="Токен, идентификаторы чатов, оповещения и отчёты." />
|
|
<Card title="Discord-бот" href="/docs/operations/discord-bot" description="Токен, ID канала и оповещения о событиях." />
|
|
<Card title="Подписка" href="/docs/config/subscription" description="Сервер подписок, форматы и пути." />
|
|
<Card title="Безопасность" href="/docs/operations/security" description="2FA, ограничения по IP и усиление защиты." />
|
|
</Cards>
|
|
|
|
<Callout type="info">
|
|
Уведомления по электронной почте (SMTP) также настраиваются (хост, порт,
|
|
шифрование, получатели) с теми же типами событий, что и у бота Telegram.
|
|
</Callout>
|