nodebbs 0.3.2 → 0.4.1

package/dist/commands/shell/redis.js

@@ -2,6 +2,7 @@ import { Command } from '@oclif/core';
 import { runCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
 import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
+import { getEnvValue } from '../../utils/env.js';
 export default class ShellRedis extends Command {
     static description = '进入 Redis shell (redis-cli)';
     static flags = {
@@ -11,7 +12,13 @@ export default class ShellRedis extends Command {
         const { flags } = await this.parse(ShellRedis);
         const env = await selectEnvironment(flags.env);
         const { files, isBuiltIn } = await getComposeFiles(env);
+        // 从环境变量获取密码
+        const redisPassword = await getEnvValue('REDIS_PASSWORD');
         logger.info('正在进入 Redis shell...');
-        await runCompose(files, ['exec', 'redis', 'redis-cli'], isBuiltIn);
+        // 如果有密码则使用认证参数
+        const redisCliArgs = redisPassword
+            ? ['exec', 'redis', 'redis-cli', '-a', redisPassword]
+            : ['exec', 'redis', 'redis-cli'];
+        await runCompose(files, redisCliArgs, isBuiltIn);
     }
 }

package/dist/interactive.js

@@ -29,9 +29,11 @@ export async function runInteractive(root) {
     }
     await navigate(tree, [], config);
 }
-const GLOBAL_PRIORITY = ['start', 'stop', 'restart', 'upgrade', 'status', 'logs', 'shell', 'db', 'pack'];
+const GLOBAL_PRIORITY = ['start', 'stop', 'restart', 'upgrade', 'status', 'logs', 'db', 'backup', 'import', 'clean', 'shell', 'pack'];
 const SCOPED_PRIORITIES = {
     'logs': ['all', 'web', 'api', 'db', 'redis'],
+    'backup': ['all', 'db', 'uploads'],
+    'import': ['all', 'db', 'uploads'],
 };
 async function navigate(node, breadcrumbs, config) {
     const currentPath = breadcrumbs.join(':');

package/dist/templates/config.yml

@@ -0,0 +1,22 @@
+# NodeBBS 自定义配置
+# 此文件用于挂载自定义静态资源（如 logo、favicon 等）
+# 将此文件复制到项目根目录并取消需要的注释即可生效
+#
+# 使用方法：
+#   1. 复制此文件到项目根目录：cp config.yml ./
+#   2. 在项目根目录创建 web 文件夹：mkdir -p web
+#   3. 将自定义资源放入 web 文件夹
+#   4. 取消下方对应行的注释
+#   5. 重启服务：npx nodebbs restart
+
+services:
+  web:
+    volumes:
+      # 网站图标
+      - ./web/favicon.ico:/app/apps/web/public/favicon.ico
+
+      # 网站 Logo
+      - ./web/logo.svg:/app/apps/web/public/logo.svg
+
+      # Apple Touch Icon (iOS 主屏幕图标)
+      - ./web/apple-touch-icon.png:/app/apps/web/public/apple-touch-icon.png

package/dist/templates/docker-compose.yml

@@ -2,13 +2,13 @@ services:
   # PostgreSQL 数据库
   postgres:
     image: postgres:16-alpine
-    container_name: nodebbs-postgres
+    container_name: ${COMPOSE_PROJECT_NAME:-nodebbs}-postgres
     restart: unless-stopped
     environment:
       POSTGRES_USER: postgres
       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
 
@@ -24,11 +24,11 @@ services:
   # Redis 缓存
   redis:
     image: redis:7-alpine
-    container_name: nodebbs-redis
+    container_name: ${COMPOSE_PROJECT_NAME:-nodebbs}-redis
     restart: unless-stopped
     command: redis-server --requirepass ${REDIS_PASSWORD:-redis_password} --appendonly yes
     environment:
-      TZ: Asia/Shanghai
+      TZ: ${TZ:-Asia/Shanghai}
     volumes:
       - redis_data:/data
 
@@ -46,10 +46,9 @@ services:
       context: .
       dockerfile: apps/api/Dockerfile
     image: ${API_IMAGE:-nodebbs-api:local}
-    container_name: nodebbs-api
+    container_name: ${COMPOSE_PROJECT_NAME:-nodebbs}-api
     restart: unless-stopped
     environment:
-      NODE_ENV: production
       APP_NAME: ${APP_NAME:-nodebbs}
       HOST: 0.0.0.0
       PORT: 7100
@@ -59,7 +58,7 @@ services:
       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:-*}
-      TZ: Asia/Shanghai
+      TZ: ${TZ:-Asia/Shanghai}
     volumes:
       - api_uploads:/app/apps/api/uploads
       # - ./apps/api/src:/app/apps/api/src:ro
@@ -85,19 +84,14 @@ services:
       context: .
       dockerfile: apps/web/Dockerfile
     image: ${WEB_IMAGE:-nodebbs-web:local}
-    container_name: nodebbs-web
+    container_name: ${COMPOSE_PROJECT_NAME:-nodebbs}-web
     restart: unless-stopped
     environment:
-      NODE_ENV: production
       APP_NAME: ${APP_NAME:-nodebbs}
       PORT: 3100
       SERVER_API_URL: ${SERVER_API_URL:-http://api:7100}
-      TZ: Asia/Shanghai
-    # volumes:
-      # 自定义资源挂载（如有需要，请取消注释并在同级目录下创建 web 文件夹及对应文件）
-      # - ./web/favicon.ico:/app/apps/web/public/favicon.ico
-      # - ./web/logo.svg:/app/apps/web/public/logo.svg
-      # - ./web/apple-touch-icon.png:/app/apps/web/public/apple-touch-icon.png
+      TZ: ${TZ:-Asia/Shanghai}
+    # 自定义资源挂载请使用 config.yml，参见 src/templates/config.yml
     ports:
       - "${WEB_PORT:-3100}:3100"
     depends_on:

package/dist/templates/env

@@ -2,21 +2,16 @@
 # NodeBBS Docker Compose 环境变量配置
 # ========================================
 
-# 应用名称
-APP_NAME=nodebbs
-
 # ========================================
 # 数据库配置
 # ========================================
 POSTGRES_PASSWORD=your_secure_postgres_password_here
 POSTGRES_DB=nodebbs
-POSTGRES_PORT=5432
 
 # ========================================
 # Redis 配置
 # ========================================
 REDIS_PASSWORD=your_secure_redis_password_here
-REDIS_PORT=6379
 
 # ========================================
 # API 服务配置

package/dist/utils/docker.d.ts

@@ -5,7 +5,7 @@
  * - 如果存在，则优先使用项目根目录的配置。
  * - 如果不存在，则使用 CLI 内置的模板文件。
  *
- * @param env - 运行环境 ('production' | 'lowmem' | 'basic')
+ * @param env - 运行环境 ('production' | 'lowmem' | 'default')
  * @returns 对象包含文件路径数组和是否使用内置模板的标志
  */
 export declare function getComposeFiles(env: string): Promise<{

package/dist/utils/docker.js

@@ -23,7 +23,7 @@ async function getDockerEnv() {
  * - 如果存在，则优先使用项目根目录的配置。
  * - 如果不存在，则使用 CLI 内置的模板文件。
  *
- * @param env - 运行环境 ('production' | 'lowmem' | 'basic')
+ * @param env - 运行环境 ('production' | 'lowmem' | 'default')
  * @returns 对象包含文件路径数组和是否使用内置模板的标志
  */
 export async function getComposeFiles(env) {
@@ -43,18 +43,15 @@ export async function getComposeFiles(env) {
     // 映射 environment 到对应的 override 文件名
     const envFileMap = {
         'production': 'docker-compose.prod.yml',
-        'lowmem': 'docker-compose.lowmem.yml',
-        'basic': 'docker-compose.ports.yml'
+        'lowmem': 'docker-compose.lowmem.yml'
     };
     if (env in envFileMap) {
         const fileName = envFileMap[env];
-        // 注意：basic 对应的 ports.yml 是新增的，可能不存在于旧项目的根目录，
-        // 但如果是在 CLI 内部运行，templateDir 里肯定有。
-        // 如果是 production/lowmem，用户目录可能有 override。
+        // 注意：用户目录可能有 override 文件覆盖内置默认值
         const localOverride = path.join(workDir, fileName);
         const templateOverride = path.join(templateDir, fileName);
         // 策略调整：
-        // basic -> 总是尝试加载 ports.yml (通常只存在于 template，或者用户没覆盖)
+        // default -> 不加载 override 文件，使用基础配置
         // production/lowmem -> 尝试加载对应的 override
         if (await fileExists(localOverride)) {
             files.push(localOverride);
@@ -78,6 +75,12 @@ export async function getComposeFiles(env) {
             files.push(templateBuild);
         }
     }
+    // 4. 检测自定义配置文件 (config.yml)
+    // 用于挂载自定义静态资源（如 logo、favicon 等），仅当文件存在时加载
+    const configFile = path.join(workDir, 'config.yml');
+    if (await fileExists(configFile)) {
+        files.push(configFile);
+    }
     return { files, isBuiltIn };
 }
 /**
@@ -94,6 +97,33 @@ export async function checkDocker() {
         logger.success('Docker 环境检查通过');
     }
     catch (error) {
+        // 检测是否是权限问题
+        const errorMessage = error.stderr || error.message || '';
+        const isPermissionError = errorMessage.includes('permission denied') ||
+            errorMessage.includes('Got permission denied') ||
+            errorMessage.includes('dial unix /var/run/docker.sock');
+        if (isPermissionError) {
+            logger.warning('检测到 Docker 权限问题');
+            logger.info('您的用户可能没有权限访问 Docker。');
+            // 如果是 CI 环境或非交互式环境，直接报错
+            if (process.env.CI || !process.stdout.isTTY) {
+                throw error;
+            }
+            // 尝试配置权限
+            await configureDockerPermissions();
+            // 配置后再次检查
+            try {
+                await execa('docker', ['--version']);
+                await execa('docker', ['compose', 'version']);
+                logger.success('Docker 权限配置成功！');
+                return;
+            }
+            catch {
+                logger.error('权限配置后仍无法访问 Docker');
+                logger.info('请尝试: 1) 运行 "newgrp docker"  2) 或重新登录');
+                throw error;
+            }
+        }
         logger.warning('未检测到 Docker 或 Docker Compose。');
         // 如果是 CI 环境或非交互式环境，直接报错
         if (process.env.CI || !process.stdout.isTTY) {
@@ -114,6 +144,22 @@ export async function checkDocker() {
                 return;
             }
             catch (installError) {
+                // 特殊处理：需要 newgrp 的情况
+                if (installError.message === 'NEWGRP_REQUIRED') {
+                    logger.warning('安装完成，但需要刷新权限。');
+                    logger.info('请运行以下命令后重试：');
+                    logger.info('  newgrp docker && npx nodebbs');
+                    process.exit(0);
+                }
+                // 检测权限问题
+                const installErrMsg = installError.stderr || installError.message || '';
+                if (installErrMsg.includes('permission denied') || installErrMsg.includes('docker.sock')) {
+                    logger.warning('Docker 已安装，但存在权限问题。');
+                    logger.info('请运行以下命令后重试：');
+                    logger.info('  newgrp docker && npx nodebbs');
+                    logger.info('或者注销并重新登录。');
+                    process.exit(0);
+                }
                 logger.error(`安装失败: ${installError.message}`);
                 logger.info('请访问 https://www.docker.com/get-started 手动安装。');
                 throw installError;
@@ -152,11 +198,8 @@ async function installDocker() {
                 logger.warning('无法自动启动 Docker 服务');
                 logger.info('请手动运行: sudo systemctl start docker');
             }
-            // 提示用户可能需要添加到 docker 组
-            logger.warning('请确保您的用户已添加到 docker 组:');
-            logger.info('  sudo usermod -aG docker $USER');
-            logger.info('您可能需要注销并重新登录才能生效。');
-            await confirm({ message: '是否已完成必要配置并准备继续？', default: true });
+            // 配置用户权限
+            await configureDockerPermissions();
         }
         finally {
             // 清理临时安装脚本
@@ -177,6 +220,39 @@ async function installDocker() {
         throw new Error(`不支持在 ${platform} 平台自动安装`);
     }
 }
+/**
+ * 配置 Docker 用户权限
+ *
+ * 将当前用户添加到 docker 组，避免每次都需要 sudo。
+ */
+async function configureDockerPermissions() {
+    const currentUser = process.env.USER || process.env.USERNAME || '';
+    if (!currentUser) {
+        logger.warning('无法获取当前用户名，请手动配置 Docker 权限');
+        logger.info('请运行: sudo usermod -aG docker $USER');
+        return;
+    }
+    logger.info(`正在将用户 "${currentUser}" 添加到 docker 组...`);
+    try {
+        await execa('sudo', ['usermod', '-aG', 'docker', currentUser], { stdio: 'inherit' });
+        logger.success(`已将用户 "${currentUser}" 添加到 docker 组`);
+        // 提示权限激活方式
+        logger.info('');
+        logger.warning('权限变更需要刷新才能生效。');
+        logger.info('请运行以下命令后重试：');
+        logger.info('  newgrp docker && npx nodebbs');
+        logger.info('');
+        logger.info('或者注销并重新登录后再运行 npx nodebbs');
+        throw new Error('NEWGRP_REQUIRED');
+    }
+    catch (error) {
+        if (error.message === 'NEWGRP_REQUIRED') {
+            throw error;
+        }
+        logger.error(`添加用户到 docker 组失败: ${error.message}`);
+        logger.info('请手动运行: sudo usermod -aG docker $USER');
+    }
+}
 /**
  * 执行 Docker Compose 管理命令 (Lifecycle Commands)
  *

package/dist/utils/env.d.ts

@@ -4,4 +4,4 @@ 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>;
+export declare function checkEnv(envType: 'production' | 'lowmem' | 'default'): Promise<void>;

package/dist/utils/selection.d.ts

@@ -1,4 +1,4 @@
-export type EnvType = 'production' | 'lowmem' | 'basic';
+export type EnvType = 'production' | 'lowmem' | 'default';
 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>;

package/dist/utils/selection.js

@@ -6,12 +6,12 @@ import path from 'node:path';
 import { getEnvValue, setEnvValue, unsetEnvValue } from './env.js';
 export const EnvFlag = Flags.string({
     char: 'e',
-    description: '部署环境 (production, lowmem, basic)',
-    options: ['production', 'lowmem', 'basic'],
+    description: '部署环境 (production, lowmem, default)',
+    options: ['production', 'lowmem', 'default'],
 });
 async function getStoredEnv() {
     const env = await getEnvValue('DEPLOY_ENV');
-    if (env && ['production', 'lowmem', 'basic'].includes(env)) {
+    if (env && ['production', 'lowmem', 'default'].includes(env)) {
         return env;
     }
     return null;
@@ -51,7 +51,7 @@ export async function selectEnvironment(env, options = {}) {
         choices: [
             { name: '标准生产环境 (2C4G+) [推荐]', value: 'production' },
             { name: '低配环境 (1C1G/1C2G)', value: 'lowmem' },
-            { name: '基础环境 (仅用于测试)', value: 'basic' },
+            { name: '默认环境 (无资源限制)', value: 'default' },
             { name: '❌ 取消', value: '__CANCEL__' },
         ],
         loop: true,