Back to Details

nocobase-install-start

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Goal

目标

Install NocoBase with clear branching and minimal questioning.

以清晰的分支流程且尽可能少提问的方式安装NocoBase。

Workflow

工作流程

Ask quick mode first.
Quick mode (
```
Docker + install together + PostgreSQL
```
):

Ask only release channel and installation directory.
Execute install and startup.

Non-quick mode:

Ask installation method (
```
docker
```
,
```
create-nocobase-app
```
,
```
git
```
), release channel, and installation directory.
If method is Docker, ask database mode (
```
install together
```
or
```
connect existing
```
).
If Docker +
```
install together
```
, ask database type (
```
PostgreSQL
```
,
```
MySQL
```
,
```
MariaDB
```
).
If
```
connect existing
```
(Docker/non-Docker), confirm connection info readiness and require config/env edits before startup.
Execute install only; provide startup commands and verification steps (do not execute startup).

Always read
```
references/install-methods.md
```
and include the chosen method doc link before running commands.

首先询问是否使用快速模式。
快速模式（
```
Docker + 一键安装 + PostgreSQL
```
）：

仅询问发布渠道和安装目录。
执行安装和启动操作。

非快速模式：

询问安装方式（
```
docker
```
、
```
create-nocobase-app
```
、
```
git
```
）、发布渠道和安装目录。
若选择Docker方式，询问数据库模式（
```
一键安装
```
或
```
连接现有数据库
```
）。
若为Docker +
```
一键安装
```
，询问数据库类型（
```
PostgreSQL
```
、
```
MySQL
```
、
```
MariaDB
```
）。
若选择
```
连接现有数据库
```
（Docker/非Docker方式），确认连接信息已准备就绪，并要求在启动前编辑配置/环境变量。
仅执行安装操作；提供启动命令和验证步骤（不执行启动）。

在运行命令前，务必查阅
```
references/install-methods.md
```
并附上所选安装方式的文档链接。

Method Rule

方式规则

Docker is the default recommended method.
Use
```
create-nocobase-app
```
when user wants the fastest local bootstrap.
Use Git installation only when user needs source-level customization.

Docker是默认推荐的安装方式。
当用户希望最快完成本地启动时，使用
```
create-nocobase-app
```
。
仅当用户需要源码级定制时，才使用Git安装方式。

Mandatory Clarification Gate

强制确认环节

Do not run install/start commands before all required confirmations are collected.
Quick mode: release channel + installation directory.
Non-quick mode: installation method + release channel + installation directory.
Docker extra: database mode; and database type if
```
install together
```
.
Existing DB: connection info readiness confirmation.
If user says "you decide" in non-quick mode, choose Docker.

在收集到所有必要的确认信息前，不得运行安装/启动命令。
快速模式：需确认发布渠道 + 安装目录。
非快速模式：需确认安装方式 + 发布渠道 + 安装目录。
Docker额外要求：数据库模式；若为
```
一键安装
```
则还需确认数据库类型。
连接现有数据库：需确认连接信息已准备就绪。
若用户在非快速模式下表示“你决定”，则选择Docker方式。

Mandatory Doc-Read Gate

强制文档查阅环节

Do not run install/start commands before reading
```
references/install-methods.md
```
.
Do not run install/start commands unless the chosen method matches one method in
```
references/install-methods.md
```
, or quick mode preset is selected.
Include the exact method doc link from
```
references/install-methods.md
```
before running commands.
If method mapping is unclear, stop and ask a clarification question.

在查阅
```
references/install-methods.md
```
前，不得运行安装/启动命令。
除非所选方式与
```
references/install-methods.md
```
中的某一种匹配，或选择了快速模式预设，否则不得运行安装/启动命令。
在运行命令前，附上
```
references/install-methods.md
```
中对应方式的准确文档链接。
若方式对应关系不明确，停止操作并询问澄清问题。

Question Template

提问模板

Quick mode question: "Do you want quick mode (
```
Docker + PostgreSQL + install together
```
) so I execute install and startup directly?"
Method question: "Which NocoBase installation method do you want: Docker (recommended), create-nocobase-app, or Git?"
Version question: "Which release channel do you want to install: latest (stable), beta, or alpha?"
Directory question: "Please provide the target installation directory (for example
```
./my-nocobase
```
or
```
/opt/nocobase
```
)."
Docker database mode question: "For Docker installation, do you want to install database together in Docker, or connect to an existing database?"
Docker bundled DB type question: "For Docker + install together, which database type do you want to install: PostgreSQL, MySQL, or MariaDB?"
Existing DB readiness question: "Please confirm your existing database connection info is ready (host, port, database, username, password), and you can edit NocoBase config/env before startup."

快速模式提问：“是否使用快速模式（
```
Docker + PostgreSQL + 一键安装
```
），我将直接执行安装和启动操作？”
安装方式提问：“你想要哪种NocoBase安装方式：Docker（推荐）、create-nocobase-app，还是Git？”
版本提问：“你想要安装哪个发布渠道的版本：latest（稳定版）、beta，还是alpha？”
目录提问：“请提供目标安装目录（例如
```
./my-nocobase
```
或
```
/opt/nocobase
```
）。”
Docker数据库模式提问：“对于Docker安装，你想要在Docker中一键安装数据库，还是连接到现有数据库？”
Docker捆绑数据库类型提问：“对于Docker + 一键安装，你想要安装哪种数据库类型：PostgreSQL、MySQL，还是MariaDB？”
现有数据库就绪提问：“请确认你已准备好现有数据库的连接信息（主机、端口、数据库名、用户名、密码），并且可以在启动前编辑NocoBase的配置/环境变量。”

Resources

资源

Must read
```
references/install-methods.md
```
before generating commands.

在生成命令前，必须查阅
```
references/install-methods.md
```
。