安装

你可以通过 Docker Compose 评估 AuraBoot,也可以为开发目的手动运行。对于首次使用者,推荐使用 Docker 路径,因为它能让 PostgreSQL、Redis、后端与前端版本保持一致。

前置依赖

方式 A:Docker Compose

克隆仓库:

git clone https://github.com/AuraBootTeam/auraboot.git
cd auraboot

启动完整栈:

docker compose --profile full up --build -d

查看服务状态:

docker compose ps

预期的本地 endpoint:

Redis 不在 --profile full 里 —— 它属于 cache profile,评估 AuraBoot 时并不需要。

打开前端并使用本地管理员账号登录:

从预构建镜像运行

如果你只想运行 AuraBoot、不想从源码构建,可以直接拉取预构建镜像 —— 这样能跳过整个 Java + Node 构建。首次启动所需的一切都已烤进镜像(数据库 schema、后端插件),所以无需 git clone,只要两个文件:

curl -O https://raw.githubusercontent.com/AuraBootTeam/auraboot/main/docker-compose.pull.yml
curl -O https://raw.githubusercontent.com/AuraBootTeam/auraboot/main/scripts/quickstart.sh
docker compose -f docker-compose.pull.yml up -d
bash quickstart.sh

然后打开 http://localhost:3000,用 admin@auraboot.com / Test2026x 登录。

镜像为多架构(amd64 / arm64),发布在 GitHub Container Registry:

中国大陆 —— 改从腾讯云(TCR)镜像拉取,比 GHCR 快很多:

REGISTRY=ccr.ccs.tencentyun.com/auraboot-oss docker compose -f docker-compose.pull.yml up -d

Windows 部署

AuraBoot 在 Windows 上通过 Docker Desktop(WSL2 后端)运行。本页所有 docker compose 命令都原样可用 —— 唯一规则是 bash 脚本(quickstart.sh 及其他 scripts/*.sh)必须在 WSL 或 Git Bash 里运行,不能用 PowerShell 或 cmd。按下面步骤操作。

1. 安装 Docker Desktop(启用 WSL2 后端)

安装 Docker Desktop,在 Settings → General 里保持 "Use the WSL 2 based engine" 勾选(默认已勾选)。启动 Docker Desktop,等引擎显示 Running。

2. 准备一个 bash 终端

quickstart.sh 等 scripts/*.sh 是 bash 脚本 —— PowerShell 和 cmd 跑不了。任选其一:

• WSL(推荐):以管理员身份打开 PowerShell,运行 wsl --install,重启后打开 Ubuntu 终端。
• Git Bash:安装 Git for Windows,它自带 Git Bash。

下面所有命令都在那个 WSL 或 Git Bash 窗口里执行,而不是 PowerShell。

3. 启动 AuraBoot

从预构建镜像(推荐 —— 免构建、免 clone):

curl -O https://raw.githubusercontent.com/AuraBootTeam/auraboot/main/docker-compose.pull.yml
curl -O https://raw.githubusercontent.com/AuraBootTeam/auraboot/main/scripts/quickstart.sh
docker compose -f docker-compose.pull.yml up -d
bash quickstart.sh

中国大陆在 up 命令前加 REGISTRY=ccr.ccs.tencentyun.com/auraboot-oss,从腾讯云镜像拉取(见上一节)。

或从源码构建(如果你想自己构建):

git clone https://github.com/AuraBootTeam/auraboot.git
cd auraboot
docker compose --profile full up --build -d
bash scripts/quickstart.sh

quickstart.sh 不能跳过 —— 它创建管理员并导入插件。

4. 打开应用

start http://localhost:3000

(start 是 Windows 上等价于 macOS 的 open。)用 admin@auraboot.com / Test2026x 登录,然后修改密码。

不支持原生(非 Docker)Windows 主机部署:reset / init / build 工具链全是 bash,且仓库不提供 gradlew.bat —— 请始终走上面的 Docker Desktop 路径。

方式 B:手动开发环境

当你需要改动后端或前端代码并希望热重载时,手动配置更合适。

1. 创建数据库

createdb -U postgres aura_boot

请使用 PostgreSQL 16 或更高版本。动态 Model 运行时会在 bootstrap 与 Plugin 导入过程中创建元数据表和业务表。

2. 启动 Redis

redis-server

3. 启动后端

cd platform
cp src/main/resources/application-local.yml.example src/main/resources/application-local.yml
./gradlew bootRun

启动后端前,请用你的 PostgreSQL 与 Redis 连接信息更新 application-local.yml。

4. 启动前端

cd web-admin
pnpm install
pnpm dev:full

前端开发服务器与 BFF 层会一起运行。BFF 会把浏览器请求代理到后端,使本地开发尽可能贴近生产行为。

5. Bootstrap 平台

初始化(这一步不能跳过):

./scripts/quickstart.sh

docker compose up 只把服务拉起来就结束了 —— 它不创建管理员,也不导入插件。这个脚本两件都做,且幂等。

验证安装

检查后端健康状态:

curl http://localhost:3000/api/bootstrap/status

预期响应:

{
  "status": "UP"
}

检查 CLI 联通:

aura status

在浏览器中检查:

1. 打开 http://localhost:3000。
2. 以管理员身份登录。
3. 确认菜单可以渲染。
4. 打开一个生成的列表 Page 或 Plugin Page。

故障排查

需要更深入的本地开发,请参考 CLI 与 Plugin 开发。