快速开始

登录页

从一台干净的机器,到一个你真的能登进去、并且里面已经有一套 CRM 的 AuraBoot —— 十五分钟。

前置条件

  • Docker Desktop 或带 Compose v2 的 Docker Engine
  • Git 和浏览器
  • curlpython3 —— macOS 和多数 Linux 发行版都自带;scripts/quickstart.sh 会用到

只想跑起来、不想构建? 直接拉预构建镜像,不必 clone + build —— 见安装页的「从预构建镜像运行」一节。中国大陆用户可从更快的腾讯云镜像拉取。Windows 用户请在 WSL 或 Git Bash 里运行下面的脚本。

1. 克隆并启动

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

冷启动需要 2–4 分钟(后端健康检查有 120 秒的启动宽限期)。full profile 只启动三个服务:

服务作用
PostgreSQL存元数据与业务记录
Spring Boot 后端元数据注册表、命令执行、插件导入
前端 / BFF浏览器界面与 API 代理

Redis、MinIO 和监控栈不在 full 里 —— 它们分别属于 cachestoragemonitoring profile,评估 AuraBoot 时并不需要。

等后端变成 healthy:

docker compose ps

2. 初始化

./scripts/quickstart.sh

这一步不能跳过。 docker compose up 只负责把服务拉起来,就结束了 —— 它不会创建管理员,也不会导入任何插件。跳过它,第 3 步的登录会直接报 "Invalid username or password",因为那个账号根本还不存在。

脚本会等后端就绪、创建管理员,并按依赖顺序导入插件集:

✓ backend is up
✓ admin created — admin@auraboot.com
✓ logged in
Importing plugins …
  ✓ core-meta
  ✓ core-bpm
  · core-decisionops (will retry)
  ...
  ✓ core-decisionops (retry)

AuraBoot is ready.

脚本是幂等的,随时可以重跑。

想手动做?

脚本其实就是两个 API 调用加一个循环。管理员来自显式的 bootstrap 端点:

curl -X POST http://localhost:3000/api/bootstrap/setup \
  -H 'Content-Type: application/json' \
  -d '{"companyName":"AuraBoot","adminEmail":"admin@auraboot.com",
       "adminPassword":"Test2026x","adminDisplayName":"Admin User",
       "systemMode":"single"}'

然后登录换取 JWT,对每个插件调一次 POST /api/plugins/import/import-directory-sync,body 为 {"path":"/app/plugins/<name>","conflictStrategy":"OVERWRITE"}

AuraBoot 从不在应用启动阶段写入 bootstrap 数据。初始化永远是一次显式、可审计的调用 —— 所以它是一个你主动执行的步骤,而不是悄悄发生在你身上的魔法。

3. 登录

打开 http://localhost:3000

字段
邮箱admin@auraboot.com
密码Test2026x

只要这个实例别人能访问到,就立刻改掉这个密码。

4. 确认你拿到的是一个真平台

此时你应该有大约 41 个模型109 个菜单 —— 而不是一个空壳。

  1. 侧边栏渲染出菜单:CRM、Page Manager、Platform Admin 等等。
  2. 打开 CRM → 线索。这个列表页、它的列、它的表单,全部由 crm_lead 的模型定义生成 —— 没有人手写过这个页面。
  3. 新建一条记录,能保存。
curl http://localhost:3000/api/bootstrap/status   # {"initialized": true}

(只有前端被映射出来 —— docker compose 从不把 backend 的 6443 映射到宿主机。/api/* 由 BFF 代理过去,这也是这里所有 URL 都是 :3000 的原因。)

如果侧边栏是空的,说明 scripts/quickstart.sh 没跑完。重跑一次,它会告诉你是哪个插件失败了。

5. 现在动手做点东西

AuraBoot 的要点在于:模型、页面、命令、权限都是你放在 Git 里的声明;而任何一次业务写操作 —— 无论来自人、自动化还是 AI agent —— 都走同一条权限、校验与审计通路。

要真正体会到这一点,最快的方式是自己做一个:

  • 你的第一次受治理变更 —— 十分钟。加一个字段,看着平台拒绝写入你没声明过的东西,再读一遍审计记录。从这里开始。
  • 创建第一个 Model —— 同样的闭环,但这次由你从零写模型。
  • 搭建 CRM —— 同一个闭环,七章走完:模型 → 页面 → 权限 → 流程 → 看板 → 移动端 → 发布。
  • 纯配置 Plugin —— 完全不写 Java 能走多远。

排障

现象原因
Invalid username or passwordscripts/quickstart.sh 还没跑。跑之前不存在管理员账号。
登录进去了,但侧边栏是空的插件导入没完成。重跑脚本,它会指出失败的插件。
5432 端口被占POSTGRES_PORT=15432 docker compose --profile full up --build -d
后端一直不 healthydocker compose logs backend。出现 JWT secret is the default dev key 说明 JWT_SECRET 被覆盖成了不足 32 个字符的值。