Docker 部署

🚀 安装指南

前置要求

• Python 3.10+ • Git • Docker (可选，用于 Docker 部署)

原生安装

1. 克隆仓库：

   # Linux/MacOS
   git clone https://github.com/HKUDS/LightRAG.git
   cd LightRAG

   # Windows PowerShell
   git clone https://github.com/HKUDS/LightRAG.git
   cd LightRAG

2. 配置环境：

   # Linux/MacOS
   cp .env.example .env
   # 使用文本编辑器修改 .env 文件

   # Windows PowerShell
   Copy-Item .env.example .env
   # 使用文本编辑器修改 .env 文件

3. 创建并激活虚拟环境：

   # Linux/MacOS
   python -m venv venv
   source venv/bin/activate

   # Windows PowerShell
   python -m venv venv
   .\venv\Scripts\Activate

4. 安装依赖：

   # 全平台通用
   pip install -r requirements.txt

🐳 Docker 部署

以下 Docker 命令适用于已安装 Docker Desktop 的全平台：

1. 构建并启动容器：

   docker-compose up -d

配置选项

通过修改 .env 文件中的环境变量配置 LightRAG：

服务器配置

• HOST: 服务器地址 (默认: 0.0.0.0) • PORT: 服务端口 (默认: 9621)

LLM 配置

• LLM_BINDING: 使用的 LLM 后端 (lollms/ollama/openai) • LLM_BINDING_HOST: LLM 服务器地址 • LLM_MODEL: 使用的模型名称

嵌入模型配置

• EMBEDDING_BINDING: 嵌入模型后端 (lollms/ollama/openai) • EMBEDDING_BINDING_HOST: 嵌入模型服务器地址 • EMBEDDING_MODEL: 嵌入模型名称

RAG 配置

• MAX_ASYNC: 最大并发操作数 • MAX_TOKENS: 最大 token 数 • EMBEDDING_DIM: 嵌入向量维度 • MAX_EMBED_TOKENS: 最大嵌入 token 数

安全配置

• LIGHTRAG_API_KEY: API 访问密钥

数据存储路径

系统使用以下目录结构存储数据：

data/
├── rag_storage/    # RAG 持久化数据
└── inputs/         # 输入文档

部署示例

1. 使用 Ollama：

   LLM_BINDING=ollama
   LLM_BINDING_HOST=http://host.docker.internal:11434
   LLM_MODEL=mistral
   EMBEDDING_BINDING=ollama
   EMBEDDING_BINDING_HOST=http://host.docker.internal:11434
   EMBEDDING_MODEL=bge-m3

注意：Docker 容器内需使用 host.docker.internal 访问宿主机服务，该配置已包含在 docker-compose 文件中。

1. 使用 OpenAI：

   LLM_BINDING=openai
   LLM_MODEL=gpt-3.5-turbo
   EMBEDDING_BINDING=openai
   EMBEDDING_MODEL=text-embedding-ada-002
   OPENAI_API_KEY=your-api-key

API 使用

部署完成后，可通过 http://localhost:9621 访问 API

使用 PowerShell 查询示例：

$headers = @{
    "X-API-Key" = "your-api-key"
    "Content-Type" = "application/json"
}
$body = @{
    query = "your question here"
} | ConvertTo-Json
Invoke-RestMethod -Uri "http://localhost:9621/query" -Method Post -Headers $headers -Body $body

使用 curl 查询示例：

curl -X POST "http://localhost:9621/query" \
     -H "X-API-Key: your-api-key" \
     -H "Content-Type: application/json" \
     -d '{"query": "your question here"}'

🔒 安全注意事项

重要安全建议：

1. 生产环境务必设置高强度 API 密钥
2. 生产环境启用 SSL 加密
3. 配置适当的网络访问策略

📦 更新方法

更新 Docker 容器：

docker-compose pull
docker-compose up -d --build

更新原生安装：

# Linux/MacOS
git pull
source venv/bin/activate
pip install -r requirements.txt

# Windows PowerShell
git pull
.\venv\Scripts\Activate
pip install -r requirements.txt