nodebbs 0.2.0 → 0.3.0-beta.0

package/dist/templates/dockerignore

@@ -0,0 +1,120 @@
+# ============================================
+# .dockerignore - Turborepo Monorepo
+# ============================================
+# 作用：优化 Docker 构建上下文
+# 原则：只把源码和必要文件打包进镜像
+#       构建缓存、依赖、日志、运行时数据等全部排除
+# ============================================
+
+# ========================
+# Node / pnpm 依赖
+# ========================
+# node_modules 会在 Docker 内重新安装
+node_modules
+# pnpm 全局存储目录
+.pnpm-store
+
+# ========================
+# Turborepo 缓存
+# ========================
+.turbo
+
+# ========================
+# 构建输出
+# ========================
+.next       # Next.js 构建目录
+dist       # Fastify / TS 构建目录
+build
+out        # Next.js 静态导出目录
+coverage   # 测试覆盖率报告
+
+# ========================
+# 日志文件
+# ========================
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# ========================
+# 环境变量文件（运行时通过 docker-compose 注入）
+# ========================
+.env*           # 排除所有本地环境文件
+!.env.example   # 保留示例文件
+
+# ========================
+# 测试相关文件
+# ========================
+__tests__       # 单元测试目录
+*.test.*        # 测试文件
+*.spec.*        # 测试文件
+.nyc_output     # 测试覆盖率缓存
+
+# ========================
+# 版本控制相关
+# ========================
+.git
+.gitignore
+.gitattributes
+
+# ========================
+# 编辑器 / 操作系统临时文件
+# ========================
+.vscode
+.idea
+.DS_Store
+Thumbs.db
+desktop.ini
+*.swp
+*.swo
+*.swn
+.history
+
+# ========================
+# CI/CD 和文档
+# ========================
+.github
+.gitlab-ci.yml
+.travis.yml
+.circleci
+docs
+*.md
+!README.md       # 保留 README
+
+# ========================
+# 缓存 / 临时文件
+# ========================
+.cache
+tmp
+temp
+.temp
+*.tsbuildinfo    # TypeScript 构建缓存
+
+# ========================
+# 运行时数据（使用 Docker 卷挂载）
+# ========================
+apps/api/uploads/         # 用户上传文件
+
+# ========================
+# 本地数据库文件（开发用）
+# ========================
+*.db
+*.sqlite
+
+# ========================
+# 数据库 dump（非 migration）
+# ========================
+dump/
+backups/
+
+# ========================
+# 进程管理器
+# ========================
+.pm2
+
+# ========================
+# docker-compose 文件（不打包进镜像）
+# ========================
+docker-compose*.yml

package/dist/templates/env

@@ -44,18 +44,14 @@ APP_URL=http://localhost:3100
 # ========================================
 WEB_PORT=3100
 
-# API 地址（公网访问地址）
-# 使用 docker 部署必须指定 IP 或域名（避免SSR跨容器通信问题）
-# 开发环境: http://192.168.0.100:7100
-# 生产环境: https://api.yourdomain.com
-NEXT_PUBLIC_API_URL=http://192.168.0.100:7100
-
-# 应用 URL（公网访问地址）
-# 开发环境: http://localhost:3100
-# 生产环境: https://yourdomain.com
-NEXT_PUBLIC_APP_URL=http://localhost:3100
+# Web 服务内部访问 API 的地址
+# 通常保持默认 http://api:7100 即可，走 Docker 内部网络
+SERVER_API_URL=http://api:7100
 
 # ========================================
 # 时区配置
 # ========================================
 TZ=Asia/Shanghai
+
+API_IMAGE=ghcr.io/aiprojecthub/nodebbs-api:latest
+WEB_IMAGE=ghcr.io/aiprojecthub/nodebbs-web:latest

package/dist/utils/docker.js

@@ -4,7 +4,17 @@ import path from 'node:path';
 import { exists } from 'node:fs';
 import { promisify } from 'node:util';
 import { getTemplateDir, getTemplatePath } from './template.js';
+import { getDeploymentMode } from './selection.js';
 const fileExists = promisify(exists);
+async function getDockerEnv() {
+    const mode = await getDeploymentMode();
+    const envs = { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' };
+    if (mode === 'source') {
+        envs['API_IMAGE'] = 'nodebbs-api:local';
+        envs['WEB_IMAGE'] = 'nodebbs-web:local';
+    }
+    return envs;
+}
 /**
  * 获取 Docker Compose 文件路径配置
  *
@@ -18,21 +28,46 @@ const fileExists = promisify(exists);
 export async function getComposeFiles(env) {
     const workDir = process.cwd();
     let isBuiltIn = false;
+    // 1. 确定 Base 文件
     // 检查当前目录是否存在 docker-compose.yml
     let baseFile = path.join(workDir, 'docker-compose.yml');
-    let templateDir = workDir;
+    const templateDir = getTemplateDir();
     if (!await fileExists(baseFile)) {
         // 使用内置模板
         isBuiltIn = true;
-        templateDir = getTemplateDir();
         baseFile = getTemplatePath('docker-compose.yml');
     }
     const files = [baseFile];
-    if (env === 'production') {
-        files.push(path.join(templateDir, 'docker-compose.prod.yml'));
+    // 2. 确定环境 Override 文件 (production / lowmem)
+    if (env === 'production' || env === 'lowmem') {
+        const fileName = `docker-compose.${env}.yml`;
+        const localOverride = path.join(workDir, fileName);
+        const templateOverride = path.join(templateDir, fileName);
+        if (await fileExists(localOverride)) {
+            files.push(localOverride);
+        }
+        else if (await fileExists(templateOverride)) {
+            // 即使 Base 是本地的，如果本地没有 override，我们也尝试用内置的 override 补全吗？
+            // 通常为了混用方便，是可以的。但如果 Base 是本地，通常期望全套本地。
+            // 策略：如果 Base 是内置，则一定用内置 Override。如果 Base 是本地，仅当本地也有 Override 时才用？
+            // 不，为了方便用户只覆盖 Base 而复用我们的资源配置，如果本地没 Override，可以用内置的。
+            files.push(templateOverride);
+        }
     }
-    else if (env === 'lowmem') {
-        files.push(path.join(templateDir, 'docker-compose.lowmem.yml'));
+    // 3. 确定构建配置 (仅源码模式)
+    const mode = await getDeploymentMode();
+    if (mode === 'source') {
+        const buildFileName = 'docker-compose.build.yml';
+        const localBuild = path.join(workDir, buildFileName);
+        const templateBuild = path.join(templateDir, buildFileName);
+        if (await fileExists(localBuild)) {
+            files.push(localBuild);
+        }
+        else if (isBuiltIn && await fileExists(templateBuild)) {
+            // 只有在使用内置 Base 时，才默认加载内置 Build。
+            // 如果用户自定义了 Base，通常他们会自己把 build 写进去，或者自己提供 build.yml
+            files.push(templateBuild);
+        }
     }
     return { files, isBuiltIn };
 }
@@ -68,16 +103,13 @@ export async function runCompose(files, args, isBuiltIn = false) {
     const composeArgs = files.flatMap(f => ['-f', f]);
     if (isBuiltIn) {
         composeArgs.push('--project-directory', process.cwd());
-        // 将 INIT_DB_PATH 设置为内置 sql 文件
-        const templateDir = path.dirname(files[0]);
-        process.env.INIT_DB_PATH = path.join(templateDir, 'init-db.sql');
     }
     composeArgs.push(...args);
     // 使用 stdio: 'inherit' 实时显示输出
     // 设置 COMPOSE_LOG_LEVEL=ERROR 抑制变量未设置的警告
     await execa('docker', ['compose', ...composeArgs], {
         stdio: 'inherit',
-        env: { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' }
+        env: await getDockerEnv()
     });
 }
 /**
@@ -99,7 +131,7 @@ export async function execCompose(files, service, command, isBuiltIn = false) {
     composeArgs.push('exec', service, ...command);
     await execa('docker', ['compose', ...composeArgs], {
         stdio: 'inherit',
-        env: { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' }
+        env: await getDockerEnv()
     });
 }
 /**
@@ -121,10 +153,11 @@ export async function waitForHealth(files, isBuiltIn = false) {
         composeArgs.push('--project-directory', process.cwd());
     }
     const pgArgs = [...composeArgs, 'exec', '-T', 'postgres', 'pg_isready', '-U', 'postgres'];
+    const envs = await getDockerEnv();
     let retries = 15;
     while (retries > 0) {
         try {
-            await execa('docker', ['compose', ...pgArgs]);
+            await execa('docker', ['compose', ...pgArgs], { env: envs });
             logger.success('PostgreSQL 已就绪');
             break;
         }

package/dist/utils/env.d.ts

@@ -1,2 +1,7 @@
+export declare function getEnvValue(key: string): Promise<string | undefined>;
+export declare function setEnvValue(key: string, value: string): Promise<void>;
+export declare function unsetEnvValue(key: string): Promise<void>;
 export declare function initEnv(): Promise<void>;
+export declare function initDockerIgnore(): Promise<void>;
+export declare function initImageEnv(): Promise<void>;
 export declare function checkEnv(envType: 'production' | 'lowmem' | 'basic'): Promise<void>;

package/dist/utils/env.js

@@ -6,12 +6,52 @@ import { confirm } from '@inquirer/prompts';
 import dotenv from 'dotenv';
 import { getTemplatePath } from './template.js';
 const fileExists = promisify(exists);
-export async function initEnv() {
+export async function getEnvValue(key) {
+    if (!await fileExists('.env'))
+        return undefined;
+    try {
+        const content = await fs.readFile('.env', 'utf-8');
+        const config = dotenv.parse(content);
+        return config[key];
+    }
+    catch (e) {
+        return undefined;
+    }
+}
+export async function setEnvValue(key, value) {
+    let content = '';
     if (await fileExists('.env')) {
-        logger.info('.env 文件已存在，跳过创建');
+        content = await fs.readFile('.env', 'utf-8');
+    }
+    const regex = new RegExp(`^${key}=.*`, 'm');
+    if (regex.test(content)) {
+        content = content.replace(regex, `${key}=${value}`);
+    }
+    else {
+        if (content && !content.endsWith('\n'))
+            content += '\n';
+        content += `${key}=${value}\n`;
+    }
+    await fs.writeFile('.env', content, 'utf-8');
+}
+export async function unsetEnvValue(key) {
+    if (!await fileExists('.env'))
         return;
+    let content = await fs.readFile('.env', 'utf-8');
+    const regex = new RegExp(`^${key}=.*\n?`, 'm');
+    if (regex.test(content)) {
+        content = content.replace(regex, '');
+        await fs.writeFile('.env', content, 'utf-8');
     }
-    logger.info('正在创建 .env 文件...');
+}
+export async function initEnv() {
+    const currentEnv = await fileExists('.env') ? dotenv.parse(await fs.readFile('.env', 'utf-8')) : {};
+    // 如果已存在关键配置（如 POSTGRES_PASSWORD），则视为无需初始化
+    if (currentEnv.POSTGRES_PASSWORD) {
+        logger.info('.env 文件已配置，跳过创建');
+        return;
+    }
+    logger.info('正在创建/更新 .env 文件...');
     // 检查模板文件
     let templateContent = '';
     let sourceFile = '';
@@ -54,14 +94,10 @@ export async function initEnv() {
         message: '设置 API_PORT (后端端口):',
         default: '7100'
     });
-    const defaultApiUrl = `http://localhost:${apiPort}`;
-    const nextPublicApiUrl = await input({
-        message: '设置 NEXT_PUBLIC_API_URL (前端访问后端的地址):',
-        default: defaultApiUrl
-    });
+    const serverApiUrl = `http://api:${apiPort}`;
     const defaultAppUrl = `http://localhost:${webPort}`;
-    const nextPublicAppUrl = await input({
-        message: '设置 NEXT_PUBLIC_APP_URL (应用访问地址):',
+    const appUrl = await input({
+        message: '设置 APP_URL (应用访问地址):',
         default: defaultAppUrl
     });
     const corsOrigin = await input({
@@ -75,8 +111,8 @@ export async function initEnv() {
     console.log(`JWT_SECRET:        ${jwtSecret.substring(0, 3)}******`);
     console.log(`WEB_PORT:          ${webPort}`);
     console.log(`API_PORT:          ${apiPort}`);
-    console.log(`NEXT_PUBLIC_API_URL: ${nextPublicApiUrl}`);
-    console.log(`NEXT_PUBLIC_APP_URL: ${nextPublicAppUrl}`);
+    console.log(`APP_URL:             ${appUrl}`);
+    console.log(`SERVER_API_URL:      ${serverApiUrl}`);
     console.log(`CORS_ORIGIN:       ${corsOrigin}`);
     console.log('==========================================\n');
     // 3. 确认生成
@@ -98,11 +134,9 @@ export async function initEnv() {
         'JWT_SECRET': jwtSecret,
         'WEB_PORT': webPort,
         'API_PORT': apiPort,
-        'NEXT_PUBLIC_API_URL': nextPublicApiUrl,
-        'NEXT_PUBLIC_APP_URL': nextPublicAppUrl,
+        'SERVER_API_URL': serverApiUrl,
+        'APP_URL': appUrl,
         'CORS_ORIGIN': corsOrigin,
-        // 如果 API_PORT 变了，模板里可能还需要联动修改 APP_URL 用于 OAuth 回调，这里简单处理
-        'APP_URL': nextPublicAppUrl
     };
     // 针对每个 Key 进行替换。
     // 策略：查找 `KEY=...` 并替换为 `KEY=newValue`
@@ -118,6 +152,11 @@ export async function initEnv() {
         }
     }
     // 5. 写入文件
+    // 如果原文件中有 DEPLOY_ENV 等其他配置，保留它们
+    // 简单策略：如果 currentEnv 有 DEPLOY_ENV，确保 newEnv 里也有
+    if (currentEnv.DEPLOY_ENV && !newEnv.includes('DEPLOY_ENV=')) {
+        newEnv += `\nDEPLOY_ENV=${currentEnv.DEPLOY_ENV}`;
+    }
     await fs.writeFile('.env', newEnv, 'utf-8');
     // isBuiltIn is not defined in the new logic, need to determine it
     // based on whether sourceFile was .env.docker.example or a template path
@@ -129,6 +168,41 @@ export async function initEnv() {
         logger.success(`已从 ${sourceFile} 复制并填充配置生成 .env`);
     }
 }
+export async function initDockerIgnore() {
+    if (await fileExists('.dockerignore')) {
+        return;
+    }
+    logger.info('正在创建 .dockerignore 文件...');
+    const templatePath = getTemplatePath('dockerignore');
+    const content = await fs.readFile(templatePath, 'utf-8');
+    await fs.writeFile('.dockerignore', content, 'utf-8');
+    logger.success('已创建 .dockerignore');
+}
+export async function initImageEnv() {
+    const { getDeploymentMode } = await import('./selection.js');
+    const mode = await getDeploymentMode();
+    logger.info(`当前部署模式: ${mode === 'image' ? '镜像部署' : '源码部署'}`);
+    if (mode !== 'image')
+        return;
+    logger.info('检测到镜像部署模式，请配置镜像地址...');
+    // initEnv 已经执行，尝试从 .env 获取默认值
+    const currentApiImage = await getEnvValue('API_IMAGE') || 'ghcr.io/aiprojecthub/nodebbs-api:latest';
+    const currentWebImage = await getEnvValue('WEB_IMAGE') || 'ghcr.io/aiprojecthub/nodebbs-web:latest';
+    let defaultVersion = 'latest';
+    const match = currentApiImage.match(/:([^:]+)$/);
+    if (match)
+        defaultVersion = match[1];
+    const { input } = await import('@inquirer/prompts');
+    const version = await input({
+        message: '设置镜像版本 (默认为 latest):',
+        default: defaultVersion
+    });
+    // 仅替换版本号部分
+    const newApiImage = currentApiImage.replace(/:[^:]+$/, `:${version}`);
+    const newWebImage = currentWebImage.replace(/:[^:]+$/, `:${version}`);
+    await setEnvValue('API_IMAGE', newApiImage);
+    await setEnvValue('WEB_IMAGE', newWebImage);
+}
 export async function checkEnv(envType) {
     logger.info('正在检查环境配置...');
     // 加载 .env

package/dist/utils/selection.d.ts

@@ -1,6 +1,8 @@
 export type EnvType = 'production' | 'lowmem' | 'basic';
+export type DeploymentMode = 'source' | 'image';
 export declare const EnvFlag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
 export declare function setStoredEnv(env: EnvType): Promise<void>;
+export declare function getDeploymentMode(): Promise<DeploymentMode>;
 export declare function clearStoredEnv(): Promise<void>;
 export declare function selectEnvironment(env?: string, options?: {
     prompt?: string;

package/dist/utils/selection.js

@@ -3,39 +3,37 @@ import { select } from '@inquirer/prompts';
 import { logger } from './logger.js';
 import fs from 'node:fs/promises';
 import path from 'node:path';
-const ENV_MARKER_FILE = '.env.lock';
+import { getEnvValue, setEnvValue, unsetEnvValue } from './env.js';
 export const EnvFlag = Flags.string({
     char: 'e',
     description: '部署环境 (production, lowmem, basic)',
     options: ['production', 'lowmem', 'basic'],
 });
 async function getStoredEnv() {
-    try {
-        const content = await fs.readFile(path.resolve(process.cwd(), ENV_MARKER_FILE), 'utf-8');
-        const env = content.trim();
-        if (['production', 'lowmem', 'basic'].includes(env)) {
-            return env;
-        }
+    const env = await getEnvValue('DEPLOY_ENV');
+    if (env && ['production', 'lowmem', 'basic'].includes(env)) {
+        return env;
     }
-    catch { }
     return null;
 }
 export async function setStoredEnv(env) {
+    await setEnvValue('DEPLOY_ENV', env);
+}
+export async function getDeploymentMode() {
+    // 自动检测：检查当前目录下是否有 package.json 且 name='nodebbs-forum'
     try {
-        await fs.writeFile(path.resolve(process.cwd(), ENV_MARKER_FILE), env, 'utf-8');
-    }
-    catch (error) {
-        logger.warning(`无法保存环境标记: ${error}`);
+        const packageJsonPath = path.resolve(process.cwd(), 'package.json');
+        const content = await fs.readFile(packageJsonPath, 'utf-8');
+        const pkg = JSON.parse(content);
+        if (pkg.name === 'nodebbs-forum') {
+            return 'source';
+        }
     }
+    catch { }
+    return 'image';
 }
 export async function clearStoredEnv() {
-    try {
-        const filepath = path.resolve(process.cwd(), ENV_MARKER_FILE);
-        await fs.rm(filepath, { force: true });
-    }
-    catch (error) {
-        logger.warning(`无法清除环境标记: ${error}`);
-    }
+    await unsetEnvValue('DEPLOY_ENV');
 }
 export async function selectEnvironment(env, options = {}) {
     if (env) {