跳转到内容

安装

basedb 只需一个 Docker 镜像:eodia/basedb(amd64 和 arm64),其中包含界面、API 和 MCP 服务器,通过同一个地址提供服务。它需要一个 PostgreSQL 16 数据库,docker-compose.yml 已提供。

前提条件:Docker 及 Compose v2。只需两个文件,无需源代码:

Fenêtre de terminal
mkdir basedb && cd basedb
curl -fsSLO https://raw.githubusercontent.com/eodia/basedb/main/docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/eodia/basedb/main/.env.example -o .env

打开 .env,填写仅有的两个必填值:

Fenêtre de terminal
POSTGRES_PASSWORD=un-mot-de-passe-solide
# 只需生成一次,长期使用:openssl rand -base64 32
BASEDB_ENCRYPTION_KEY=…

然后启动:

Fenêtre de terminal
docker compose up -d

首次启动时,basedb 会创建其目录(catalog)。随后打开 http://localhost:3000:第一个页面会请您创建管理员账户,填写您的姓名、邮箱地址和自选的密码,完成后即自动登录。

如需无人值守安装,可在 .env 中用 BASEDB_ADMIN_EMAIL 指定管理员:basedb 会在首次启动时创建该账户,并在日志(docker compose logs basedb)中仅显示一次其密码,除非您用 BASEDB_ADMIN_PASSWORD 自行设定。

地址用途
http://localhost:3000界面
http://localhost:3000/apiREST API 及其文档
http://localhost:3000/mcpMCP 服务器,供智能体使用
localhost:5432PostgreSQL,供 psql 和您的工具使用

端口仅发布在 127.0.0.1 上。如需通过域名提供 basedb,请参见域名与 HTTPS。

只需镜像本身,再加一个 PostgreSQL 16 或更高版本的数据库(使用该数据库的所有者角色,并且 pg_trgm 和 unaccent 扩展可用):

Fenêtre de terminal
docker run -d --name basedb -p 3000:3000 -v basedb-files:/data \
-e DATABASE_URL=postgres://basedb:secret@db.example.com:5432/basedb \
-e BASEDB_ENCRYPTION_KEY="$(openssl rand -base64 32)" \
eodia/basedb

请保存生成的密钥:参见下方提示框。

前提条件:Node 22 或更高版本、Docker,以及 corepack enable。

Fenêtre de terminal
corepack pnpm install
corepack pnpm exec tsc -b packages/naming packages/contracts packages/catalog-schema packages/core apps/api apps/mcp
corepack pnpm start

pnpm start 会选择空闲端口,启动一个临时的 PostgreSQL 16,应用目录,初始化一个开发用管理员(admin@basedb.local / developpement-basedb,登录时已预填邮箱地址),然后以开发模式启动 API、MCP 服务器和界面。按 Ctrl+C 会停止全部服务,包括容器。

  • 快速上手:一个数据库、一张数据表、一个视图、一个表单。
  • 环境变量:文件、AI、地址。

basedb 是 AI 原生软件工作室 Eodia 出品的自由软件。