nodebbs 0.0.0 → 0.0.2

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

@@ -0,0 +1,126 @@
+# 低内存环境 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:
+          cpus: '0.5'
+          memory: 256M
+        reservations:
+          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}
+      --appendonly yes
+      --appendfsync everysec
+      --maxmemory 128mb
+      --maxmemory-policy allkeys-lru
+      --save 900 1
+      --save 300 10
+    ports: []  # 不暴露端口到主机
+    healthcheck:
+      interval: 30s
+      timeout: 10s
+      retries: 5
+      start_period: 20s
+    deploy:
+      resources:
+        limits:
+          cpus: '0.3'
+          memory: 128M
+        reservations:
+          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_OPTIONS: "--max-old-space-size=384"
+    volumes:
+      - api_uploads:/app/apps/api/uploads
+    healthcheck:
+      start_period: 90s  # 低内存环境启动更慢
+      interval: 60s
+    deploy:
+      resources:
+        limits:
+          cpus: '0.7'
+          memory: 512M
+        reservations:
+          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_OPTIONS: "--max-old-space-size=384"
+    healthcheck:
+      start_period: 90s  # 低内存环境启动更慢
+      interval: 60s
+    deploy:
+      resources:
+        limits:
+          cpus: '0.5'
+          memory: 512M
+        reservations:
+          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.prod.yml

@@ -0,0 +1,120 @@
+# 生产环境 Docker Compose 覆盖配置
+# 使用方式: docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
+# 本文件只包含与 docker-compose.yml 的差异部分
+
+services:
+  # PostgreSQL 数据库 - 生产环境优化
+  postgres:
+    restart: always
+    ports: []  # 生产环境不暴露端口到主机，只在内部网络访问
+    environment:
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}  # 生产环境必须设置强密码
+    healthcheck:
+      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"
+
+  # Redis 缓存 - 生产环境优化
+  redis:
+    restart: always
+    command: >
+      redis-server
+      --requirepass ${REDIS_PASSWORD}
+      --appendonly yes
+      --appendfsync everysec
+      --maxmemory 256mb
+      --maxmemory-policy allkeys-lru
+    ports: []  # 生产环境不暴露端口到主机
+    healthcheck:
+      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"
+
+  # 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_OPTIONS: "--max-old-space-size=512"  # 限制 Node.js 内存使用
+    volumes:
+      - api_uploads:/app/apps/api/uploads  # 生产环境不挂载源代码
+    healthcheck:
+      start_period: 60s
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 768M
+        reservations:
+          cpus: '0.3'
+          memory: 384M
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "20m"
+        max-file: "5"
+
+  # 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_OPTIONS: "--max-old-space-size=512"  # 限制 Node.js 内存使用
+    healthcheck:
+      start_period: 60s
+    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:
+    ipam:
+      config:
+        - subnet: 172.28.0.0/16

package/dist/templates/docker-compose.yml

@@ -0,0 +1,127 @@
+services:
+  # PostgreSQL 数据库
+  postgres:
+    image: postgres:16-alpine
+    container_name: nodebbs-postgres
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-postgres_password}
+      POSTGRES_DB: ${POSTGRES_DB:-nodebbs}
+      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"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    networks:
+      - nodebbs-network
+
+  # Redis 缓存
+  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
+    volumes:
+      - redis_data:/data
+    ports:
+      - "${REDIS_PORT:-6379}:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    networks:
+      - nodebbs-network
+
+  # API 服务
+  api:
+    build:
+      context: .  # 从 monorepo 根目录构建（turbo prune 需要完整的 workspace）
+      dockerfile: apps/api/Dockerfile
+    container_name: nodebbs-api
+    restart: unless-stopped
+    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}
+      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
+    volumes:
+      - api_uploads:/app/apps/api/uploads
+      - ./apps/api/src:/app/apps/api/src:ro
+    ports:
+      - "${API_PORT:-7100}:7100"
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    healthcheck:
+      test: ["CMD", "node", "-e", "require('http').get('http://localhost:7100/api', (r) => {process.exit(r.statusCode === 200 ? 0 : 1)})"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s
+    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}
+    container_name: nodebbs-web
+    restart: unless-stopped
+    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
+    ports:
+      - "${WEB_PORT:-3100}:3100"
+    depends_on:
+      api:
+        condition: service_healthy
+    healthcheck:
+      test: ["CMD", "node", "-e", "require('http').get('http://localhost:3100', (r) => {process.exit(r.statusCode === 200 ? 0 : 1)})"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s
+    networks:
+      - nodebbs-network
+
+# 数据卷
+volumes:
+  postgres_data:
+    driver: local
+  redis_data:
+    driver: local
+  api_uploads:
+    driver: local
+
+# 网络
+networks:
+  nodebbs-network:
+    driver: bridge

package/dist/templates/init-db.sql

@@ -0,0 +1,14 @@
+-- PostgreSQL 初始化脚本
+-- 这个脚本会在数据库首次创建时执行
+
+-- 创建扩展（如果需要）
+-- CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+-- CREATE EXTENSION IF NOT EXISTS "pg_trgm";
+
+-- 设置时区
+SET timezone = 'Asia/Shanghai';
+
+-- 数据库已由 POSTGRES_DB 环境变量创建
+-- 这里可以添加其他初始化 SQL
+
+\echo '数据库初始化完成'

package/dist/utils/docker.d.ts

@@ -0,0 +1,8 @@
+export declare function getComposeFiles(env: string): Promise<{
+    files: string[];
+    isBuiltIn: boolean;
+}>;
+export declare function checkDocker(): Promise<void>;
+export declare function runCompose(files: string[], args: string[], isBuiltIn?: boolean): Promise<void>;
+export declare function execCompose(files: string[], service: string, command: string[], isBuiltIn?: boolean): Promise<void>;
+export declare function waitForHealth(files: string[], isBuiltIn?: boolean): Promise<void>;

package/dist/utils/docker.js

@@ -0,0 +1,101 @@
+import { execa } from 'execa';
+import { logger } from './logger.js';
+import path from 'node:path';
+import { exists } from 'node:fs';
+import { promisify } from 'node:util';
+import { fileURLToPath } from 'node:url';
+const fileExists = promisify(exists);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+export async function getComposeFiles(env) {
+    const workDir = process.cwd();
+    let isBuiltIn = false;
+    // Check current directory for docker-compose.yml
+    let baseFile = path.join(workDir, 'docker-compose.yml');
+    let templateDir = workDir;
+    if (!await fileExists(baseFile)) {
+        // Use built-in templates
+        isBuiltIn = true;
+        // In production (dist/utils/docker.js), templates are in dist/templates
+        // __dirname is dist/utils, so ../templates points to dist/templates
+        templateDir = path.join(__dirname, '..', 'templates');
+        baseFile = path.join(templateDir, 'docker-compose.yml');
+        // Verify the built-in template exists
+        if (!await fileExists(baseFile)) {
+            logger.error('内置模板未找到，请确保 CLI 正确安装。');
+            throw new Error('Built-in templates not found');
+        }
+    }
+    const files = [baseFile];
+    if (env === 'production') {
+        files.push(path.join(templateDir, 'docker-compose.prod.yml'));
+    }
+    else if (env === 'lowmem') {
+        files.push(path.join(templateDir, 'docker-compose.lowmem.yml'));
+    }
+    return { files, isBuiltIn };
+}
+export async function checkDocker() {
+    logger.info('正在检查 Docker 环境...');
+    try {
+        await execa('docker', ['--version']);
+        await execa('docker', ['compose', 'version']);
+        logger.success('Docker 环境检查通过');
+    }
+    catch (error) {
+        logger.error('未找到 Docker 或 Docker Compose，请先安装。');
+        throw error;
+    }
+}
+export async function runCompose(files, args, isBuiltIn = false) {
+    const composeArgs = files.flatMap(f => ['-f', f]);
+    if (isBuiltIn) {
+        composeArgs.push('--project-directory', process.cwd());
+        // Set INIT_DB_PATH to the built-in sql file
+        const templateDir = path.dirname(files[0]);
+        process.env.INIT_DB_PATH = path.join(templateDir, 'init-db.sql');
+    }
+    composeArgs.push(...args);
+    // Use stdio: 'inherit' to show output in real-time
+    await execa('docker', ['compose', ...composeArgs], { stdio: 'inherit' });
+}
+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' });
+}
+export async function waitForHealth(files, isBuiltIn = false) {
+    logger.info('正在等待服务就绪...');
+    // Wait for Postgres
+    logger.info('等待 PostgreSQL...');
+    const composeArgs = files.flatMap(f => ['-f', f]);
+    if (isBuiltIn) {
+        composeArgs.push('--project-directory', process.cwd());
+    }
+    const pgArgs = [...composeArgs, 'exec', '-T', 'postgres', 'pg_isready', '-U', 'postgres'];
+    let retries = 15;
+    while (retries > 0) {
+        try {
+            await execa('docker', ['compose', ...pgArgs]);
+            logger.success('PostgreSQL 已就绪');
+            break;
+        }
+        catch {
+            retries--;
+            await new Promise(resolve => setTimeout(resolve, 2000));
+        }
+    }
+    if (retries === 0) {
+        logger.warning('PostgreSQL 可能尚未就绪');
+    }
+    // Wait for Redis
+    logger.info('等待 Redis...');
+    await new Promise(resolve => setTimeout(resolve, 5000));
+    logger.success('Redis 已就绪');
+    // Wait for API
+    logger.info('等待 API 服务...');
+    await new Promise(resolve => setTimeout(resolve, 10000));
+    logger.success('API 服务已就绪');
+}

package/dist/utils/env.d.ts

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

package/dist/utils/env.js

@@ -0,0 +1,108 @@
+import fs from 'node:fs/promises';
+import { exists } from 'node:fs';
+import { promisify } from 'node:util';
+import { logger } from './logger.js';
+import { confirm } from '@inquirer/prompts';
+import dotenv from 'dotenv';
+const fileExists = promisify(exists);
+export async function initEnv() {
+    if (await fileExists('.env')) {
+        logger.info('.env 文件已存在，跳过创建');
+        return;
+    }
+    logger.info('正在创建 .env 文件...');
+    if (await fileExists('.env.docker.example')) {
+        await fs.copyFile('.env.docker.example', '.env');
+        logger.warning('请编辑 .env 文件并修改以下配置：');
+        logger.warning('  - POSTGRES_PASSWORD (数据库密码)');
+        logger.warning('  - REDIS_PASSWORD (Redis 密码)');
+        logger.warning('  - JWT_SECRET (JWT 密钥)');
+        const edit = await confirm({
+            message: '是否现在编辑 .env 文件？',
+            default: false
+        });
+        if (edit) {
+            logger.info('请手动编辑 .env 文件后再次运行命令。');
+            process.exit(0);
+        }
+    }
+    else {
+        // If .env.docker.example doesn't exist, maybe we are in the wrong directory or need to look in project/
+        if (await fileExists('project/.env.docker.example')) {
+            await fs.copyFile('project/.env.docker.example', '.env');
+            logger.success('已从 project/.env.docker.example 复制 .env');
+        }
+        else {
+            logger.warning('未找到 .env.docker.example！跳过 .env 创建。');
+        }
+    }
+}
+export async function checkEnv(envType) {
+    logger.info('正在检查环境配置...');
+    // Load .env
+    const envConfig = dotenv.config().parsed || {};
+    let warnings = 0;
+    let errors = 0;
+    const defaults = {
+        POSTGRES_PASSWORD: ['your_secure_postgres_password_here', 'postgres_password'],
+        REDIS_PASSWORD: ['your_secure_redis_password_here', 'redis_password'],
+        JWT_SECRET: ['change-this-to-a-secure-random-string-in-production']
+    };
+    const isProd = envType === 'production' || envType === 'lowmem';
+    if (defaults.POSTGRES_PASSWORD.includes(envConfig.POSTGRES_PASSWORD)) {
+        if (isProd) {
+            logger.error('生产环境必须修改 POSTGRES_PASSWORD');
+            errors++;
+        }
+        else {
+            logger.warning('建议修改 POSTGRES_PASSWORD');
+            warnings++;
+        }
+    }
+    if (defaults.REDIS_PASSWORD.includes(envConfig.REDIS_PASSWORD)) {
+        if (isProd) {
+            logger.error('生产环境必须修改 REDIS_PASSWORD');
+            errors++;
+        }
+        else {
+            logger.warning('建议修改 REDIS_PASSWORD');
+            warnings++;
+        }
+    }
+    if (defaults.JWT_SECRET.includes(envConfig.JWT_SECRET)) {
+        if (isProd) {
+            logger.error('生产环境必须修改 JWT_SECRET');
+            errors++;
+        }
+        else {
+            logger.warning('建议修改 JWT_SECRET');
+            warnings++;
+        }
+    }
+    if (isProd) {
+        if (!envConfig.CORS_ORIGIN || envConfig.CORS_ORIGIN === '*') {
+            logger.warning('生产环境建议设置具体的 CORS_ORIGIN');
+            warnings++;
+        }
+        if (!envConfig.APP_URL || envConfig.APP_URL === 'http://localhost:3100') {
+            logger.warning('生产环境建议设置实际的 APP_URL');
+            warnings++;
+        }
+    }
+    if (errors > 0) {
+        logger.error(`发现 ${errors} 个配置错误，无法继续。`);
+        process.exit(1);
+    }
+    if (warnings > 0) {
+        logger.warning(`发现 ${warnings} 个配置警告。`);
+        const cont = await confirm({
+            message: '是否继续？',
+            default: false
+        });
+        if (!cont)
+            process.exit(0);
+    }
+    else {
+        logger.success('环境配置检查通过');
+    }
+}

package/dist/utils/logger.d.ts

@@ -0,0 +1,7 @@
+export declare const logger: {
+    info: (msg: string) => void;
+    success: (msg: string) => void;
+    warning: (msg: string) => void;
+    error: (msg: string) => void;
+    header: (msg: string) => void;
+};

package/dist/utils/logger.js

@@ -0,0 +1,14 @@
+import chalk from 'chalk';
+export const logger = {
+    info: (msg) => console.log(chalk.blue('[信息]'), msg),
+    success: (msg) => console.log(chalk.green('[成功]'), msg),
+    warning: (msg) => console.log(chalk.yellow('[警告]'), msg),
+    error: (msg) => console.log(chalk.red('[错误]'), msg),
+    header: (msg) => {
+        console.log('');
+        console.log(chalk.blue('========================================'));
+        console.log(chalk.blue(`  ${msg}`));
+        console.log(chalk.blue('========================================'));
+        console.log('');
+    }
+};