From 8af8bd80d2883a8025d9dccad320ed6594ee13c8 Mon Sep 17 00:00:00 2001 From: yangdx Date: Wed, 29 Oct 2025 21:54:47 +0800 Subject: [PATCH] docs: add frontend build steps to server installation guide --- README-zh.md | 16 ++++++++++++---- README.md | 16 ++++++++++++---- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/README-zh.md b/README-zh.md index 867478bd..552d566a 100644 --- a/README-zh.md +++ b/README-zh.md @@ -104,18 +104,26 @@ lightrag-server git clone https://github.com/HKUDS/LightRAG.git cd LightRAG # 如有必要,创建Python虚拟环境 -# 以可编辑模式安装并支持API +# 以可开发(编辑)模式安装LightRAG服务器 pip install -e ".[api]" -cp env.example .env + +cp env.example .env # 使用你的LLM和Embedding模型访问参数更新.env文件 + +# 构建前端代码 +cd lightrag_webui +bun install --frozen-lockfile +bun run build +cd .. + lightrag-server ``` * 使用 Docker Compose 启动 LightRAG 服务器 -``` +```bash git clone https://github.com/HKUDS/LightRAG.git cd LightRAG -cp env.example .env +cp env.example .env # 使用你的LLM和Embedding模型访问参数更新.env文件 # modify LLM and Embedding settings in .env docker compose up ``` diff --git a/README.md b/README.md index 991f6b58..4603843e 100644 --- a/README.md +++ b/README.md @@ -103,19 +103,27 @@ lightrag-server ```bash git clone https://github.com/HKUDS/LightRAG.git cd LightRAG -# create a Python virtual enviroment if neccesary +# Create a Python virtual enviroment if neccesary # Install in editable mode with API support pip install -e ".[api]" -cp env.example .env + +cp env.example .env # Update the .env with your LLM and embedding configurations + +# Build front-end artifacts +cd lightrag_webui +bun install --frozen-lockfile +bun run build +cd .. + lightrag-server ``` * Launching the LightRAG Server with Docker Compose -``` +```bash git clone https://github.com/HKUDS/LightRAG.git cd LightRAG -cp env.example .env +cp env.example .env # Update the .env with your LLM and embedding configurations # modify LLM and Embedding settings in .env docker compose up ```