mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-11-04 09:44:48 +03:00
DIMFLIX
15fee2a035
The bot answered every action with a new message, so a chat filled with stale menus whose buttons still acted, and long client or inbound lists were paged through dozens of buttons. Each chat now has one live screen that is edited in place: the menu is grouped into Server, Clients, Traffic and Maintenance, lists open through inline search, the add-client flow starts from a draft card, QR codes arrive as one labelled sheet, and repeated notices collapse into one with a counter. A client's /start and /usage show only that client's own links and usage, groups are refused, and the settings page warns when the bot's inline mode is off. Admin topics, the indexed Telegram lookup and every locale, Slovak included, carry over.
119 lines
8.3 KiB
Plaintext
119 lines
8.3 KiB
Plaintext
---
|
|
title: Settings
|
|
description: Panel configuration and user credentials. All endpoints live under
|
|
/panel/api/setting and require a logged-in session or Bearer token.
|
|
full: true
|
|
_openapi:
|
|
preload:
|
|
- ./public/openapi.json
|
|
toc:
|
|
- depth: 2
|
|
title: 'Return every panel setting: web server, Telegram bot, subscription,
|
|
security, LDAP. The full JSON blob that the Settings page edits.'
|
|
url: '#return-every-panel-setting-web-server-telegram-bot-subscription-security-ldap-the-full-json-blob-that-the-settings-page-edits'
|
|
- depth: 2
|
|
title: Return the computed default settings based on the request host. Useful to
|
|
preview what a fresh install would use.
|
|
url: '#return-the-computed-default-settings-based-on-the-request-host-useful-to-preview-what-a-fresh-install-would-use'
|
|
- depth: 2
|
|
title: Return the shipped (factory) default value per browser-safe setting key,
|
|
so clients can tell a stored value apart from the default it would fall
|
|
back to. Per-install material (secret, panelGuid, mTLS keys) and
|
|
credential fields are never included.
|
|
url: '#return-the-shipped-factory-default-value-per-browser-safe-setting-key-so-clients-can-tell-a-stored-value-apart-from-the-default-it-would-fall-back-to-per-install-material-secret-panelguid-mtls-keys-and-credential-fields-are-never-included'
|
|
- depth: 2
|
|
title: Persist every setting at once. The body mirrors the shape returned by
|
|
/all. Invalid values (bad ports, missing cert pairs, etc.) are rejected
|
|
before write.
|
|
url: '#persist-every-setting-at-once-the-body-mirrors-the-shape-returned-by-all-invalid-values-bad-ports-missing-cert-pairs-etc-are-rejected-before-write'
|
|
- depth: 2
|
|
title: Validate any regular expression with the backend Go RE2 compiler without
|
|
saving it.
|
|
url: '#validate-any-regular-expression-with-the-backend-go-re2-compiler-without-saving-it'
|
|
- depth: 2
|
|
title: Change the panel admin username and password. Requires the current
|
|
credentials for verification. The session is refreshed with the new
|
|
values on success.
|
|
url: '#change-the-panel-admin-username-and-password-requires-the-current-credentials-for-verification-the-session-is-refreshed-with-the-new-values-on-success'
|
|
- depth: 2
|
|
title: Restart the entire 3x-ui process after a 3-second grace period. The
|
|
connection drops immediately; the panel comes back online ~5-10 seconds
|
|
later.
|
|
url: '#restart-the-entire-3x-ui-process-after-a-3-second-grace-period-the-connection-drops-immediately-the-panel-comes-back-online-5-10-seconds-later'
|
|
- depth: 2
|
|
title: Test SMTP connection with stage-by-stage reporting (connect, auth, send).
|
|
Returns structured result with stage and message.
|
|
url: '#test-smtp-connection-with-stage-by-stage-reporting-connect-auth-send-returns-structured-result-with-stage-and-message'
|
|
- depth: 2
|
|
title: Test Telegram bot connection by sending a test message to the configured
|
|
chat.
|
|
url: '#test-telegram-bot-connection-by-sending-a-test-message-to-the-configured-chat'
|
|
- depth: 2
|
|
title: Report what the configured bot can do. Inline mode is a BotFather switch,
|
|
so the panel warns when it is off.
|
|
url: '#report-what-the-configured-bot-can-do-inline-mode-is-a-botfather-switch-so-the-panel-warns-when-it-is-off'
|
|
- depth: 2
|
|
title: Test Discord bot connection by sending a test embed to the configured
|
|
channel.
|
|
url: '#test-discord-bot-connection-by-sending-a-test-embed-to-the-configured-channel'
|
|
- depth: 2
|
|
title: Return the built-in default Xray JSON config template that ships with
|
|
this panel version.
|
|
url: '#return-the-built-in-default-xray-json-config-template-that-ships-with-this-panel-version'
|
|
structuredData:
|
|
headings:
|
|
- content: 'Return every panel setting: web server, Telegram bot, subscription,
|
|
security, LDAP. The full JSON blob that the Settings page edits.'
|
|
id: return-every-panel-setting-web-server-telegram-bot-subscription-security-ldap-the-full-json-blob-that-the-settings-page-edits
|
|
- content: Return the computed default settings based on the request host. Useful
|
|
to preview what a fresh install would use.
|
|
id: return-the-computed-default-settings-based-on-the-request-host-useful-to-preview-what-a-fresh-install-would-use
|
|
- content: Return the shipped (factory) default value per browser-safe setting
|
|
key, so clients can tell a stored value apart from the default it
|
|
would fall back to. Per-install material (secret, panelGuid, mTLS
|
|
keys) and credential fields are never included.
|
|
id: return-the-shipped-factory-default-value-per-browser-safe-setting-key-so-clients-can-tell-a-stored-value-apart-from-the-default-it-would-fall-back-to-per-install-material-secret-panelguid-mtls-keys-and-credential-fields-are-never-included
|
|
- content: Persist every setting at once. The body mirrors the shape returned by
|
|
/all. Invalid values (bad ports, missing cert pairs, etc.) are
|
|
rejected before write.
|
|
id: persist-every-setting-at-once-the-body-mirrors-the-shape-returned-by-all-invalid-values-bad-ports-missing-cert-pairs-etc-are-rejected-before-write
|
|
- content: Validate any regular expression with the backend Go RE2 compiler
|
|
without saving it.
|
|
id: validate-any-regular-expression-with-the-backend-go-re2-compiler-without-saving-it
|
|
- content: Change the panel admin username and password. Requires the current
|
|
credentials for verification. The session is refreshed with the new
|
|
values on success.
|
|
id: change-the-panel-admin-username-and-password-requires-the-current-credentials-for-verification-the-session-is-refreshed-with-the-new-values-on-success
|
|
- content: Restart the entire 3x-ui process after a 3-second grace period. The
|
|
connection drops immediately; the panel comes back online ~5-10
|
|
seconds later.
|
|
id: restart-the-entire-3x-ui-process-after-a-3-second-grace-period-the-connection-drops-immediately-the-panel-comes-back-online-5-10-seconds-later
|
|
- content: Test SMTP connection with stage-by-stage reporting (connect, auth,
|
|
send). Returns structured result with stage and message.
|
|
id: test-smtp-connection-with-stage-by-stage-reporting-connect-auth-send-returns-structured-result-with-stage-and-message
|
|
- content: Test Telegram bot connection by sending a test message to the
|
|
configured chat.
|
|
id: test-telegram-bot-connection-by-sending-a-test-message-to-the-configured-chat
|
|
- content: Report what the configured bot can do. Inline mode is a BotFather
|
|
switch, so the panel warns when it is off.
|
|
id: report-what-the-configured-bot-can-do-inline-mode-is-a-botfather-switch-so-the-panel-warns-when-it-is-off
|
|
- content: Test Discord bot connection by sending a test embed to the configured
|
|
channel.
|
|
id: test-discord-bot-connection-by-sending-a-test-embed-to-the-configured-channel
|
|
- content: Return the built-in default Xray JSON config template that ships with
|
|
this panel version.
|
|
id: return-the-built-in-default-xray-json-config-template-that-ships-with-this-panel-version
|
|
contents: []
|
|
---
|
|
|
|
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
|
|
|
export default function Layout(props) {
|
|
const { OpenAPIPage } = props.components ?? {};
|
|
return (
|
|
<>
|
|
{props.children}
|
|
<OpenAPIPage document="./public/openapi.json" webhooks={[]} operations={[{"path":"/panel/api/setting/all","method":"post"},{"path":"/panel/api/setting/defaultSettings","method":"post"},{"path":"/panel/api/setting/factoryDefaults","method":"post"},{"path":"/panel/api/setting/update","method":"post"},{"path":"/panel/api/setting/validateRegex","method":"post"},{"path":"/panel/api/setting/updateUser","method":"post"},{"path":"/panel/api/setting/restartPanel","method":"post"},{"path":"/panel/api/setting/testSmtp","method":"post"},{"path":"/panel/api/setting/testTgBot","method":"post"},{"path":"/panel/api/setting/tgBotCapabilities","method":"post"},{"path":"/panel/api/setting/testDiscord","method":"post"},{"path":"/panel/api/setting/getDefaultJsonConfig","method":"get"}]} showTitle />
|
|
</>
|
|
);
|
|
} |