whodb

环境要求

• 已安装 Docker（容器方式运行）
• 浏览器（访问 Web 界面）
• 目标数据库的连接信息（地址、账号、密码）
• Node.js 与 npm（仅 CLI 安装方式需要）

安装与启动步骤

1. 1Docker 一键启动

   拉取并运行官方 WhoDB 镜像，映射 8080 端口；--rm 表示容器退出即删除，适合快速试用。

   docker run --rm -it -p 8080:8080 clidey/whodb

   复制

2. 2打开浏览器访问

   在浏览器打开 http://localhost:8080，按页面提示填入数据库连接信息即可开始使用。

3. 3生成加密密钥

   如需在容器被替换后保留加密的登录会话，先生成 64 位十六进制密钥并妥善保存。

   openssl rand -hex 32

   复制

4. 4持久化启动容器

   把 whodb-data 卷挂载到 /data，并传入上一步保存的密钥，会话便不会随容器丢失。

   docker run -it -p 8080:8080 
     -v whodb-data:/data 
     -e WHODB_ENCRYPTION_KEY=your_saved_64_character_hex_key 
     clidey/whodb

   复制

5. 5HTTPS 反代加参数

   若通过 HTTPS 反向代理访问，额外设置 WHODB_SECURE=true，浏览器才只在 HTTPS 下发送会话 Cookie。

   docker run -it -p 8080:8080 
     -v whodb-data:/data 
     -e WHODB_ENCRYPTION_KEY=your_saved_64_character_hex_key 
     -e WHODB_SECURE=true 
     clidey/whodb

   复制

6. 6安装 CLI（可选）

   不用 Docker 时，可用 npm 全局安装 @clidey/whodb，获得终端 UI 与 MCP 服务能力。

   npm install -g @clidey/whodb

   复制

7. 7使用 CLI 命令

   执行 whodb 打开终端界面；执行 whodb mcp serve 启动 MCP 服务器。

   whodb
   whodb mcp serve

   复制

关键配置

如何确认成功

浏览器打开 http://localhost:8080 能看到 WhoDB 界面，并能填入数据库连接信息。

常见问题

注意事项

• WHODB_ENCRYPTION_KEY 请保存在安全位置，更换密钥会使已有登录会话全部失效。
• AI 功能为可选，未配置任何提供商时仍可浏览编辑数据和执行查询。
• Docker Compose、连接配置档、SSL、AI 提供商等更多配置请见官方文档 https://docs.whodb.com/。