diff --git a/packages/cli/examples/myst.config.example.json b/packages/cli/examples/myst.config.example.json new file mode 100644 index 0000000..f0c680e --- /dev/null +++ b/packages/cli/examples/myst.config.example.json @@ -0,0 +1,6 @@ +{ + "adminUrl": "https://admin.example.com", + "forgejoBaseUrl": "https://git.example.com", + "forgejoServiceAccountUsername": "myst-bot", + "publicUrl": "https://share.example.com" +} diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts index 0b5959b..ea24490 100644 --- a/packages/cli/src/commands/index.ts +++ b/packages/cli/src/commands/index.ts @@ -5,36 +5,32 @@ import * as c from "yoctocolors"; import { generateEnvFile } from "../generators/env.js"; import { generateSecret } from "../utils/crypto.js"; -interface MystConfig { - adminUrl: string; - databaseUrl: string; - forgejoBaseUrl: string; - forgejoServiceAccountUsername: string; - publicUrl: string; -} - +/** + * Normalizes a URL to use https:// if no protocol is specified. + * @param value - The URL to normalize. + * @returns The normalized URL. + */ function normalizeHttpUrl(value: string): string { const trimmed = value.trim(); - if (/^https?:\/\//i.test(trimmed)) { - return trimmed; + const hasProtocol = /^[a-z]+:\/\//i.test(trimmed); + const isNotHttp = !/^https?:\/\//i.test(trimmed); + + if (hasProtocol && isNotHttp) { + throw new Error("URLs must use http:// or https://"); } - return `https://${trimmed}`; + return hasProtocol ? trimmed : `https://${trimmed}`; } function validateHttpUrlOrHost( value: string | undefined, label: string, ): string | undefined { - if (!value?.trim()) { - return `${label} is required`; - } + if (!value?.trim()) return `${label} is required`; try { - const url = new URL(normalizeHttpUrl(value)); - if (url.protocol !== "http:" && url.protocol !== "https:") { - return `${label} must start with http:// or https://`; - } + const normalized = normalizeHttpUrl(value); + const url = new URL(normalized); if (!url.hostname) { return `${label} must include a domain or hostname`; @@ -63,13 +59,29 @@ function validatePostgresUrl(value: string | undefined): string | undefined { return undefined; } -function generateConfigFile(config: MystConfig): string { - return `${JSON.stringify(config, null, 2)}\n`; +async function writePrivateFile( + filePath: string, + content: string, +): Promise { + try { + await fs.writeFile(filePath, content, { + encoding: "utf8", + flag: "wx", + mode: 0o600, + }); + } catch (e) { + const error = e as NodeJS.ErrnoException; + if (error.code === "EEXIST") { + throw new Error( + `Error: the file '${c.underline(path.basename(filePath))}' already exists in directory ${c.underline(path.dirname(filePath))}`, + ); + } + throw error; // throw any other errors back if not EEXIST code + } } export async function initCommand(_args: string[]): Promise { p.intro(c.bold("myst init")); - p.note( [ `${c.bold("Run this in the directory where you plan to deploy Myst.")}`, @@ -140,7 +152,7 @@ export async function initCommand(_args: string[]): Promise { }, { onCancel: () => { - process.stderr.write("\nOperation cancelled."); + p.cancel("\nOperation cancelled."); process.exit(0); }, }, @@ -148,7 +160,6 @@ export async function initCommand(_args: string[]): Promise { const s = p.spinner(); s.start("Generating config files"); - const publicUrl = normalizeHttpUrl(answers.publicUrl); const adminUrl = normalizeHttpUrl(answers.adminUrl); const forgejoBaseUrl = normalizeHttpUrl(answers.forgejoBaseUrl); @@ -162,23 +173,35 @@ export async function initCommand(_args: string[]): Promise { grantTokenSecret, publicUrl, }); - const configContent = generateConfigFile({ - adminUrl, - databaseUrl: answers.databaseUrl, - forgejoBaseUrl, - forgejoServiceAccountUsername: answers.forgejoServiceAccountUsername, - publicUrl, - }); + const configContent = JSON.stringify( + { + adminUrl, + forgejoBaseUrl, + forgejoServiceAccountUsername: answers.forgejoServiceAccountUsername, + publicUrl, + }, + null, + 2, + ); const outDir = process.cwd(); - await Promise.all([ - fs.writeFile(path.join(outDir, ".env"), envContent, "utf8"), - fs.writeFile( - path.join(outDir, "myst.config.json"), - configContent, - "utf8", - ), - ]); + const envPath = path.join(outDir, ".env"); + const configPath = path.join(outDir, "myst.config.json"); + + try { + await Promise.all([ + writePrivateFile(envPath, envContent), + writePrivateFile(configPath, configContent), + ]); + } catch (e) { + s.stop(); + p.cancel( + e instanceof Error + ? e.message + : `Failed to write config files to ${outDir}`, + ); + return; + } s.stop("Config files generated"); @@ -193,19 +216,14 @@ export async function initCommand(_args: string[]): Promise { `${c.bold("Private admin URL:")} ${c.cyan(adminUrl)}`, `${c.bold("Forgejo base URL:")} ${c.cyan(forgejoBaseUrl)}`, `${c.bold("Forgejo service account:")} ${c.green(answers.forgejoServiceAccountUsername)}`, - `${c.bold("Tip:")} entering a bare hostname defaults to ${c.bold("https://")}.`, + "", `${c.bold("Admin URL reminder:")} protect this upstream with Tailscale, VPN, Cloudflare Access, or reverse-proxy auth.`, - `${c.bold("PAT setup docs:")} ${c.cyan("https://forgejo.org/docs/latest/user/api-usage/")}`, - `${c.bold("PAT scope docs:")} ${c.cyan("https://forgejo.org/docs/latest/user/token-scope/")}`, - `${c.bold("Next commands:")} ${c.green("myst forgejo bootstrap")} then ${c.green("myst doctor")}`, ].join("\n"), c.yellow("Next steps"), ); - p.outro( - c.green("Done. Deploy Myst, then run forgejo bootstrap and doctor."), + c.green( + "Done. Deploy Myst, then run forgejo bootstrap and doctor commands to verify setup.", + ), ); } -export async function startCommand(...args: any[]): Promise {} -export async function stopCommand(...args: any[]): Promise {} -export async function statusCommand(...args: any[]): Promise {} diff --git a/packages/cli/src/docker-compose.yml b/packages/cli/src/docker-compose.yml deleted file mode 100644 index 5b9c556..0000000 --- a/packages/cli/src/docker-compose.yml +++ /dev/null @@ -1,49 +0,0 @@ -services: - postgres: - image: postgres:16 - restart: unless-stopped - env_file: - - .env - volumes: - - postgres-data:/var/lib/postgresql/data - networks: - - private - - forgejo: - image: codeberg.org/forgejo/forgejo:11.0.11 - restart: unless-stopped - env_file: - - .env - depends_on: - - postgres - ports: - - "3000:3000" - - "2222:22" - volumes: - - forgejo-data:/data - networks: - - private - - myst: - image: node:22-alpine - restart: unless-stopped - env_file: - - .env - depends_on: - - forgejo - ports: - - "4000:4000" - environment: - MYST_DOMAIN: myst.example.com - networks: - - private - - public - -networks: - private: - internal: true - public: - -volumes: - postgres-data: - forgejo-data: diff --git a/packages/cli/src/generators/docker-compose.ts b/packages/cli/src/generators/docker-compose.ts deleted file mode 100644 index 86b6759..0000000 --- a/packages/cli/src/generators/docker-compose.ts +++ /dev/null @@ -1,55 +0,0 @@ -export function generateDockerCompose({ domain }: { domain: string }): string { - return `services: - postgres: - container_name: postgres - image: postgres:16 - restart: always - env_file: - - .env - volumes: - - postgres:/var/lib/postgresql/data - networks: - - private - - forgejo: - container_name: forgejo - image: codeberg.org/forgejo/forgejo:14 - restart: always - env_file: - - .env - depends_on: - - postgres - ports: - - "3000:3000" - - "2222:22" - volumes: - - forgejo:/data - networks: - - private - - myst: - container_name: myst - image: node:22-alpine - restart: always - env_file: - - .env - depends_on: - - forgejo - ports: - - "4000:4000" - environment: - MYST_DOMAIN: ${domain} - networks: - - private - - public - -networks: - private: - internal: true - public: - -volumes: - postgres: - forgejo: -`; -} diff --git a/packages/cli/src/generators/env.ts b/packages/cli/src/generators/env.ts index 9b237b4..6a8b050 100644 --- a/packages/cli/src/generators/env.ts +++ b/packages/cli/src/generators/env.ts @@ -8,22 +8,29 @@ interface EnvOptions { publicUrl: string; } +function escapeEnvValue(value: string): string { + return `"${value + .replace(/\\/g, "\\\\") // Escape backslashes + .replace(/"/g, '\\"') // Escape double quotes + .replace(/\r?\n/g, "\\n")}"`; // Escape newlines +} + export function generateEnvFile(options: EnvOptions): string { return `# Public URL used for share links. -MYST_PUBLIC_URL=${options.publicUrl} +MYST_PUBLIC_URL=${escapeEnvValue(options.publicUrl)} # Private operator URL for the admin UI. Protect this upstream. -MYST_ADMIN_URL=${options.adminUrl} +MYST_ADMIN_URL=${escapeEnvValue(options.adminUrl)} # Myst's own Postgres database. -DATABASE_URL=${options.databaseUrl} +DATABASE_URL=${escapeEnvValue(options.databaseUrl)} # Existing Forgejo instance and operator-created service account token. -FORGEJO_BASE_URL=${options.forgejoBaseUrl} -FORGEJO_SERVICE_ACCOUNT_USERNAME=${options.forgejoServiceAccountUsername} -FORGEJO_PAT=${options.forgejoPat} +FORGEJO_BASE_URL=${escapeEnvValue(options.forgejoBaseUrl)} +FORGEJO_SERVICE_ACCOUNT_USERNAME=${escapeEnvValue(options.forgejoServiceAccountUsername)} +FORGEJO_PAT=${escapeEnvValue(options.forgejoPat)} # Secret used to sign or derive grant tokens. -GRANT_TOKEN_SECRET=${options.grantTokenSecret} +GRANT_TOKEN_SECRET=${escapeEnvValue(options.grantTokenSecret)} `; } diff --git a/packages/cli/src/generators/examples.ts b/packages/cli/src/generators/examples.ts index 5db02fb..e3935df 100644 --- a/packages/cli/src/generators/examples.ts +++ b/packages/cli/src/generators/examples.ts @@ -1,7 +1,7 @@ export function generateExampleCaddyfile(domain: string): string { return `${domain} { - reverse_proxy /_myst/* localhost:4000 - reverse_proxy localhost:3000 + reverse_proxy /_myst/* 127.0.0.1:4000 + reverse_proxy 127.0.0.1:3000 } `; } diff --git a/packages/cli/src/generators/index.ts b/packages/cli/src/generators/index.ts index 65ade65..82e401c 100644 --- a/packages/cli/src/generators/index.ts +++ b/packages/cli/src/generators/index.ts @@ -1,5 +1,3 @@ export * from "./app-ini.js"; -export * from "./docker-compose.js"; export * from "./env.js"; export * from "./examples.js"; - diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts index 86cdb57..2aa5616 100644 --- a/packages/cli/src/index.ts +++ b/packages/cli/src/index.ts @@ -4,16 +4,13 @@ import pkg from "../package.json" with { type: "json" }; import { initCommand, - startCommand, - statusCommand, - stopCommand, } from "./commands/index.js"; const PADDING = 4; const INDENT = " "; const USAGE = "myst [options/flags] [arguments]"; -type CommandName = "init" | "start" | "status" | "stop"; +type CommandName = "init"; interface Option { name: CommandName | string | string[]; @@ -92,9 +89,6 @@ async function main(): Promise { const knownCommands: Record Promise> = { init: initCommand, - start: startCommand, - status: statusCommand, - stop: stopCommand, }; const isKnownCommand = (cmd: string): cmd is CommandName => @@ -106,7 +100,13 @@ async function main(): Promise { return; } - await knownCommands[command](options); + try { + await knownCommands[command](options); + } catch (error) { + const message = error instanceof Error ? error.message : "Unknown error"; + process.stderr.write(`${c.red("Error:")} ${message}\n`); + process.exitCode = 1; + } } await main(); diff --git a/packages/cli/src/myst.config.json b/packages/cli/src/myst.config.json index c048b1f..9ae7b23 100644 --- a/packages/cli/src/myst.config.json +++ b/packages/cli/src/myst.config.json @@ -1,7 +1,6 @@ { - "adminUrl": "https://admin.myshit.com", - "databaseUrl": "postgresql://myst:password@postgres.myshit.com:5432/myst", - "forgejoBaseUrl": "https://git.myshit.com", - "forgejoServiceAccountUsername": "myshit-bot", - "publicUrl": "https://werwr.werwer.werwre" -} + "adminUrl": "https://sdfsdf", + "forgejoBaseUrl": "https://sdfsdf", + "forgejoServiceAccountUsername": "sdfsdf", + "publicUrl": "https://asfsf" +} \ No newline at end of file