官网:NocoBase - 开源、私有部署的 AI 员工驱动的零代码和低代码开发平台
开发文档2.0:NocoBase 文档
开发文档1.0:介绍 - NocoBase
介绍:NocoBase 是一款极具创新性的开源无代码/低代码开发平台,它成功地在“简单易用”和“强大灵活”之间找到了平衡点。无论你是业务人员希望快速搭建管理系统,还是开发者需要深度定制复杂应用,NocoBase 都能提供出色的支持。
核心价值定位:
NocoBase 的核心理念是 “80% 无代码实现 + 20% 扩展开发” 。它允许非技术人员通过直观的可视化操作配置大部分业务功能,同时为开发者保留了基于主流技术栈(如 Node.js 和 React)的完整编程能力,以应对复杂场景。其设计目标是为企业提供一个私有化部署、数据完全自控的数字化基础设施
版本对比
| 项目 | Latest(稳定版) | Beta(测试版) | Alpha(开发版) |
| 特点 | 功能稳定、测试完善,仅进行缺陷修复。 | 包含即将发布的新功能,经过初步测试,可能存在少量问题。 | 开发中的版本,功能最新但可能不完整或不稳定。 |
| 适用人群 | 希望获得稳定体验的用户、生产环境部署。 | 希望提前体验新功能并提供反馈的用户。 | 对前沿开发感兴趣的技术用户、贡献者。 |
| 稳定性 | ★★★★★ | ★★★★☆ | ★★☆☆☆ |
| 是否推荐生产使用 | 推荐 | 谨慎使用 | 谨慎使用 |
安装方式对比
| 项目 | Docker 安装(推荐) | create-nocobase-app 安装 | Git 源码安装 |
| 特点 | 无需编写代码,安装简单,适合快速体验。 | 业务代码独立,支持插件扩展和界面定制。 | 直接获取最新源码,可参与贡献与调试。 |
| 适用场景 | 无代码用户、希望快速部署到服务器的用户。 | 前端/全栈开发者、团队项目、低代码开发。 | 技术开发者、希望体验未发布版本的用户。 |
| 技术要求 | ★☆☆☆☆ | ★★★☆☆ | ★★★★★ |
| 升级方式 | 拉取最新镜像并重启容器 | 使用 yarn 更新依赖 | 通过 Git 流程同步更新 |
| 教程 | 安装 升级 部署 |
安装 升级 部署 |
安装 升级 部署 |
建议⚠:本教程中所有版本的数据库均使用PostgreSQL
create-nocobase-app 安装
前提条件
-
安装了 Node.js 20+、Yarn 1.22.x
-
配置并启动了所需数据库 MySQL 8.0.17+、MariaDB 10.9+、PostgreSQL 10+ 任选其一
-
由于国内网络环境的原因,建议你更换国内镜像(非必须)
$ yarn config set disable-self-update-check true
$ yarn config set registry https://registry.npmmirror.com/
创建 NocoBase 项目
npx create-nocobase-app@alpha(@alpha(开发版)@beta(测试版)若使用Latest(稳定版)则删除@alpha) my-nocobase-app -d postgres \
-e DB_HOST=localhost \
-e DB_PORT=5432 \
-e DB_DATABASE=nocobase \
-e DB_USER=nocobase \
-e DB_PASSWORD=nocobase \
-e TZ=Asia/Shanghai
开发版:npx create-nocobase-app@alpha my-nocobase-app -d postgres \
测试版:npx create-nocobase-app@beta my-nocobase-app -d postgres \
稳定版:yarn create nocobase-app my-nocobase-app -d postgres \
环境变量说明
-
TZ用于设置应用的时区,默认为操作系统时区 -
APP_KEY是应用的密钥,用于生成用户 token 等(如果 APP_KEY 修改了,旧的 token 也会随之失效)。它可以是任意随机字符串。请修改为自己的秘钥,并确保不对外泄露 -
DB_*为数据库相关配置,请根据实际情况修改为你的数据库连接信息cd my-nocobase-app
安装依赖
📢 由于网络环境、系统配置等因素影响,这一步可能需要十几分钟时间。
yarn install
生产环境提示
生产环境部署时,为了减少体积,可以只安装必要的依赖:
yarn install --production
安装 NocoBase
yarn nocobase install --lang=zh-CN
安装过程会自动创建数据库表结构和初始化数据。
启动 NocoBase
开发环境
yarn dev
生产环境
yarn start
登录 NocoBase
使用浏览器打开 http://localhost:13000,初始化账号和密码是 admin@nocobase.com 和 admin123。
账号安全提示
首次登录后,请及时修改默认密码以确保系统安全。
**
Docker 安装**
前提条件
-
已安装 Docker 和 Docker Compose
-
确保 Docker 服务正在运
新建 docker-compose.yml
# 创建一个名为 my-project(可以是其他名称)的文件夹,用于存放 NocoBase 生成的系统文件
mkdir my-project && cd my-project
# 创建一个空的 docker-compose.yml 文件
vi docker-compose.yml
配置 docker-compose.yml
选择 NocoBase 版本(版本对比)和数据库类型,复制对应的配置到 docker-compose.yml 里。
配置说明
-
选择镜像:
latestlatest-fullbetabeta-fullalphaalpha-full1.7.141.7.14-full-
生产环境建议固定为具体数字版本,避免无意自动升级。查看所有版本
-
阿里云镜像:
registry.cn-shanghai.aliyuncs.com/nocobase/nocobase:latest-full -
Docker Hub 镜像:
nocobase/nocobase:latest-full -
full 镜像包含了备份管理、迁移管理插件所需的 PostgreSQL 16/17 客户端、MySQL 8.0 客户端、Oracle 19.25 客户端以及模板打印(PDF)所需的 LibreOffice
-
如需自建镜像,可参考官方提供的 Dockerfile(精简版) 和 Dockerfile-full(完整版)
-
-
修改
APP_KEY:请将your-secret-key替换为随机字符串,用于加密用户 token 等敏感信息 -
使用已有数据库:如果已有数据库服务,请修改
DB_HOST为数据库服务器地址,并删除或注释掉数据库服务配置(如postgres、mysql、mariadb服务) -
端口映射:默认将容器的 80 端口映射到主机的 13000 端口,可根据需要修改
-
稳定版:image: registry.cn-shanghai.aliyuncs.com/nocobase/nocobase:latest-full
-
测试版:image: registry.cn-shanghai.aliyuncs.com/nocobase/nocobase:beta-full
-
开发版:image: registry.cn-shanghai.aliyuncs.com/nocobase/nocobase:alpha-full
networks:
nocobase:
driver: bridgeservices:
app:
image: registry.cn-shanghai.aliyuncs.com/nocobase/nocobase:alpha-full
restart: always
networks:
- nocobase
depends_on:
- postgres
environment:
# 应用的密钥,用于生成用户 token 等
# 如果 APP_KEY 修改了,旧的 token 也会随之失效
# 可以是任意随机字符串,并确保不对外泄露
- APP_KEY=your-secret-key
# 数据库类型,支持 postgres, mysql, mariadb
- DB_DIALECT=postgres
# 数据库主机,可以替换为已有的数据库服务器 IP
- DB_HOST=postgres
# Database port
- DB_PORT=5432
# 数据库名
- DB_DATABASE=nocobase
# 数据库用户
- DB_USER=nocobase
# 数据库密码
- DB_PASSWORD=nocobase
# 时区
- TZ=Asia/Shanghaivolumes: - ./storage:/app/nocobase/storage ports: - '13000:80' # init: true如果使用已有数据库服务,可以不启动 postgres
postgres:
image: registry.cn-shanghai.aliyuncs.com/nocobase/postgres:16
restart: always
command: postgres -c wal_level=logical
environment:
POSTGRES_USER: nocobase
POSTGRES_DB: nocobase
POSTGRES_PASSWORD: nocobase
volumes:
- ./storage/db/postgres:/var/lib/postgresql/data
networks:
- nocobase
安装并启动 NocoBase
# 拉取最新镜像
docker compose pull
# 在后台运行(首次运行会自动执行安装)
docker compose up -d
# 查看安装和运行日志
docker compose logs -f app
app-postgres-app-1 | nginx started
app-postgres-app-1 | yarn run v1.22.15
app-postgres-app-1 | $ cross-env DOTENV_CONFIG_PATH=.env node -r dotenv/config packages/app/server/lib/index.js install -s
app-postgres-app-1 | Done in 2.72s.
app-postgres-app-1 | yarn run v1.22.15
app-postgres-app-1 | $ pm2-runtime start --node-args="-r dotenv/config" packages/app/server/lib/index.js -- start
app-postgres-app-1 | 2022-04-28T15:45:38: PM2 log: Launching in no daemon mode
app-postgres-app-1 | 2022-04-28T15:45:38: PM2 log: App [index:0] starting in -fork mode-
app-postgres-app-1 | 2022-04-28T15:45:38: PM2 log: App [index:0] online
app-postgres-app-1 | 🚀 NocoBase server running at: http://localhost:13000/
登录 NocoBase
使用浏览器打开 http://localhost:13000,初始化账号和密码是 admin@nocobase.com 和 admin123。
账号安全提示
首次登录后,请及时修改默认密码以确保系统安全。