WAAS

环境要求

• Python 3（本地安装方式需 python3 与 venv）
• Docker 与 docker-compose（推荐部署方式，会启动 redis、api、worker 三个容器）
• 一个可用的 SMTP 邮箱账号，用于发送转写结果邮件
• 可选：NVIDIA GPU + nvidia-docker，用于加速 Whisper 转写
• 可选：本地 Redis（在容器外跑测试时需要）

安装与启动步骤

1. 1克隆项目仓库

   把 WAAS 源码拉到本地，进入项目目录，后续命令都在此目录执行。

   git clone https://github.com/schibsted/WAAS.git
   cd WAAS

   复制

2. 2本地安装依赖

   README 给出的本地安装方式：创建 venv 虚拟环境并安装 requirements.txt 依赖。

   python3 -mvenv .venv
   source .venv/bin/activate
   pip install -r requirements.txt

   复制

3. 3创建 .envrc 配置

   在项目根目录创建 .envrc，填好站点地址、发信邮箱、SMTP 主机与免责声明等变量。

   export BASE_URL=https://example.com
   export EMAIL_SENDER_ADDRESS=example@example.com
   export EMAIL_SENDER_PASSWORD=example
   export EMAIL_SENDER_HOST=smtp.example.com
   export DISCLAIMER='This is a <a href="example.com">disclaimer</a>'
   export ALLOWED_WEBHOOKS_FILE='allowed_webhooks.json'
   export LOG_EMAIL=true

   复制

4. 4配置 webhook 白名单

   在项目根目录新建 allowed_webhooks.json（该文件被 git 忽略），列出合法 webhook 的 url 和你生成的 token。

   [
     {
       "id": "77c500b2-0e0f-4785-afc7-f94ed529c897",
       "url": "https://myniceserver.com/mywebhook",
       "token": "frKPI6p5LxxpJa8tCvVr=u5NvU66EJCQdybPuEmzKNeyCDul2-zrOx05?LwIhL5N"
     }
   ]

   复制

5. 5用 compose 启动

   以 .envrc 作为环境变量文件启动整套服务，会拉起 redis、api（flask）、worker（rq）三个容器。

   docker-compose --env-file .envrc up

   复制

6. 6启用 GPU 加速

   可选：有 NVIDIA GPU 时把 docker-compose.yml 的 dockerfile 改为 Dockerfile.gpu，并取消 devices 设备预留注释后重新启动。

   docker-compose --env-file .envrc up

   复制

7. 7运行测试

   可选：在容器内直接执行 pytest；在容器外测试需先启动 Redis 并传入环境变量。

   pytest

   复制

关键配置

如何确认成功

docker-compose 日志显示 redis、api、worker 三个容器正常启动，浏览器打开 BASE_URL 能进入 Jojo 上传界面。

常见问题

注意事项

• allowed_webhooks.json 会被 git 忽略，需自行在项目根目录创建，勿提交含真实 token 的文件。
• 用 webhook.site 做测试可以，但不要提交或转写隐私数据。
• docker-compose 会同时启动 redis、api、worker 三个容器，缺一不可。
• Jojo 前端编辑器在浏览器本地运行，校对内容不会上传服务器。