mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-16 15:17:14 +00:00
Egor
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
4.8 KiB
Plaintext
79 lines
4.8 KiB
Plaintext
---
|
||
title: Panel Settings
|
||
description: Every 3x-ui panel setting — web server, TLS, display, security, and notifications — with defaults from the source.
|
||
icon: SlidersHorizontal
|
||
---
|
||
|
||
**Panel Settings** controls how the panel itself is served and secured (separate
|
||
from your inbounds and clients). Settings are stored as key/value pairs; the
|
||
defaults below come straight from the panel source. Secrets (tokens, passwords)
|
||
are shown only as a "set / not set" indicator and are never returned to the
|
||
browser in full.
|
||
|
||
## Web server
|
||
|
||
| Setting | Default | Meaning |
|
||
| ------------------- | ----------------------- | ----------------------------------------------------------------------- |
|
||
| `webPort` | `2053` | Panel port (1–65535). The `XUI_PORT` env var overrides it at runtime. |
|
||
| `webListen` | _(all interfaces)_ | Bind the panel to a specific IP. |
|
||
| `webBasePath` | `/` | URL path the panel is served under (always normalized to `/…/`). |
|
||
| `webCertFile` / `webKeyFile` | _(none)_ | TLS certificate + key. When both are set, the panel serves **HTTPS**. |
|
||
| `sessionMaxAge` | `360` | Session lifetime in **minutes** (default 6 hours). |
|
||
| `trustedProxyCIDRs` | `127.0.0.1/32,::1/128` | IPs/CIDRs whose forwarded headers (real client IP) are trusted. A custom value also controls forwarded host and scheme in subscription links; include the subscription proxy or set `subURI` to override those links. |
|
||
| `panelOutbound` | _(none)_ | Route the panel's own egress (update checks, Telegram, geo/sub fetches) through a named Xray outbound. |
|
||
|
||
After changing the port or base path, the panel URL becomes
|
||
`http(s)://<server>:<port><web-base-path>`. You can preset the base path on first
|
||
launch with [`XUI_INIT_WEB_BASE_PATH`](/docs/reference/env-vars).
|
||
|
||
### TLS
|
||
|
||
Serving the panel over HTTPS protects your credentials in transit. Either set
|
||
`webCertFile` + `webKeyFile` — the [`x-ui` SSL menu](/docs/config/ssl-certificates)
|
||
can obtain a Let's Encrypt certificate for you — or terminate TLS at a
|
||
[reverse proxy](/docs/operations/reverse-proxy).
|
||
|
||
<Callout type="warn">
|
||
Never expose the panel over plain HTTP on the public internet. Use TLS, a
|
||
non-default port, and a long random web base path.
|
||
</Callout>
|
||
|
||
## Display
|
||
|
||
| Setting | Default | Meaning |
|
||
| ---------------- | ------------------------------------------------ | ------------------------------------------------------------- |
|
||
| `pageSize` | `25` | Rows per page in lists (`0` disables pagination). |
|
||
| `expireDiff` | `0` | Days before expiry to start warning. |
|
||
| `trafficDiff` | `0` | Percent of quota remaining at which to start warning. |
|
||
| `remarkTemplate` | `{{INBOUND}}-{{EMAIL}}\|📊{{TRAFFIC_LEFT}}\|⏳{{DAYS_LEFT}}D` | Default client remark template (see [Share links](/docs/config/share-links#remark-template-variables)). |
|
||
| `timeLocation` | `Local` | Time zone for stats and expiry. |
|
||
| `datepicker` | `gregorian` | Calendar for date inputs (Gregorian or Jalali/Persian). |
|
||
|
||
## Security & authentication
|
||
|
||
Credentials, two-factor auth, the brute-force limiter, sessions, and LDAP are
|
||
covered in [First login](/docs/guide/first-login) and
|
||
[Security](/docs/operations/security). In short:
|
||
|
||
- Passwords are stored as **bcrypt** hashes; changing them logs out all sessions.
|
||
- **2FA (TOTP)** can be required at login.
|
||
- An **LDAP** fallback can authenticate users when the local password check fails.
|
||
- API access uses **API tokens** managed under Panel Settings (see the
|
||
[API reference](/docs/reference/api/api-tokens)).
|
||
|
||
## Notifications & subscription
|
||
|
||
These have their own settings groups and pages:
|
||
|
||
<Cards>
|
||
<Card title="Telegram bot" href="/docs/operations/telegram-bot" description="Token, chat IDs, alerts, and reports." />
|
||
<Card title="Discord bot" href="/docs/operations/discord-bot" description="Token, channel ID, and event alerts." />
|
||
<Card title="Subscription" href="/docs/config/subscription" description="Subscription server, formats, and paths." />
|
||
<Card title="Security" href="/docs/operations/security" description="2FA, IP limits, and hardening." />
|
||
</Cards>
|
||
|
||
<Callout type="info">
|
||
Email (SMTP) notifications are also configurable (host, port, encryption,
|
||
recipients) with the same event types as the Telegram bot.
|
||
</Callout>
|