mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-14 10:41:23 +00:00
89 lines
3.0 KiB
TypeScript
89 lines
3.0 KiB
TypeScript
import { readConfigFileSnapshot, resolveGatewayPort } from "../config/config.js";
|
|
import { resolveGatewayAuthToken } from "../gateway/auth-token-resolution.js";
|
|
import { copyToClipboard } from "../infra/clipboard.js";
|
|
import type { RuntimeEnv } from "../runtime.js";
|
|
import { defaultRuntime } from "../runtime.js";
|
|
import {
|
|
detectBrowserOpenSupport,
|
|
formatControlUiSshHint,
|
|
openUrl,
|
|
resolveControlUiLinks,
|
|
} from "./onboard-helpers.js";
|
|
|
|
type DashboardOptions = {
|
|
noOpen?: boolean;
|
|
};
|
|
|
|
export async function dashboardCommand(
|
|
runtime: RuntimeEnv = defaultRuntime,
|
|
options: DashboardOptions = {},
|
|
) {
|
|
const snapshot = await readConfigFileSnapshot();
|
|
const cfg = snapshot.valid ? (snapshot.sourceConfig ?? snapshot.config) : {};
|
|
const port = resolveGatewayPort(cfg);
|
|
const bind = cfg.gateway?.bind ?? "loopback";
|
|
const basePath = cfg.gateway?.controlUi?.basePath;
|
|
const customBindHost = cfg.gateway?.customBindHost;
|
|
const resolvedToken = await resolveGatewayAuthToken({
|
|
cfg,
|
|
env: process.env,
|
|
envFallback: "always",
|
|
});
|
|
const token = resolvedToken.token ?? "";
|
|
|
|
// LAN URLs fail secure-context checks in browsers.
|
|
// Coerce only lan->loopback and preserve other bind modes.
|
|
const links = resolveControlUiLinks({
|
|
port,
|
|
bind: bind === "lan" ? "loopback" : bind,
|
|
customBindHost,
|
|
basePath,
|
|
});
|
|
// Avoid embedding externally managed SecretRef tokens in terminal/clipboard/browser args.
|
|
const includeTokenInUrl = token.length > 0 && !resolvedToken.secretRefConfigured;
|
|
// Prefer URL fragment to avoid leaking auth tokens via query params.
|
|
const dashboardUrl = includeTokenInUrl
|
|
? `${links.httpUrl}#token=${encodeURIComponent(token)}`
|
|
: links.httpUrl;
|
|
|
|
runtime.log(`Dashboard URL: ${dashboardUrl}`);
|
|
if (resolvedToken.secretRefConfigured && token) {
|
|
runtime.log(
|
|
"Token auto-auth is disabled for SecretRef-managed gateway.auth.token; use your external token source if prompted.",
|
|
);
|
|
}
|
|
if (resolvedToken.unresolvedRefReason) {
|
|
runtime.log(`Token auto-auth unavailable: ${resolvedToken.unresolvedRefReason}`);
|
|
runtime.log(
|
|
"Set OPENCLAW_GATEWAY_TOKEN in this shell or resolve your secret provider, then rerun `openclaw dashboard`.",
|
|
);
|
|
}
|
|
|
|
const copied = await copyToClipboard(dashboardUrl).catch(() => false);
|
|
runtime.log(copied ? "Copied to clipboard." : "Copy to clipboard unavailable.");
|
|
|
|
let opened = false;
|
|
let hint: string | undefined;
|
|
if (!options.noOpen) {
|
|
const browserSupport = await detectBrowserOpenSupport();
|
|
if (browserSupport.ok) {
|
|
opened = await openUrl(dashboardUrl);
|
|
}
|
|
if (!opened) {
|
|
hint = formatControlUiSshHint({
|
|
port,
|
|
basePath,
|
|
token: includeTokenInUrl ? token || undefined : undefined,
|
|
});
|
|
}
|
|
} else {
|
|
hint = "Browser launch disabled (--no-open). Use the URL above.";
|
|
}
|
|
|
|
if (opened) {
|
|
runtime.log("Opened in your browser. Keep that tab to control OpenClaw.");
|
|
} else if (hint) {
|
|
runtime.log(hint);
|
|
}
|
|
}
|