vexa

环境要求

• Docker 与 Docker Compose（自托管用 make all / make lite）
• 一台 Linux 主机（make all 通过 Docker Compose 在单台 Linux 主机上拉起全栈）
• 想自建实时转录时，需要一台带 GPU 的机器运行 STT 服务
• 托管 SaaS 方式无需安装，只需在 vexa.ai 注册账号并获取 API Key

安装与启动步骤

1. 1云端快速体验

   不想安装可先用官方托管服务：在 vexa.ai/signin 登录，从账户页复制 API Key，然后直接调用接口让机器人入会。

   curl -X POST "https://api.cloud.vexa.ai/bots" \
     -H "X-API-Key: sk-xxxxxxxx" \
     -H "Content-Type: application/json" \
     -d '{"platform":"google_meet","native_meeting_id":"abc-defg-hij","bot_name":"Vexa"}'

   复制

2. 2获取项目代码

   自托管需要本地有这个检出（make dev 会从当前检出构建），先把仓库克隆下来并进入目录。

   git clone https://github.com/Vexa-ai/vexa.git
   cd vexa

   复制

3. 3启动完整栈

   make all 会用 Docker Compose 在一台 Linux 主机上拉起网关、终端、meeting-api、agent-api、runtime、redis、postgres、minio 等全部服务。

   make all

   复制

4. 4或用轻量单容器

   只需要最简部署时，可用 all-in-one 的 Vexa Lite 镜像，一条命令起单容器版本。

   make lite

   复制

5. 5配置运行时与密钥

   编辑 .env：RUNTIME_BACKEND 选 docker（默认）或 k8s；多用户场景下其他用户的请求必须使用 API Key，不能共用个人订阅凭据。

6. 6部署 GPU 转录服务

   make all 本身不含 GPU；需在任意 GPU 机器上用 deploy/transcription 部署 faster-whisper（OpenAI 兼容）STT 服务，并在 .env 中指向它。测试期也可改用 vexa.ai/acc

7. 7访问并冒烟验证

   终端工作台默认在本机 13000 端口（gateway 为 18056，均绑定 loopback），浏览器打开后可用 make probe 跑一遍全流程冒烟测试。

   make probe

   复制

关键配置

如何确认成功

浏览器访问终端工作台 http://localhost:13000（gateway 在 18056）；或执行 make probe 跑全流程冒烟测试通过。

常见问题

注意事项

• make all 需在一台 Linux 主机上运行，各服务分别在独立容器中并绑定 loopback。
• 生产环境请通过带 TLS 的反向代理对外暴露 Terminal。
• 目标命令包括 make all（拉取镜像）、make dev（从本地检出构建）、make lite、make probe、make down、make help。
• Kubernetes/OpenShift 大规模部署使用 deploy/helm 下的 Helm chart，并设置 RUNTIME_BACKEND=k8s；沙箱化知识代理仅支持自托管。