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 PageEnvironment Variables
Next PageUpgrade create-nocobase-app Installation

#Upgrading a Docker Installation

Before you upgrade
  • Be sure to back up your database

#1. Switch to the directory where docker-compose.yml is located

For example

# MacOS, Linux...
cd /your/path/my-project/
# Windows
cd C:\your\path\my-project

#2. Update the image version number

About Version Numbers
  • Alias versions, like latest, latest-full, beta, beta-full, alpha, alpha-full, usually don't need to be changed.
  • Numeric version numbers, like 1.7.14, 1.7.14-full, need to be changed to the target version number.
  • Only upgrades are supported; downgrades are not!!!
  • It is recommended to pin to a specific numeric version in a production environment to avoid unintentional automatic upgrades. View all versions
# ...
services:
  app:
    # Use a specific version number for production
    image: nocobase/nocobase:1.7.14-full
    # You can also use an alias version (may upgrade automatically, use with caution in production)
    # image: nocobase/nocobase:latest-full
    # image: nocobase/nocobase:beta-full
# ...

#3. Restart the container

# Pull the latest image
docker compose pull app

# Recreate the container
docker compose up -d app

# Check the status of the app process
docker compose logs -f app

#4. Upgrading third-party plugins

Refer to Install and Upgrade Plugins

#5. Rollback instructions

NocoBase does not support downgrading. If you need to roll back, please restore the database backup from before the upgrade and change the image version back to the original version.

#6. Frequently Asked Questions (FAQ)

Q: Slow or failed image pull

This is often due to network issues. You can try configuring a Docker mirror to speed up downloads or simply try again later.

Q: Version has not changed

Confirm that you have changed image to the new version number and successfully executed docker compose pull app and up -d app.

Q: Commercial plugin download or update failed

For commercial plugins, please verify the license key in the system, and then restart the Docker container. For details, see NocoBase Commercial License Activation Guide.