Update README

This commit is contained in:
yangdx
2025-05-14 11:29:46 +08:00
parent 313b7d5423
commit db125c3764
4 changed files with 102 additions and 48 deletions

View File

@@ -48,11 +48,21 @@ pip install "lightrag-hku[api]"
* 从源代码安装
```bash
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
# 如有必要创建Python虚拟环境
# 以可编辑模式安装并支持API
pip install -e ".[api]"
```
* 使用 Docker Compose 启动 LightRAG 服务器
```
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
docker compose up
```
### 安装LightRAG Core
* 从源代码安装(推荐)

View File

@@ -84,11 +84,21 @@ pip install "lightrag-hku[api]"
* Installation from Source
```bash
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
# create a Python virtual enviroment if neccesary
# Install in editable mode with API support
pip install -e ".[api]"
```
* Launching the LightRAG Server with Docker Compose
```
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
docker compose up
```
### Install LightRAG Core
* Install from source (Recommend)
@@ -108,7 +118,7 @@ pip install lightrag-hku
### Quick Start for LightRAG Server
For more information about LightRAG Server, please refer to [LightRAG Server](./lightrag/api/README.md).
* For more information about LightRAG Server, please refer to [LightRAG Server](./lightrag/api/README.md).
### Quick Start for LightRAG core

View File

@@ -102,9 +102,26 @@ lightrag-gunicorn --workers 4
- `--log-level`日志级别默认INFO
- --input-dir指定要扫描文档的目录默认./input
> ** 要求将.env文件置于启动目录中是经过特意设计的**。 这样做的目的是支持用户同时启动多个LightRAG实例并为不同实例配置不同的.env文件。
> - **要求将.env文件置于启动目录中是经过特意设计的**。 这样做的目的是支持用户同时启动多个LightRAG实例并为不同实例配置不同的.env文件。
> - **修改.env文件后您需要重新打开终端以使新设置生效**。 这是因为每次启动时LightRAG Server会将.env文件中的环境变量加载至系统环境变量且系统环境变量的设置具有更高优先级。
> **修改.env文件后您需要重新打开终端以使新设置生效**。 这是因为每次启动时LightRAG Server会将.env文件中的环境变量加载至系统环境变量且系统环境变量的设置具有更高优先级。
### 使用 Docker Compose 启动 LightRAG 服务器
* 克隆代码仓库:
```
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
```
* 配置 .env 文件:
通过复制 env.example 文件创建个性化的 .env 文件,并根据实际需求设置 LLM 及 Embedding 参数。
* 通过以下命令启动 LightRAG 服务器:
```
docker compose up
# 如拉取了新版本,请添加 --build 重新构建
docker compose up --build
```
### 启动时自动扫描

View File

@@ -104,9 +104,26 @@ Here are some commonly used startup parameters:
- `--log-level`: Logging level (default: INFO)
- `--input-dir`: Specifying the directory to scan for documents (default: ./inputs)
> The requirement for the .env file to be in the startup directory is intentionally designed this way. The purpose is to support users in launching multiple LightRAG instances simultaneously, allowing different .env files for different instances.
> - The requirement for the .env file to be in the startup directory is intentionally designed this way. The purpose is to support users in launching multiple LightRAG instances simultaneously, allowing different .env files for different instances.
> - **After changing the .env file, you need to open a new terminal to make the new settings take effect.** This because the LightRAG Server will load the environment variables from .env into the system environment variables each time it starts, and LightRAG Server will prioritize the settings in the system environment variables.
> **After changing the .env file, you need to open a new terminal to make the new settings take effect.** This because the LightRAG Server will load the environment variables from .env into the system environment variables each time it starts, and LightRAG Server will prioritize the settings in the system environment variables.
### Launching the LightRAG Server with Docker Compose
* Clone the repository:
```
git clone https://github.com/HKUDS/LightRAG.git
cd LightRAG
```
* Prepare the .env file:
Create a personalized .env file by duplicating env.example. Configure the LLM and embedding parameters according to your requirements.
* Start the LightRAG Server using the following commands:
```
docker compose up
# Use --build if you have pulled a new version
docker compose up --build
```
### Auto scan on startup