快速入门

安装

必要条件

step1: 下载本项目

git clone https://github.com/netease-youdao/QAnything.git

step2: 进入项目根目录执行启动命令

• 执行 docker compose 启动命令
• 启动过程大约需要30秒左右，当日志输出”qanything后端服务已就绪!”后，启动完毕！

  cd QAnything
  # 在 Linux 上启动
  docker compose -f docker-compose-linux.yaml up
  # 在 Mac 上启动
  docker compose -f docker-compose-mac.yaml up
  # 在 Windows 上启动
  docker compose -f docker-compose-win.yaml up

（注意）如果启动失败，可以尝试将 docker compose改为 docker-compose。
（注意）镜像手动下载地址：

• win
• mac
• linux
  加载方式：

  docker load -i qanything_xxx.tar

step3: 开始体验

前端页面

运行成功后，即可在浏览器输入以下地址进行体验。

• 前端地址: http://localhost:8777/qanything/

API

如果想要访问API接口，请参考下面的地址:

• API address: http://localhost:8777/api/
• For detailed API documentation, please refer to QAnything API 文档

DEBUG

如果想要查看服务启动相关日志，请查看QAnything/logs/debug_logs目录下的日志文件。

• debug.log
  • 用户请求处理日志
• main_server.log
  • 后端服务运行日志
• rerank_server.log
  • rerank服务运行日志
• ocr_server.log
  • OCR服务运行日志
• embedding_server.log
  • 向量化服务运行日志
• rerank_server.log
  • 检索增强服务运行日志
• insert_files_server.log
  • 文件上传服务运行日志
• pdf_parser_server.log
  • pdf解析服务运行日志

    详细上传文件日志请查看QAnything/logs/insert_logs目录下的日志文件。

    详细问答日志请查看QAnything/logs/qa_logs目录下的日志文件。

    详细embedding日志请查看QAnything/logs/embed_logs目录下的日志文件。

    详细rerank日志请查看QAnything/logs/rerank_logs目录下的日志文件。

关闭服务

# 前台启动服务方式如下：
docker compose -f docker-compose-xxx.yaml up # 关闭服务请按Ctrl+C
# 后台启动服务方式如下：
docker compose -f docker-compose-xxx.yaml up -d  # 关闭服务请执行以下命令
docker compose -f docker-compose-xxx.yaml down

离线使用

如果您想要离线使用QAnything，需要在断网机器提前部署本地的大模型（推荐使用ollama），随后可以使用以下命令启动服务。

windows离线使用

# 先在联网机器上下载docker镜像
docker pull quay.io/coreos/etcd:v3.5.5
docker pull minio/minio:RELEASE.2023-03-20T20-16-18Z
docker pull milvusdb/milvus:v2.4.8
docker pull mysql:8.4
docker pull docker.elastic.co/elasticsearch/elasticsearch:8.13.2
docker pull xixihahaliu01/qanything-win:v1.5.1  # 从 [https://github.com/netease-youdao/QAnything/blob/master/docker-compose-windows.yaml#L103] 中获取最新镜像版本号。

# 打包镜像
docker save quay.io/coreos/etcd:v3.5.5 minio/minio:RELEASE.2023-03-20T20-16-18Z milvusdb/milvus:v2.4.8 mysql:8.4 docker.elastic.co/elasticsearch/elasticsearch:8.13.2 xixihahaliu01/qanything-win:v1.5.1 -o qanything_offline.tar

# 下载QAnything代码
wget https://github.com/netease-youdao/QAnything/archive/refs/heads/master.zip

# 把镜像qanything_offline.tar和代码QAnything-master.zip拷贝到断网机器上
cp QAnything-master.zip qanything_offline.tar /path/to/your/offline/machine

# 在断网机器上加载镜像
docker load -i qanything_offline.tar

# 解压代码，运行
unzip QAnything-master.zip
cd QAnything-master
docker compose -f docker-compose-win.yaml up

Linux离线使用

# 先在联网机器上下载docker镜像
docker pull quay.io/coreos/etcd:v3.5.5
docker pull minio/minio:RELEASE.2023-03-20T20-16-18Z
docker pull milvusdb/milvus:v2.4.8
docker pull mysql:8.4
docker pull docker.elastic.co/elasticsearch/elasticsearch:8.13.2
docker pull xixihahaliu01/qanything-linux:v1.5.1  # 从 [https://github.com/netease-youdao/qanything/blob/master/docker-compose-linux.yaml#L104] 中获取最新镜像版本号。

# 打包镜像
docker save quay.io/coreos/etcd:v3.5.5 minio/minio:RELEASE.2023-03-20T20-16-18Z milvusdb/milvus:v2.4.8 mysql:8.4 docker.elastic.co/elasticsearch/elasticsearch:8.13.2 xixihahaliu01/qanything-linux:v1.5.1 -o qanything_offline.tar

# 下载QAnything代码
wget https://github.com/netease-youdao/QAnything/archive/refs/heads/master.zip

# 把镜像qanything_offline.tar和代码QAnything-master.zip拷贝到断网机器上
cp QAnything-master.zip qanything_offline.tar /path/to/your/offline/machine

# 在断网机器上加载镜像
docker load -i qanything_offline.tar

# 解压代码，运行
unzip QAnything-master.zip
cd QAnything-master
docker compose -f docker-compose-linux.yaml up