mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-31 04:12:13 +03:00
9b91f0f42e
Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to docs.sanaei.dev) into docs/ so the panel and its documentation share a single source of truth, the way sing-box keeps its docs in-tree. The old repo becomes redundant and can be retired. - Import the full site under docs/ (app, components, content, lib, public, scripts, config). The self-contained pnpm project sits alongside the existing engineering notes with no filename collisions. - Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx). - Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to docs/** and run with working-directory: docs, since GitHub only runs workflows from the repo-root .github/. deploy-static.yml's GitHub Pages publish (CNAME docs.sanaei.dev) carries over unchanged. Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to this repository's Pages (or set the Vercel project's root directory to docs), confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
122 lines
6.2 KiB
Plaintext
122 lines
6.2 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: >-
|
|
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: >-
|
|
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: >-
|
|
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: >-
|
|
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: >-
|
|
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: >-
|
|
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 { APIPage, OpenAPIPage } = props.components ?? {};
|
|
// "APIPage" is the old name from v10, this allows both for backward compatibility
|
|
const Comp = OpenAPIPage ?? APIPage;
|
|
return (
|
|
<>
|
|
{props.children}
|
|
<Comp document="./public/openapi.json" webhooks={[]} operations={[{"path":"/panel/api/setting/all","method":"post"},{"path":"/panel/api/setting/defaultSettings","method":"post"},{"path":"/panel/api/setting/update","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/getDefaultJsonConfig","method":"get"}]} showTitle />
|
|
</>
|
|
);
|
|
} |