nodebbs 0.0.8 → 0.1.0

package/dist/templates/docker-compose.lowmem.yml

@@ -1,19 +1,6 @@
-# 低内存环境 Docker Compose 覆盖配置
-# 适用于 1C1G 或 1C2G 的低配服务器
-# 使用方式: docker compose -f docker-compose.yml -f docker-compose.lowmem.yml up -d
-
 services:
   # PostgreSQL 数据库 - 低内存优化
   postgres:
-    restart: always
-    ports: []  # 不暴露端口到主机，只在内部网络访问
-    environment:
-      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
-    healthcheck:
-      interval: 30s
-      timeout: 10s
-      retries: 5
-      start_period: 40s
     deploy:
       resources:
         limits:
@@ -23,14 +10,13 @@ services:
           cpus: '0.1'
           memory: 128M
     logging:
-      driver: "json-file"
       options:
         max-size: "5m"
         max-file: "2"
 
   # Redis 缓存 - 低内存优化
   redis:
-    restart: always
+    # 降低内存限制
     command: >
       redis-server
       --requirepass ${REDIS_PASSWORD}
@@ -40,12 +26,6 @@ services:
       --maxmemory-policy allkeys-lru
       --save 900 1
       --save 300 10
-    ports: []  # 不暴露端口到主机
-    healthcheck:
-      interval: 30s
-      timeout: 10s
-      retries: 5
-      start_period: 20s
     deploy:
       resources:
         limits:
@@ -55,23 +35,15 @@ services:
           cpus: '0.1'
           memory: 64M
     logging:
-      driver: "json-file"
       options:
         max-size: "5m"
         max-file: "2"
 
   # API 服务 - 低内存优化
   api:
-    restart: always
     environment:
-      USER_CACHE_TTL: ${USER_CACHE_TTL:-300}
-      JWT_SECRET: ${JWT_SECRET}
-      CORS_ORIGIN: ${CORS_ORIGIN}
-      APP_URL: ${APP_URL}
-      # Node.js 内存限制
+      # 降低 Node.js 内存限制
       NODE_OPTIONS: "--max-old-space-size=384"
-    volumes:
-      - api_uploads:/app/apps/api/uploads
     healthcheck:
       start_period: 90s  # 低内存环境启动更慢
       interval: 60s
@@ -84,22 +56,13 @@ services:
           cpus: '0.2'
           memory: 256M
     logging:
-      driver: "json-file"
       options:
         max-size: "10m"
-        max-file: "3"
 
   # Web 前端服务 - 低内存优化
   web:
-    restart: always
-    build:
-      args:
-        NEXT_PUBLIC_API_URL: ${NEXT_PUBLIC_API_URL}
-        NEXT_PUBLIC_APP_URL: ${NEXT_PUBLIC_APP_URL}
     environment:
-      NEXT_PUBLIC_API_URL: ${NEXT_PUBLIC_API_URL}
-      NEXT_PUBLIC_APP_URL: ${NEXT_PUBLIC_APP_URL}
-      # Node.js 内存限制
+      # 降低 Node.js 内存限制
       NODE_OPTIONS: "--max-old-space-size=384"
     healthcheck:
       start_period: 90s  # 低内存环境启动更慢
@@ -113,14 +76,5 @@ services:
           cpus: '0.2'
           memory: 256M
     logging:
-      driver: "json-file"
       options:
         max-size: "10m"
-        max-file: "3"
-
-# 网络配置
-networks:
-  nodebbs-network:
-    ipam:
-      config:
-        - subnet: 172.28.0.0/16

package/dist/templates/docker-compose.yml

@@ -3,22 +3,37 @@ services:
   postgres:
     image: postgres:16-alpine
     container_name: nodebbs-postgres
-    restart: unless-stopped
+    restart: always
     environment:
       POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-postgres_password}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
       POSTGRES_DB: ${POSTGRES_DB:-nodebbs}
-      TZ: Asia/Shanghai
+      TZ: ${TZ:-Asia/Shanghai}
     volumes:
       - postgres_data:/var/lib/postgresql/data
-      - ${INIT_DB_PATH:-./scripts/init-db.sql}:/docker-entrypoint-initdb.d/init.sql:ro
-    ports:
-      - "${POSTGRES_PORT:-5432}:5432"
+    # 生产环境默认不暴露数据库端口到主机，只在 Docker 网络内部访问
+    # 如果需要外部访问 (如开发调试)，可以将下面两行取消注释
+    # ports:
+    #   - "${POSTGRES_PORT:-5432}:5432"
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U postgres"]
-      interval: 10s
-      timeout: 5s
+      interval: 30s
+      timeout: 10s
       retries: 5
+      start_period: 40s
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 512M
+        reservations:
+          cpus: '0.25'
+          memory: 256M
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "3"
     networks:
       - nodebbs-network
 
@@ -26,45 +41,62 @@ services:
   redis:
     image: redis:7-alpine
     container_name: nodebbs-redis
-    restart: unless-stopped
-    command: redis-server --requirepass ${REDIS_PASSWORD:-redis_password} --appendonly yes
-    environment:
-      TZ: Asia/Shanghai
+    restart: always
+    command: >
+      redis-server
+      --requirepass ${REDIS_PASSWORD}
+      --appendonly yes
+      --appendfsync everysec
+      --maxmemory 256mb
+      --maxmemory-policy allkeys-lru
     volumes:
       - redis_data:/data
-    ports:
-      - "${REDIS_PORT:-6379}:6379"
+    # 生产环境默认不暴露 Redis 端口到主机
+    # ports:
+    #   - "${REDIS_PORT:-6379}:6379"
     healthcheck:
       test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
-      interval: 10s
-      timeout: 5s
+      interval: 30s
+      timeout: 10s
       retries: 5
+      start_period: 20s
+    deploy:
+      resources:
+        limits:
+          cpus: '0.5'
+          memory: 256M
+        reservations:
+          cpus: '0.1'
+          memory: 128M
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10m"
+        max-file: "3"
     networks:
       - nodebbs-network
 
   # API 服务
   api:
-    build:
-      context: .  # 从 monorepo 根目录构建（turbo prune 需要完整的 workspace）
-      dockerfile: apps/api/Dockerfile
+    image: ${API_IMAGE:-ghcr.io/aiprojecthub/nodebbs-api:latest}
     container_name: nodebbs-api
-    restart: unless-stopped
+    restart: always
     environment:
       NODE_ENV: production
       APP_NAME: ${APP_NAME:-nodebbs}
       HOST: 0.0.0.0
       PORT: 7100
-      DATABASE_URL: postgres://postgres:${POSTGRES_PASSWORD:-postgres_password}@postgres:5432/${POSTGRES_DB:-nodebbs}
-      REDIS_URL: redis://default:${REDIS_PASSWORD:-redis_password}@redis:6379/0
-      USER_CACHE_TTL: ${USER_CACHE_TTL:-120}
-      JWT_SECRET: ${JWT_SECRET:-change-this-to-a-secure-random-string-in-production}
+      DATABASE_URL: postgres://postgres:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB:-nodebbs}
+      REDIS_URL: redis://default:${REDIS_PASSWORD}@redis:6379/0
+      USER_CACHE_TTL: ${USER_CACHE_TTL:-300}
+      JWT_SECRET: ${JWT_SECRET}
       JWT_ACCESS_TOKEN_EXPIRES_IN: ${JWT_ACCESS_TOKEN_EXPIRES_IN:-1y}
       CORS_ORIGIN: ${CORS_ORIGIN:-*}
       APP_URL: ${APP_URL:-http://localhost:3100}
-      TZ: Asia/Shanghai
+      TZ: ${TZ:-Asia/Shanghai}
+      NODE_OPTIONS: "--max-old-space-size=512"
     volumes:
       - api_uploads:/app/apps/api/uploads
-      - ./apps/api/src:/app/apps/api/src:ro
     ports:
       - "${API_PORT:-7100}:7100"
     depends_on:
@@ -78,26 +110,35 @@ services:
       timeout: 10s
       retries: 3
       start_period: 40s
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 768M
+        reservations:
+          cpus: '0.3'
+          memory: 384M
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "20m"
+        max-file: "5"
     networks:
       - nodebbs-network
 
   # Web 前端服务
   web:
-    build:
-      context: .  # 从 monorepo 根目录构建（turbo prune 需要完整的 workspace）
-      dockerfile: apps/web/Dockerfile
-      args:
-        NEXT_PUBLIC_API_URL: ${NEXT_PUBLIC_API_URL:-http://localhost:7100}
-        NEXT_PUBLIC_APP_URL: ${NEXT_PUBLIC_APP_URL:-http://localhost:3100}
+    image: ${WEB_IMAGE:-ghcr.io/aiprojecthub/nodebbs-web:latest}
     container_name: nodebbs-web
-    restart: unless-stopped
+    restart: always
     environment:
       NODE_ENV: production
       APP_NAME: ${APP_NAME:-nodebbs}
       PORT: 3100
       NEXT_PUBLIC_API_URL: ${NEXT_PUBLIC_API_URL:-http://localhost:7100}
       NEXT_PUBLIC_APP_URL: ${NEXT_PUBLIC_APP_URL:-http://localhost:3100}
-      TZ: Asia/Shanghai
+      TZ: ${TZ:-Asia/Shanghai}
+      NODE_OPTIONS: "--max-old-space-size=512"
     ports:
       - "${WEB_PORT:-3100}:3100"
     depends_on:
@@ -109,6 +150,19 @@ services:
       timeout: 10s
       retries: 3
       start_period: 40s
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 768M
+        reservations:
+          cpus: '0.3'
+          memory: 384M
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "20m"
+        max-file: "5"
     networks:
       - nodebbs-network
 
@@ -125,3 +179,6 @@ volumes:
 networks:
   nodebbs-network:
     driver: bridge
+    ipam:
+      config:
+        - subnet: 172.28.0.0/16

package/dist/templates/env

@@ -1,13 +1,27 @@
 # ========================================
-# NodeBBS Docker Compose 环境变量配置
+# NodeBBS 部署环境变量配置示例
 # ========================================
 
-# 应用名称
+# ========================================
+# 基础配置
+# ========================================
+# 应用名称（用于 Docker 容器前缀）
 APP_NAME=nodebbs
 
+# 部署环境 (prod, dev)
+NODE_ENV=production
+
+# 镜像配置
+# 默认为 GitHub Container Registry
+# 注意：使用 `nodebbs start` 时，可以选择版本 tag 覆盖此处的默认 latest tag
+# 如果需要固定特定版本 (如 v1.0)，请修改以下配置或在部署时输入对应的 tag
+API_IMAGE=ghcr.io/aiprojecthub/nodebbs-api:latest
+WEB_IMAGE=ghcr.io/aiprojecthub/nodebbs-web:latest
+
 # ========================================
 # 数据库配置
 # ========================================
+# 务必修改为强密码！
 POSTGRES_PASSWORD=your_secure_postgres_password_here
 POSTGRES_DB=nodebbs
 POSTGRES_PORT=5432
@@ -15,6 +29,7 @@ POSTGRES_PORT=5432
 # ========================================
 # Redis 配置
 # ========================================
+# 务必修改为强密码！
 REDIS_PASSWORD=your_secure_redis_password_here
 REDIS_PORT=6379
 
@@ -24,8 +39,8 @@ REDIS_PORT=6379
 API_PORT=7100
 
 # 用户缓存 TTL（秒）
-# 开发环境: 30-60, 生产环境: 120-300
-USER_CACHE_TTL=120
+# 生产环境建议: 120-300
+USER_CACHE_TTL=300
 
 # JWT 配置
 # 使用 `openssl rand -base64 32` 生成安全的密钥
@@ -37,6 +52,7 @@ JWT_ACCESS_TOKEN_EXPIRES_IN=1y
 CORS_ORIGIN=*
 
 # 应用 URL（OAuth 回调使用）
+# 生产环境请修改为公网域名
 APP_URL=http://localhost:3100
 
 # ========================================
@@ -45,17 +61,16 @@ 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
+# 生产环境请修改为公网域名，例如: https://api.yourdomain.com
+# 或者是 Nginx 反向代理后的地址，例如: https://yourdomain.com/api
+NEXT_PUBLIC_API_URL=http://localhost:7100
 
 # 应用 URL（公网访问地址）
-# 开发环境: http://localhost:3100
-# 生产环境: https://yourdomain.com
+# 生产环境请修改为公网域名，例如: https://yourdomain.com
 NEXT_PUBLIC_APP_URL=http://localhost:3100
 
 # ========================================
-# 时区配置
+# 其他配置
 # ========================================
+# 时区
 TZ=Asia/Shanghai

package/dist/utils/docker.d.ts

@@ -1,8 +1,55 @@
+/**
+ * 获取 Docker Compose 文件路径配置
+ *
+ * 自动检测当前目录是否存在 `docker-compose.yml`。
+ * - 如果存在，则优先使用项目根目录的配置。
+ * - 如果不存在，则使用 CLI 内置的模板文件。
+ *
+ * @param env - 运行环境 ('production' | 'lowmem')
+ * @returns 对象包含文件路径数组和是否使用内置模板的标志
+ */
 export declare function getComposeFiles(env: string): Promise<{
     files: string[];
     isBuiltIn: boolean;
 }>;
+/**
+ * 检查 Docker 环境是否可用
+ *
+ * 验证 `docker` 和 `docker compose` 命令是否已安装并能正常响应。
+ * 如果检查失败，会抛出错误并提示用户安装。
+ */
 export declare function checkDocker(): Promise<void>;
+/**
+ * 执行 Docker Compose 管理命令 (Lifecycle Commands)
+ *
+ * 用于执行如 `up`, `down`, `logs`, `build` 等管理整个服务堆栈的命令。
+ * 如果使用的是内置模板，会自动注入必要的环境变量（如数据库初始化脚本路径）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param args - 传递给 docker compose 的参数列表 (e.g. `['up', '-d']`)
+ * @param isBuiltIn - 是否使用内置模板 (决定是否注入额外环境变量)
+ */
 export declare function runCompose(files: string[], args: string[], isBuiltIn?: boolean): Promise<void>;
+/**
+ * 在容器内执行命令 (Exec)
+ *
+ * 相当于执行 `docker compose exec [service] [command]`。
+ * 用于在正在运行的容器中运行脚本或命令（例如数据库迁移、种子数据填充）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param service - 目标服务名称 (e.g. 'api', 'postgres')
+ * @param command - 要执行的命令数组 (e.g. `['npm', 'run', 'seed']`)
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export declare function execCompose(files: string[], service: string, command: string[], isBuiltIn?: boolean): Promise<void>;
+/**
+ * 等待服务健康检查通过
+ *
+ * 轮询关键服务 (PostgreSQL, Redis, API) 直到它们准备就绪或超时。
+ * - PostgreSQL: 使用 `pg_isready` 检查
+ * - Redis & API: 使用简单的延时等待 (后续可优化为端口/API探测)
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export declare function waitForHealth(files: string[], isBuiltIn?: boolean): Promise<void>;

package/dist/utils/docker.js

@@ -5,6 +5,16 @@ import { exists } from 'node:fs';
 import { promisify } from 'node:util';
 import { getTemplateDir, getTemplatePath } from './template.js';
 const fileExists = promisify(exists);
+/**
+ * 获取 Docker Compose 文件路径配置
+ *
+ * 自动检测当前目录是否存在 `docker-compose.yml`。
+ * - 如果存在，则优先使用项目根目录的配置。
+ * - 如果不存在，则使用 CLI 内置的模板文件。
+ *
+ * @param env - 运行环境 ('production' | 'lowmem')
+ * @returns 对象包含文件路径数组和是否使用内置模板的标志
+ */
 export async function getComposeFiles(env) {
     const workDir = process.cwd();
     let isBuiltIn = false;
@@ -19,13 +29,19 @@ export async function getComposeFiles(env) {
     }
     const files = [baseFile];
     if (env === 'production') {
-        files.push(path.join(templateDir, 'docker-compose.prod.yml'));
+        // Production now uses the default file (merged config)
     }
     else if (env === 'lowmem') {
         files.push(path.join(templateDir, 'docker-compose.lowmem.yml'));
     }
     return { files, isBuiltIn };
 }
+/**
+ * 检查 Docker 环境是否可用
+ *
+ * 验证 `docker` 和 `docker compose` 命令是否已安装并能正常响应。
+ * 如果检查失败，会抛出错误并提示用户安装。
+ */
 export async function checkDocker() {
     logger.info('正在检查 Docker 环境...');
     try {
@@ -38,26 +54,61 @@ export async function checkDocker() {
         throw error;
     }
 }
+/**
+ * 执行 Docker Compose 管理命令 (Lifecycle Commands)
+ *
+ * 用于执行如 `up`, `down`, `logs`, `build` 等管理整个服务堆栈的命令。
+ * 如果使用的是内置模板，会自动注入必要的环境变量（如数据库初始化脚本路径）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param args - 传递给 docker compose 的参数列表 (e.g. `['up', '-d']`)
+ * @param isBuiltIn - 是否使用内置模板 (决定是否注入额外环境变量)
+ */
 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' 实时显示输出
-    await execa('docker', ['compose', ...composeArgs], { stdio: 'inherit' });
+    // 设置 COMPOSE_LOG_LEVEL=ERROR 抑制变量未设置的警告
+    await execa('docker', ['compose', ...composeArgs], {
+        stdio: 'inherit',
+        env: { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' }
+    });
 }
+/**
+ * 在容器内执行命令 (Exec)
+ *
+ * 相当于执行 `docker compose exec [service] [command]`。
+ * 用于在正在运行的容器中运行脚本或命令（例如数据库迁移、种子数据填充）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param service - 目标服务名称 (e.g. 'api', 'postgres')
+ * @param command - 要执行的命令数组 (e.g. `['npm', 'run', 'seed']`)
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export async function execCompose(files, service, command, isBuiltIn = false) {
     const composeArgs = files.flatMap(f => ['-f', f]);
     if (isBuiltIn) {
         composeArgs.push('--project-directory', process.cwd());
     }
     composeArgs.push('exec', service, ...command);
-    await execa('docker', ['compose', ...composeArgs], { stdio: 'inherit' });
+    await execa('docker', ['compose', ...composeArgs], {
+        stdio: 'inherit',
+        env: { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' }
+    });
 }
+/**
+ * 等待服务健康检查通过
+ *
+ * 轮询关键服务 (PostgreSQL, Redis, API) 直到它们准备就绪或超时。
+ * - PostgreSQL: 使用 `pg_isready` 检查
+ * - Redis & API: 使用简单的延时等待 (后续可优化为端口/API探测)
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export async function waitForHealth(files, isBuiltIn = false) {
     logger.info('正在等待服务就绪...');
     // 等待 Postgres

package/dist/utils/env.d.ts

@@ -1,2 +1,2 @@
 export declare function initEnv(): Promise<void>;
-export declare function checkEnv(envType: 'production' | 'lowmem' | 'basic'): Promise<void>;
+export declare function checkEnv(envType: 'production' | 'lowmem'): Promise<void>;