mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-18 04:37:14 +07:00
MHSanaei
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.
46 lines
2.0 KiB
Plaintext
46 lines
2.0 KiB
Plaintext
---
|
|
title: WebSocket
|
|
description: >-
|
|
Real-time status updates via WebSocket. Connect once at
|
|
<code>ws://<panel>/ws</code> to receive a stream of JSON messages without
|
|
polling. Requires an authenticated session cookie (Bearer token auth is not
|
|
supported). Each message has a <code>type</code> field that identifies the
|
|
payload shape.
|
|
full: true
|
|
_openapi:
|
|
preload:
|
|
- ./public/openapi.json
|
|
toc:
|
|
- depth: 2
|
|
title: >-
|
|
Upgrade an HTTP connection to a WebSocket. Requires an authenticated
|
|
session cookie (Bearer token auth is not supported here). Returns 101
|
|
Switching Protocols on success. The server then pushes JSON messages
|
|
described below.
|
|
url: >-
|
|
#upgrade-an-http-connection-to-a-websocket-requires-an-authenticated-session-cookie-bearer-token-auth-is-not-supported-here-returns-101-switching-protocols-on-success-the-server-then-pushes-json-messages-described-below
|
|
structuredData:
|
|
headings:
|
|
- content: >-
|
|
Upgrade an HTTP connection to a WebSocket. Requires an authenticated
|
|
session cookie (Bearer token auth is not supported here). Returns 101
|
|
Switching Protocols on success. The server then pushes JSON messages
|
|
described below.
|
|
id: >-
|
|
upgrade-an-http-connection-to-a-websocket-requires-an-authenticated-session-cookie-bearer-token-auth-is-not-supported-here-returns-101-switching-protocols-on-success-the-server-then-pushes-json-messages-described-below
|
|
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":"/ws","method":"get"}]} showTitle />
|
|
</>
|
|
);
|
|
} |