ContextQMD
Back to Nocobase

Install NocoBase App

docs/docs/en/ai/install-nocobase-app.md

2.1.204.3 KB
Original Source

Install NocoBase App

Prerequisites

  • Node.js >= 22
  • Yarn 1.x
  • If you plan to install with Docker, make sure Docker is already running

Step 1: Install CLI

Install NocoBase CLI globally first:

bash
npm install -g @nocobase/cli
nb --version

If you often work with multiple terminals or want to operate in parallel with AI Agents, we also recommend running nb session setup once. This lets each session keep its own current env, so they are less likely to affect one another.

Step 2: Initialize the app

We recommend installing through the UI wizard:

bash
nb init --ui
  1. Getting started - set the --env identifier and choose Install a new app

  1. App environment - set the app basics, storage location, and runtime port

  1. App source and version - choose how to get the app and which source and version to use

  1. Configure the database - choose the built-in database or a custom database

  1. Create an admin account - set up the first admin account

  1. Connection & authentication - enter the app access URL and choose an authentication method

If you prefer terminal interaction, you can also run:

bash
nb init

If you need to initialize in scripts or CI, use non-interactive mode:

bash
nb init --yes --env app1

:::tip Install on a remote server

If you run nb init --ui on a server, we recommend changing the default host to that server's IP first. That way, you can open the wizard from your local browser.

bash
nb config set default-ui-host <server-ip>
nb config set default-api-host <server-ip>

:::

Step 3: Confirm the app is ready

After installation, it is usually worth confirming these three things first:

  • The env has been saved successfully
  • The app has started normally
  • You can sign in with the administrator account

Common commands:

bash
nb env list
nb env info
nb app logs

For a local default installation, you can usually open http://localhost:13000 in your browser directly. After signing in, start a new AI Agent session or restart the current one, and the AI can begin working with this NocoBase app.

CLI configuration is stored in ~/.nocobase/ by default, so AI Agents can usually access it from any working directory.

If this app will be exposed to real users later, we do not recommend using IP + port for the long term. The next step is usually to put it behind a reverse proxy and enable HTTPS.

Next Steps