Skip to content

Commit 324242a

Browse files
committed
Update installation instructions for env file setup
* Clarify env.example file source * Remove redundant CLI tool note * Improve setup instructions clarity * Update both EN and ZH documentation
1 parent 3304e19 commit 324242a

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README-zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,13 +135,13 @@ bun run build
135135
cd ..
136136

137137
# 配置 env 文件
138+
# 从 GitHub 仓库的根目录上下载 env.example 文件
139+
# 或从本地检出的源代码中获取 env.example 文件
138140
cp env.example .env # 使用你的LLM和Embedding模型访问参数更新.env文件
139141
# 启动API-WebUI服务
140142
lightrag-server
141143
```
142144

143-
注意:运行 `lightrag-server` 时会从当前工作目录读取 `.env`。如果你是通过全局工具安装(例如 `uv tool install "lightrag-hku[api]"`),本地目录不会包含 `env.example`。此时请手动创建 `.env`,或从源码仓库中复制 `env.example`
144-
145145
* 从源代码安装
146146

147147
```bash

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ bun install --frozen-lockfile
134134
bun run build
135135
cd ..
136136

137-
# setup env file
137+
# Setup env file
138+
# Obtain the env.example file by downloading it from the GitHub repository root
139+
# or by copying it from a local source checkout.
138140
cp env.example .env # Update the .env with your LLM and embedding configurations
139141
# Launch the server
140142
lightrag-server
141143
```
142144

143-
Note: `.env` is read from the current working directory when you run `lightrag-server`. If you installed the CLI as a global tool (for example, `uv tool install "lightrag-hku[api]"`), `env.example` is not present locally. In that case, create `.env` manually or copy `env.example` from a source checkout.
144-
145145
* Installation from Source
146146

147147
```bash

0 commit comments

Comments
 (0)