logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
How NocoBase Works
Installation and Version Comparison

Install NocoBase

Docker Installation
create-nocobase-app Installation
Git Source Installation
Environment Variables

Upgrade NocoBase

Upgrade Docker Installation
Upgrade create-nocobase-app Installation
Upgrade Git Source Installation

Deployment

Production Environment Deployment

Static Resource Proxy

nginx
caddy
cdn

Common Operations Commands

docker compose
pm2
How to Deploy Faster
Install and Upgrade Plugins
Previous PageUpgrade create-nocobase-app Installation
Next PageProduction Environment Deployment

#Upgrading a Git Source Installation

Preparation Before Upgrading
  • Be sure to back up your database first
  • Stop the running NocoBase instance (Ctrl + C)

#1. Switch to the NocoBase project directory

cd my-nocobase-app

#2. Pull the latest code

git pull

#3. Delete cache and old dependencies (optional)

If the normal upgrade process fails, you can try clearing the cache and dependencies and then re-downloading them.

# Clear nocobase cache
yarn nocobase clean
# Delete dependencies
yarn rimraf -rf node_modules # equivalent to rm -rf node_modules

#4. Update dependencies

📢 Due to factors such as network environment and system configuration, this next step may take more than ten minutes.

yarn install

#5. Run the upgrade command

yarn nocobase upgrade

#6. Start NocoBase

yarn dev
Production Environment Tip

It is not recommended to deploy a NocoBase installation from source code directly in a production environment (for production environments, please refer to Production Deployment).

#7. Upgrading third-party plugins

Refer to Install and Upgrade Plugins