@naviyra/cloud-panel 0.0.1 → 0.0.3-beta

package/README.md

@@ -8,7 +8,18 @@ npx @naviyra/cloud-panel
 
 Run that command in an empty folder. It copies the panel there, installs dependencies, asks in the terminal for the administrator email, password, and agent port, then opens the browser. JWT and agent secrets are generated. Node.js 22.9 or newer is required. Startup also requires PostgreSQL (on Windows, PostgreSQL 18 at its default location, or set `POSTGRES_BIN` in `.env`) and the [private runtime prerequisites](docs/managed-runtime.md). Sign-in details are written to `.runtime/local-login.txt`.
 
-On Windows, that install also registers a scheduled task named **Naviyra Cloud Panel**. The task runs as the same account, starts the panel immediately, starts it again at the next sign-in (including after a reboot), and restarts it if it stops. A supervisor restarts the panel a few seconds after a crash; Task Scheduler restarts the supervisor if that process dies. The panel keeps running after the installer exits. Progress is written to `.runtime/service.log`. Run the installer from an elevated PowerShell when the panel must start before anyone signs in. Stop it with `node scripts/windows-boot.mjs stop`, or remove it with `node scripts/windows-boot.mjs remove`.
+On Windows, that install also registers a scheduled task named **Naviyra Cloud Panel**. The task runs as the same account, starts the panel immediately, starts it again at the next sign-in (including after a reboot), and restarts it if it stops. A supervisor restarts the panel a few seconds after a crash; Task Scheduler restarts the supervisor if that process dies. The panel keeps running after the installer exits. Progress is written to `.runtime/service.log`.
+
+```powershell
+npx @naviyra/cloud-panel status
+npx @naviyra/cloud-panel open
+npx @naviyra/cloud-panel stop
+npx @naviyra/cloud-panel start
+npx @naviyra/cloud-panel update
+npx @naviyra/cloud-panel uninstall
+```
+
+`status` prints the panel address and whether it is accepting sign-in. `open` launches that address in the browser. Run the installer from an empty folder you own, such as `D:\naviyra-install`. It will not install into `C:\Windows`. Run the installer from an elevated PowerShell when the panel must start before anyone signs in.
 
 To install and configure prerequisites before leaving the panel running, use `npx @naviyra/cloud-panel --install-only`. Use `--no-browser` to start without opening a browser. Re-running the installer checks all workspace dependencies and preserves existing `.env` credentials. This package is separate from `@naviyra/hosting-panel`.
 

package/bin/naviyra.mjs

@@ -122,17 +122,40 @@ const cwd = process.cwd();
 try {
   const args = process.argv.slice(2);
   for (const arg of args)
-    if (!["--help", "-h", "--install-only", "--no-browser"].includes(arg))
+    if (
+      !["--help", "-h", "--install-only", "--no-browser"].includes(arg) &&
+      !["status", "open", "stop", "start", "update", "uninstall"].includes(arg)
+    )
       throw Error(`Unknown option: ${arg}. Run with --help for usage.`);
+  const command = ["status", "open", "stop", "start", "update", "uninstall"].find(
+    (name) => args[0] === name,
+  );
+  if (command) {
+    const control = await import(
+      pathToFileURL(path.join(source, "scripts", "panel-control.mjs")).href
+    );
+    await control.execute(command, {
+      cwd,
+      source,
+      copy: copyTree,
+      install: (dir) => run("npm", ["install", "--omit=dev"], dir),
+    });
+    process.exit(0);
+  }
   if (args.includes("--help") || args.includes("-h")) {
-    console.log(`Usage: npx @naviyra/cloud-panel [--install-only] [--no-browser]
+    console.log(`Usage: npx @naviyra/cloud-panel [status|open|stop|start|update|uninstall]
+       npx @naviyra/cloud-panel [--install-only] [--no-browser]
 
 Installs into the current empty folder, or a naviyra subfolder.
 In a terminal, asks for the administrator email, password, and agent port.
 On Windows, also registers a scheduled task that keeps the panel running
-and restarts it if it stops. The task uses the account that runs the
-installer, starts again at the next sign-in, and starts at boot when the
-installer itself is elevated.
+and restarts it if it stops.
+status     Show whether the panel is running and its address.
+open       Open the panel in the browser.
+stop       Stop the panel.
+start      Start the panel again.
+update     Replace the installed copy with this package and start it.
+uninstall  Stop the panel, remove the startup task, and delete the install folder.
 --install-only  Install, register the startup task, and leave it running.
 --no-browser    Do not open a browser after the panel is ready.
 
@@ -150,6 +173,14 @@ See docs/managed-runtime.md in the installed folder.`);
         );
     }
     if (!(await isPanel(target))) {
+      const controlPath = path.join(source, "scripts", "panel-control.mjs");
+      if (await exists(controlPath)) {
+        const { isProtectedDir } = await import(pathToFileURL(controlPath).href);
+        if (isProtectedDir(target))
+          throw Error(
+            `Naviyra cannot install into ${target}. Open PowerShell in an empty folder you own, such as D:\\naviyra-install, and run npx @naviyra/cloud-panel there.`,
+          );
+      }
       console.log(`Installing Naviyra into ${target}`);
       await copyTree(source, target);
     }
@@ -158,12 +189,24 @@ See docs/managed-runtime.md in the installed folder.`);
   // created pg already while leaving Next.js or the agent dependencies missing.
   console.log("Checking and installing dependencies…");
   await run("npm", ["install", "--omit=dev"], target);
+  const controlPath = path.join(source, "scripts", "panel-control.mjs");
+  if (await exists(controlPath)) {
+    const { linkBin } = await import(pathToFileURL(controlPath).href);
+    await linkBin(target);
+  }
   await run(process.execPath, ["scripts/setup-local.mjs"], target);
   const background = await enableBackground(target);
   if (background) {
-    console.log(
-      "Naviyra will keep running in the background. Stop it with: node scripts/windows-boot.mjs stop",
-    );
+    const envText = await readFile(path.join(target, ".env"), "utf8").catch(() => "");
+    const port = Number((envText.match(/^PANEL_PORT=(.*)$/m)?.[1] ?? "3000").trim());
+    const origin =
+      Number.isInteger(port) && port > 0 && port < 65536
+        ? `http://127.0.0.1:${port}`
+        : "http://127.0.0.1:3000";
+    console.log(`Panel address: ${origin}`);
+    console.log("Status: npx @naviyra/cloud-panel status");
+    console.log("Open:   npx @naviyra/cloud-panel open");
+    console.log("Stop:   npx @naviyra/cloud-panel stop");
     if (!args.includes("--install-only") && !args.includes("--no-browser"))
       await background.openPanelWhenReady(target);
   } else if (args.includes("--install-only")) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naviyra/cloud-panel",
-  "version": "0.0.1",
+  "version": "0.0.3-beta",
   "description": "Self-hosted Naviyra panel for projects, databases, DNS, and email routing.",
   "type": "module",
   "bin": {
@@ -21,7 +21,8 @@
     "README.md"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "tag": "beta"
   },
   "workspaces": [
     "apps/*",

package/scripts/panel-control.mjs

@@ -0,0 +1,214 @@
+import { spawn } from "node:child_process";
+import { access, mkdir, readFile, rm, writeFile } from "node:fs/promises";
+import path from "node:path";
+import {
+  TASK_NAME,
+  panelOrigin,
+  removeBootTask,
+  runPowerShell,
+  startBootTask,
+  stopBootTask,
+} from "./windows-boot.mjs";
+
+export const COMMANDS = ["status", "open", "stop", "start", "update", "uninstall"];
+
+export function isProtectedDir(dir) {
+  const resolved = path.resolve(dir);
+  const roots = [
+    process.env.WINDIR,
+    process.env.ProgramFiles,
+    process.env["ProgramFiles(x86)"],
+  ].filter(Boolean);
+  return roots.some((root) => {
+    const base = path.resolve(root);
+    const prefix = base.toLowerCase() + path.sep;
+    return resolved.toLowerCase().startsWith(prefix) || resolved.toLowerCase() === base.toLowerCase();
+  });
+}
+
+export function canRemoveInstall(dir) {
+  const resolved = path.resolve(dir);
+  const base = path.basename(resolved).toLowerCase();
+  if (base === "system32" || base === "windows" || base === "syswow64") return false;
+  const windir = path.resolve(process.env.WINDIR || "C:\\Windows");
+  return resolved.toLowerCase() !== windir.toLowerCase();
+}
+
+export function problemFromLog(text) {
+  const lines = String(text)
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .filter(Boolean);
+  if (lines.some((line) => /permission denied/i.test(line)))
+    return "PostgreSQL could not create its data directory because this folder is protected. Install into an empty folder you own, such as D:\\naviyra-install.";
+  return lines.findLast((line) => /could not start|exited 1|error:/i.test(line)) || "";
+}
+
+export function formatStatus({ dir, taskState, origin, ready, problem }) {
+  if (!dir && (!taskState || taskState === "missing"))
+    return "Naviyra is not installed. From an empty folder you own, run: npx @naviyra/cloud-panel";
+  const lines = [
+    ready ? "Naviyra is running." : "Naviyra is not ready.",
+    `Panel: ${origin || "http://127.0.0.1:3000"}`,
+  ];
+  if (dir) lines.push(`Install folder: ${dir}`);
+  lines.push(`Startup task: ${taskState || "not registered"}`);
+  if (!ready && problem) lines.push(problem);
+  lines.push(
+    ready
+      ? "Open the panel with: npx @naviyra/cloud-panel open"
+      : "After it is ready, open it with: npx @naviyra/cloud-panel open",
+  );
+  return lines.join("\n");
+}
+
+async function isPanel(dir) {
+  try {
+    const pkg = JSON.parse(await readFile(path.join(dir, "package.json"), "utf8"));
+    await access(path.join(dir, "apps", "panel", "package.json"));
+    return pkg.name === "@naviyra/cloud-panel";
+  } catch {
+    return false;
+  }
+}
+
+export async function queryTask(run = runPowerShell) {
+  const result = await run(`$task = Get-ScheduledTask -TaskName ${"'" + TASK_NAME.replaceAll("'", "''") + "'"} -ErrorAction SilentlyContinue
+if (-not $task) { Write-Output 'STATE=missing'; exit 0 }
+Write-Output ('STATE=' + $task.State)
+Write-Output ('DIR=' + $task.Actions[0].WorkingDirectory)
+`);
+  const state = result.output.match(/STATE=(.*)/)?.[1]?.trim() || "missing";
+  const dir = result.output.match(/DIR=(.*)/)?.[1]?.trim() || "";
+  return { state, dir };
+}
+
+export async function panelHealthy(origin) {
+  try {
+    const response = await fetch(`${origin}/api/me`, {
+      redirect: "manual",
+      signal: AbortSignal.timeout(2000),
+    });
+    const body = await response.json();
+    return response.status === 401 && body.error === "Please sign in";
+  } catch {
+    return false;
+  }
+}
+
+function openBrowser(origin) {
+  const file = process.platform === "win32" ? "explorer.exe" : "xdg-open";
+  const browser = spawn(file, [origin], { windowsHide: true, stdio: "ignore" });
+  browser.once("error", () => console.log(`Open ${origin} in your browser.`));
+  browser.unref();
+}
+
+async function locate(options) {
+  const task = options.queryTask ? await options.queryTask() : await queryTask(options.runPowerShell);
+  if (task.dir && (await isPanel(task.dir))) return { ...task, dir: task.dir };
+  if (options.cwd && (await isPanel(options.cwd)))
+    return { state: task.state, dir: options.cwd };
+  return { state: task.state || "missing", dir: "" };
+}
+
+async function readStatus(dir, taskState) {
+  let envText = "";
+  let logText = "";
+  if (dir) {
+    try {
+      envText = await readFile(path.join(dir, ".env"), "utf8");
+    } catch {
+      envText = "";
+    }
+    try {
+      logText = await readFile(path.join(dir, ".runtime", "service.log"), "utf8");
+    } catch {
+      logText = "";
+    }
+  }
+  const origin = panelOrigin(envText);
+  const ready = await panelHealthy(origin);
+  return {
+    dir,
+    taskState,
+    origin,
+    ready,
+    problem: ready ? "" : problemFromLog(logText),
+  };
+}
+
+export async function linkBin(root) {
+  const binDir = path.join(root, "node_modules", ".bin");
+  await mkdir(binDir, { recursive: true });
+  await writeFile(
+    path.join(binDir, "cloud-panel.cmd"),
+    '@ECHO off\r\nnode "%~dp0\\..\\..\\bin\\naviyra.mjs" %*\r\n',
+  );
+  await writeFile(
+    path.join(binDir, "cloud-panel.ps1"),
+    [
+      "$node = (Get-Command node -ErrorAction Stop).Source",
+      '& $node (Join-Path $PSScriptRoot "..\\..\\bin\\naviyra.mjs") @args',
+      "exit $LASTEXITCODE",
+      "",
+    ].join("\n"),
+  );
+}
+
+export async function execute(command, options = {}) {
+  const located = await locate(options);
+  if (command === "status") {
+    console.log(formatStatus(await readStatus(located.dir, located.state)));
+    return;
+  }
+  if (!located.dir)
+    throw Error("Naviyra is not installed. From an empty folder you own, run: npx @naviyra/cloud-panel");
+  const root = located.dir;
+  const run = options.runPowerShell;
+  if (command === "stop") {
+    const stopped = await stopBootTask({ root, runPowerShell: run });
+    if (!stopped.ok) throw Error(stopped.message || "Could not stop Naviyra.");
+    console.log("Naviyra is stopped.");
+    return;
+  }
+  if (command === "start") {
+    const started = await startBootTask(run);
+    if (!started.ok) throw Error(started.message || "Could not start Naviyra.");
+    console.log("Naviyra is starting. Check it with: npx @naviyra/cloud-panel status");
+    return;
+  }
+  if (command === "open") {
+    const status = await readStatus(root, located.state);
+    if (!status.ready) {
+      console.log(formatStatus(status));
+      throw Error("The panel is not ready to open yet.");
+    }
+    openBrowser(status.origin);
+    console.log(`Opened ${status.origin}`);
+    return;
+  }
+  if (command === "uninstall") {
+    const removed = await removeBootTask({ root, runPowerShell: run });
+    if (!removed.ok) throw Error(removed.message || "Could not remove the startup task.");
+    if (canRemoveInstall(root) && (await isPanel(root))) {
+      await rm(root, { recursive: true, force: true });
+      console.log(`Uninstalled Naviyra and removed ${root}`);
+      return;
+    }
+    console.log(`${removed.message} The install folder was left at ${root}`);
+    return;
+  }
+  if (command === "update") {
+    if (!options.source) throw Error("Cannot find the new Naviyra package to copy.");
+    if (path.resolve(options.source) === path.resolve(root))
+      throw Error("Run npx @naviyra/cloud-panel update so the newest package can replace this install.");
+    await options.copy(options.source, root);
+    await options.install(root);
+    await linkBin(root);
+    const started = await startBootTask(run);
+    if (!started.ok) throw Error(started.message || "Update copied, but Naviyra did not start.");
+    console.log(`Updated Naviyra in ${root}. Check it with: npx @naviyra/cloud-panel status`);
+    return;
+  }
+  throw Error(`Unknown command: ${command}`);
+}