BettaFish

环境要求

• Python 3 环境（源码方式运行需要）
• Docker 与 Docker Compose（使用 Docker 方式启动时需要）
• PostgreSQL 数据库（也支持自行改为 MySQL）
• 兼容 OpenAI 接口格式的大模型 API 密钥
• PDF 导出可选依赖：weasyprint 所需系统库，不装则 PDF 功能不可用

安装与启动步骤

1. 1获取项目源码

   把 BettaFish 仓库克隆到本地，之后所有命令都在项目根目录下执行。

   git clone https://github.com/666ghj/BettaFish.git

   复制

2. 2准备 Python 环境

   README 中 Conda 与 uv 两种方式只给了章节占位，未给出具体创建命令，请按自己习惯创建并激活 Python 环境。

3. 3安装依赖包

   在项目根目录安装 requirements.txt 中的依赖；README 提示用 uv pip install 安装更快。

   pip install -r requirements.txt

   复制

4. 4安装浏览器驱动

   爬虫功能依赖 Playwright，需要单独安装 Chromium 驱动。

   playwright install chromium

   复制

5. 5配置 .env 文件

   复制 .env.example 为 .env，按下方配置项填写数据库连接信息与所有大模型 API 密钥。

   cp .env.example .env

   复制

6. 6启动完整系统

   在项目根目录启动主应用，一次运行结束后若端口被占用需手动结束占用进程。

   python app.py

   复制

7. 7单独启动 Agent

   只想调试某个智能体时，可用 streamlit 分别拉起 QueryEngine(8503)、MediaEngine(8502)、InsightEngine(8501)。

   streamlit run SingleEngineApp/query_engine_streamlit_app.py --server.port 8503

   复制

8. 8Docker 一键启动

   已装 Docker 的用户复制好 .env 后，用一条命令后台启动全部服务；镜像慢可换用 compose 文件里注释的备用地址。

   docker compose up -d

   复制

关键配置

如何确认成功

打开 http://localhost:5000 能看到系统界面即成功；Docker 方式可用 docker compose ps 查看服务。

常见问题

注意事项

• 所有 LLM 调用统一使用 OpenAI 的 API 接口标准，也可换成兼容该格式的其他模型或搜索代理。
• .env.example 和 config.py 中给出了每个 Agent 的推荐 LLM，初次部署请先按推荐设置配置。
• 若跳过 PDF 导出所需系统依赖，weasyprint 可能安装失败，PDF 导出功能将无法正常使用。
• 高级配置已统一到项目根目录的 .env 文件管理，其他子 Agent 会自动继承根目录配置。