mirror of
https://github.com/ZTatman/myst.git
synced 2026-11-20 20:07:59 +00:00
* Add CLI scaffold and config generators * Add PR stacking note to README * refactor: write embargo init command myself for clarity * refactor: rename Myst and narrow CLI setup flow * Update Phase 1 plans with finalized design decisions Major updates: - Add authentication model (Forgejo sessions for identity, PAT for data access) - Add link types (private email-verified, public time-expired) - Add link creation rules (owner-only) - Add Docker/deployment guidance (Dockerfile only, Dokploy handles orchestration) - Add database model (separate DBs on same PostgreSQL instance) - Add viewer baseline and user dashboard sections - Add SMTP configuration via post-login setup page Key architectural decisions: - Users log in via Forgejo session, no separate Myst login - Service account PAT used for API calls, not user identity - Private links require email verification code - Public links are time-expired for job applications - Myst provides Dockerfile, operators use Dokploy for deployment * Complete CLI init skeleton with CodeRabbit review fixes CLI changes: - Narrow init to Myst-only config generation (no Forgejo provisioning) - Add yoctocolors styling to CLI output - Simplify URL validation logic (remove dead code) - Fix typo in env.ts comment - Remove docker-compose generator (out of scope) - Move example config from src/ to packages/cli/examples/ - Fix CommandName type to match implemented commands only Config changes: - Remove databaseUrl from myst.config.json (DB is .env-only) - Update example config with current fields - Reject non-HTTP schemes before auto-prepending https:// - Use localhost -> 127.0.0.1 in Caddy/Nginx examples - Add file existence checks and 0o600 permissions Build passes after all changes. * docs: rewrite README with Myst branding and architecture - Add Mermaid architecture diagram - Document two link types (private/public) - Explain authentication model - Provide setup steps - Add example configuration - Include Phase 1 completion checklist * fix: correct Mermaid diagram syntax * refactor: streamline README per create-readme skill guidelines - Use blockquote for tagline - Simplify architecture diagram labels - Remove redundant sections (Setup, Example Config, License) - Keep checklist as primary tracking mechanism - Use tables for features and auth - Reduce verbosity throughout * cli: add preflight check and version flag - Add preflightWriteTargets to check file existence before writing - Remove stub commands (start, stop, status) from help text - Add --version flag support - Sequential file writes with preflight check * cleanup: remove empty command stubs and test config - Remove start.ts, stop.ts, status.ts (not implemented yet) - Remove myst.config.json (generated during testing) * cleanup: remove app-ini generator (Forgejo provisioning out of scope) * cleanup: remove empty unused utility files (docker.ts, flags.ts, init.ts) * cleanup: remove examples.ts (examples belong in docs, not deployed code)
41 lines
1.3 KiB
TypeScript
41 lines
1.3 KiB
TypeScript
interface EnvOptions {
|
|
adminUrl: string;
|
|
databaseUrl: string;
|
|
forgejoBaseUrl: string;
|
|
forgejoPat: string;
|
|
forgejoServiceAccountUsername: string;
|
|
grantTokenSecret: string;
|
|
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
|
|
}
|
|
|
|
/**
|
|
* Generates an .env file for Myst with the given options.
|
|
* @param options - The options for generating the .env file.
|
|
* @returns {string} The .env file formatted as a string.
|
|
*/
|
|
export function generateEnvFile(options: EnvOptions): string {
|
|
return `# Public URL used for share links.
|
|
MYST_PUBLIC_URL=${escapeEnvValue(options.publicUrl)}
|
|
|
|
# Private operator URL for the admin UI. Protect this upstream.
|
|
MYST_ADMIN_URL=${escapeEnvValue(options.adminUrl)}
|
|
|
|
# Myst's own Postgres database.
|
|
DATABASE_URL=${escapeEnvValue(options.databaseUrl)}
|
|
|
|
# Existing Forgejo instance and operator-created service account token.
|
|
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=${escapeEnvValue(options.grantTokenSecret)}
|
|
`;
|
|
}
|