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 PageDocker Installation
Next PageGit Source Installation

#create-nocobase-app Installation

Prerequisites
  • Node.js 20+, Yarn 1.22.x are installed
  • One of the required databases is configured and running: MySQL 8.0.17+, MariaDB 10.9+, or PostgreSQL 10+

#1. Create a NocoBase Project

Select the NocoBase version (Version Comparison) and database type, then execute the corresponding command.

latest version
beta version
alpha version
PostgreSQL
MySQL
MariaDB
yarn create nocobase-app 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
Environment Variables
  • TZ is used to set the application's time zone, which defaults to the operating system's time zone.
  • APP_KEY is the application's secret key, used for generating user tokens, etc. (If APP_KEY is changed, old tokens will become invalid). It can be any random string. Please change it to your own secret key and ensure it is not exposed.
  • DB_* are database-related configurations. Please modify them to match your database connection information according to your actual setup.

#2. Change Directory

cd my-nocobase-app

#3. Install Dependencies

📢 Depending on your network environment, system configuration, and other factors, this step may take over ten minutes.

yarn install
Production Environment Tip

When deploying in a production environment, you can install only the necessary dependencies to reduce the size:

yarn install --production

#4. Install NocoBase

yarn nocobase install --lang=en-US

The installation process will automatically create the database table structure and initialize data.

#5. Start NocoBase

Development Environment

yarn dev

Production Environment

yarn start

#6. Log in to NocoBase

Open http://localhost:13000 in your browser. The initial account and password are admin@nocobase.com and admin123.

Account Security Tip

After your first login, please change the default password immediately to ensure system security.