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 Docker Installation
Next PageUpgrade Git Source Installation

#Upgrading a create-nocobase-app Installation

Preparation before upgrading
  • Be sure to back up the database first
  • Stop the running NocoBase instance

#1. Stop the running NocoBase instance

If it's not a background process, stop it with Ctrl + C. In a production environment, execute the pm2-stop command to stop it.

yarn nocobase pm2-stop

#2. Execute the upgrade command

Simply execute the yarn nocobase upgrade command.

# Switch to the corresponding directory
cd my-nocobase-app
# Execute the upgrade command
yarn nocobase upgrade
# Start
yarn dev

#Upgrading to a specific version

Modify the package.json file in the project's root directory, and change the version numbers for @nocobase/cli and @nocobase/devtools (you can only upgrade, not downgrade). For example:

{
  "dependencies": {
-   "@nocobase/cli": "1.5.11"
+   "@nocobase/cli": "1.6.0-beta.8"
  },
  "devDependencies": {
-   "@nocobase/devtools": "1.5.11"
+   "@nocobase/devtools": "1.6.0-beta.8"
  }
}

Then execute the upgrade command

yarn install
yarn nocobase upgrade --skip-code-update