mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-14 08:36:07 +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,71 @@
|
||||
'use client';
|
||||
|
||||
import { useState } from 'react';
|
||||
import {
|
||||
buildUfwCommands,
|
||||
buildNftablesRuleset,
|
||||
type FirewallOptions,
|
||||
type PortProtocol,
|
||||
type PortRule,
|
||||
} from '@/lib/xray/firewall';
|
||||
import { ToolFrame } from './tool-frame';
|
||||
import { CheckboxField } from './shared/fields';
|
||||
import { OutputBlock } from './shared/output-block';
|
||||
|
||||
interface Row {
|
||||
label: string;
|
||||
port: string;
|
||||
protocol: PortProtocol;
|
||||
enabled: boolean;
|
||||
}
|
||||
|
||||
const DEFAULT_ROWS: Row[] = [
|
||||
{ label: 'panel', port: '2053', protocol: 'tcp', enabled: true },
|
||||
{ label: 'subscription', port: '2096', protocol: 'tcp', enabled: false },
|
||||
{ label: 'inbound (HTTPS)', port: '443', protocol: 'tcp', enabled: true },
|
||||
{ label: 'inbound (UDP)', port: '443', protocol: 'udp', enabled: false },
|
||||
];
|
||||
|
||||
export function FirewallRulesGenerator() {
|
||||
const [allowSsh, setAllowSsh] = useState(true);
|
||||
const [sshPort] = useState('22');
|
||||
const [rows, setRows] = useState<Row[]>(DEFAULT_ROWS);
|
||||
|
||||
function toggle(index: number, enabled: boolean) {
|
||||
setRows((prev) => prev.map((r, i) => (i === index ? { ...r, enabled } : r)));
|
||||
}
|
||||
|
||||
const ports: PortRule[] = rows
|
||||
.filter((r) => r.enabled && Number(r.port) > 0)
|
||||
.map((r) => ({ port: Number(r.port), protocol: r.protocol, label: r.label }));
|
||||
|
||||
const options: FirewallOptions = { ports, allowSsh, sshPort: Number(sshPort) || 22 };
|
||||
|
||||
return (
|
||||
<ToolFrame
|
||||
title="Firewall rules generator"
|
||||
description="Pick the ports to open and copy ready-made ufw and nftables rules."
|
||||
>
|
||||
<div className="flex flex-col gap-2">
|
||||
<CheckboxField
|
||||
label={`Allow SSH (port ${sshPort})`}
|
||||
checked={allowSsh}
|
||||
onChange={setAllowSsh}
|
||||
/>
|
||||
{rows.map((row, i) => (
|
||||
<CheckboxField
|
||||
key={`${row.label}-${row.protocol}`}
|
||||
label={`${row.label} — ${row.port}/${row.protocol}`}
|
||||
checked={row.enabled}
|
||||
onChange={(c) => toggle(i, c)}
|
||||
/>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="mt-4 grid grid-cols-1 gap-4">
|
||||
<OutputBlock label="ufw" value={buildUfwCommands(options)} />
|
||||
<OutputBlock label="nftables (/etc/nftables.conf)" value={buildNftablesRuleset(options)} />
|
||||
</div>
|
||||
</ToolFrame>
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user