mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-25 22:06:09 +00:00
docs: vendor the documentation site into the monorepo
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.
This commit is contained in:
@@ -0,0 +1,114 @@
|
||||
// Pure REALITY helpers: X25519 keygen (WebCrypto) and server/client config
|
||||
// templating. No React/DOM — runs in the browser and in vitest (Node 22+,
|
||||
// which exposes globalThis.crypto.subtle with X25519).
|
||||
|
||||
import { bytesToBase64Url } from './base64';
|
||||
import { buildVless } from './links';
|
||||
|
||||
export interface X25519KeyPair {
|
||||
/** base64url-encoded 32-byte private scalar (xray's format). */
|
||||
privateKey: string;
|
||||
/** base64url-encoded 32-byte public key. */
|
||||
publicKey: string;
|
||||
}
|
||||
|
||||
export function isX25519Available(): boolean {
|
||||
return typeof globalThis.crypto !== 'undefined' && !!globalThis.crypto.subtle;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate an X25519 keypair and return raw 32-byte keys as base64url, matching
|
||||
* the output of `xray x25519`. The private key cannot be exported as 'raw' in
|
||||
* WebCrypto, so we export PKCS#8 and take the final 32 bytes (the scalar).
|
||||
*
|
||||
* `subtle` is injectable so tests can run deterministically against a stub.
|
||||
*/
|
||||
export async function generateX25519KeyPair(
|
||||
subtle: SubtleCrypto = globalThis.crypto.subtle,
|
||||
): Promise<X25519KeyPair> {
|
||||
const pair = (await subtle.generateKey({ name: 'X25519' }, true, [
|
||||
'deriveBits',
|
||||
])) as CryptoKeyPair;
|
||||
|
||||
const rawPublic = new Uint8Array(await subtle.exportKey('raw', pair.publicKey));
|
||||
const pkcs8 = new Uint8Array(await subtle.exportKey('pkcs8', pair.privateKey));
|
||||
const rawPrivate = pkcs8.slice(pkcs8.length - 32);
|
||||
|
||||
return {
|
||||
privateKey: bytesToBase64Url(rawPrivate),
|
||||
publicKey: bytesToBase64Url(rawPublic),
|
||||
};
|
||||
}
|
||||
|
||||
export function randomShortId(byteLength = 4): string {
|
||||
const bytes = new Uint8Array(byteLength);
|
||||
globalThis.crypto.getRandomValues(bytes);
|
||||
return Array.from(bytes, (b) => b.toString(16).padStart(2, '0')).join('');
|
||||
}
|
||||
|
||||
export function randomUuid(): string {
|
||||
return globalThis.crypto.randomUUID();
|
||||
}
|
||||
|
||||
export interface RealityConfig {
|
||||
address: string;
|
||||
port: number;
|
||||
uuid: string;
|
||||
/** Camouflage target, e.g. `www.microsoft.com:443`. */
|
||||
dest: string;
|
||||
/** SNI / serverNames; the first is used in the client link. */
|
||||
serverNames: string[];
|
||||
shortIds: string[];
|
||||
privateKey: string;
|
||||
publicKey: string;
|
||||
fingerprint: string;
|
||||
spiderX: string;
|
||||
flow: string;
|
||||
}
|
||||
|
||||
/** Server-side VLESS + REALITY inbound (Xray config shape). */
|
||||
export function realityServerInbound(c: RealityConfig): unknown {
|
||||
return {
|
||||
listen: null,
|
||||
port: c.port,
|
||||
protocol: 'vless',
|
||||
settings: {
|
||||
clients: [{ id: c.uuid, flow: c.flow }],
|
||||
decryption: 'none',
|
||||
},
|
||||
streamSettings: {
|
||||
network: 'tcp',
|
||||
security: 'reality',
|
||||
realitySettings: {
|
||||
show: false,
|
||||
dest: c.dest,
|
||||
xver: 0,
|
||||
serverNames: c.serverNames,
|
||||
privateKey: c.privateKey,
|
||||
shortIds: c.shortIds,
|
||||
fingerprint: c.fingerprint,
|
||||
},
|
||||
},
|
||||
sniffing: { enabled: true, destOverride: ['http', 'tls', 'quic'] },
|
||||
};
|
||||
}
|
||||
|
||||
/** Client `vless://` share link carrying the public REALITY parameters. */
|
||||
export function realityClientLink(c: RealityConfig): string {
|
||||
return buildVless({
|
||||
credential: c.uuid,
|
||||
address: c.address,
|
||||
port: c.port,
|
||||
params: {
|
||||
type: 'tcp',
|
||||
security: 'reality',
|
||||
pbk: c.publicKey,
|
||||
fp: c.fingerprint,
|
||||
sni: c.serverNames[0] ?? '',
|
||||
sid: c.shortIds[0] ?? '',
|
||||
spx: c.spiderX,
|
||||
flow: c.flow,
|
||||
},
|
||||
name: `${c.address}-reality`,
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user