科技背景
🔧 NOCOBASE IMPLEMENTATION GUIDE

实施者指南 部署与配置实战

快速完成NocoBase部署与配置,确保系统稳定运行

部署前准备:环境检查与规划

三种部署方式:Docker Compose、Dockerfile、源码安装

基础配置:系统设置与常见问题解决

📋 部署准备 🚀 部署方式 ⚙️ 基础配置 🔧 问题解决

📋 部署前准备

环境检查与规划,确保部署顺利进行

硬件与网络要求

最低配置(测试环境)

  • CPU:2核
  • 内存:4GB
  • 磁盘:50GB
  • 网络:稳定的互联网连接

推荐配置(生产环境)

  • CPU:4核及以上
  • 内存:8GB及以上
  • 磁盘:100GB SSD及以上
  • 网络:稳定的互联网连接,建议使用专线

软件环境要求

Docker 部署方式

  • Docker:20.10.0+
  • Docker Compose:1.29.0+
  • 操作系统:Linux、Windows、macOS

源码安装方式

  • Node.js:16.14.0+ 或 18.0.0+
  • 数据库:PostgreSQL 14.0+
  • 操作系统:Linux、Windows、macOS

部署规划

1 环境准备

  • 确认服务器硬件配置
  • 安装必要的软件依赖
  • 配置网络和防火墙

2 部署方式选择

  • 测试环境:Docker Compose
  • 生产环境:Dockerfile
  • 深度定制:源码安装

3 后续规划

  • 数据备份策略
  • 监控与告警
  • 定期更新计划

🚀 部署方式

三种部署方式详细教程,满足不同场景需求

方式一:Docker Compose 一键部署(推荐测试环境)

部署步骤

1

创建部署目录

mkdir -p nocobase && cd nocobase
2

创建 docker-compose.yml 文件

cat > docker-compose.yml << 'EOF' version: '3' services: nocobase: image: nocobase/nocobase:latest ports: - "8080:8080" environment: - DATABASE_URL=postgresql://nocobase:nocobase@postgres:5432/nocobase depends_on: - postgres postgres: image: postgres:14-alpine environment: - POSTGRES_DB=nocobase - POSTGRES_USER=nocobase - POSTGRES_PASSWORD=nocobase volumes: - postgres-data:/var/lib/postgresql/data volumes: postgres-data: EOF
3

启动服务

docker-compose up -d
4

访问 NocoBase

打开浏览器,访问 http://服务器IP:8080

注意事项

  • 此方式适合测试环境,生产环境建议使用 Dockerfile 方式
  • 默认使用最新版本镜像,如需指定版本请修改 image 标签
  • 默认数据库密码为 nocobase,生产环境请修改为强密码

方式二:Dockerfile 自定义构建(推荐生产环境)

部署步骤

1

创建 Dockerfile 文件

cat > Dockerfile << 'EOF' FROM nocobase/nocobase:latest # 如需安装额外依赖,请在此添加 # RUN npm install some-package # 如需复制自定义配置,请在此添加 # COPY config.yml /app/config/ EOF
2

构建镜像

docker build -t my-nocobase .
3

创建 docker-compose.yml 文件

cat > docker-compose.yml << 'EOF' version: '3' services: nocobase: image: my-nocobase ports: - "8080:8080" environment: - DATABASE_URL=postgresql://nocobase:your_strong_password@postgres:5432/nocobase depends_on: - postgres postgres: image: postgres:14-alpine environment: - POSTGRES_DB=nocobase - POSTGRES_USER=nocobase - POSTGRES_PASSWORD=your_strong_password volumes: - postgres-data:/var/lib/postgresql/data volumes: postgres-data: EOF
4

启动服务

docker-compose up -d

注意事项

  • 生产环境请务必修改数据库密码为强密码
  • 建议使用固定版本镜像,而非 latest 标签
  • 可根据需要在 Dockerfile 中添加自定义配置和依赖

方式三:create-nocobase-app 源码安装(适合深度定制)

部署步骤

1

安装 Node.js

确保安装了 Node.js 16.14.0+ 或 18.0.0+

2

创建项目

npm create nocobase-app@latest my-nocobase-app
3

配置数据库

根据提示配置数据库连接信息

4

启动服务

cd my-nocobase-app && npm run dev
5

生产环境构建

npm run build && npm run start

注意事项

  • 此方式适合需要深度定制或二次开发的场景
  • 需要更多的系统资源和 Node.js 相关知识
  • 生产环境建议使用 PM2 等进程管理工具

⚙️ 基础配置

系统设置与初始化配置,确保系统正常运行

初始配置

1. 创建管理员账户

首次访问 NocoBase 时,系统会引导创建管理员账户。请设置强密码并妥善保管。

2. 配置系统信息

进入「设置」->「系统设置」,配置系统名称、LOGO、版权信息等。

3. 配置邮件服务

进入「设置」->「邮件设置」,配置 SMTP 服务,用于发送验证码、通知等。

4. 安装必要插件

进入「插件市场」,安装所需的插件,如 AI 集成、图表分析等。

安全配置

1. 配置 HTTPS

生产环境建议配置 HTTPS,可以通过反向代理(如 Nginx)实现。

2. 配置防火墙

仅开放必要的端口,如 80、443 等,关闭不必要的端口。

3. 配置权限管理

进入「设置」->「角色权限」,配置不同角色的权限,遵循最小权限原则。

4. 配置数据备份

定期备份数据库,可以通过 crontab 定时执行备份脚本。

性能优化

服务器优化

  • 调整服务器内核参数
  • 配置合适的 swap 空间
  • 使用 SSD 存储

数据库优化

  • 调整 PostgreSQL 配置参数
  • 定期清理无用数据
  • 创建合适的索引

应用优化

  • 启用缓存机制
  • 合理配置插件
  • 优化图片和静态资源

🔧 常见问题及解决方案

部署与使用过程中常见问题的解决方法

问题:Docker 部署后无法访问

可能原因

  • 端口未开放
  • 防火墙阻止
  • 容器未正常启动

解决方案

  • 检查端口映射是否正确:docker-compose ps
  • 检查防火墙设置,开放相应端口
  • 查看容器日志:docker-compose logs

问题:数据库连接失败

可能原因

  • 数据库配置错误
  • 数据库服务未启动
  • 网络连接问题

解决方案

  • 检查数据库配置是否正确
  • 确保数据库服务正常运行
  • 测试数据库连接:psql -h localhost -U nocobase -d nocobase

问题:插件安装失败

可能原因

  • 网络连接问题
  • 插件版本与系统不兼容
  • 服务器资源不足

解决方案

  • 检查网络连接是否正常
  • 确保插件版本与系统版本兼容
  • 检查服务器内存和磁盘空间是否充足

问题:系统运行缓慢

可能原因

  • 服务器资源不足
  • 数据库未优化
  • 插件过多或配置不当

解决方案

  • 增加服务器资源(CPU、内存)
  • 优化数据库配置,创建合适的索引
  • 禁用不必要的插件,优化系统配置