Update README with Detailed WebUI Service Launch Instructions (#694)
Browse files### What problem does this PR solve?
Improve README by detailing Launch Service from Source section
This commit enhances the README document by adding comprehensive steps
for running the WebUI service in the 'Launch Service from Source'
section. It aims to provide clearer guidance for users attempting to
start the service from the source code, making the setup process more
accessible and understandable.
Key changes include:
- Detailed instructions for setting up and running the WebUI service.
- Necessary prerequisites for launching the service from source.
This update ensures that users have all the information they need to
successfully launch the service, improving the overall usability of our
project.
### Type of change
- [x] Documentation Update
- README.md +23 -0
- README_zh.md +21 -0
README.md
CHANGED
@@ -249,6 +249,29 @@ $ chmod +x ./entrypoint.sh
|
|
249 |
$ bash ./entrypoint.sh
|
250 |
```
|
251 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
252 |
## 📚 Documentation
|
253 |
|
254 |
- [FAQ](./docs/faq.md)
|
|
|
249 |
$ bash ./entrypoint.sh
|
250 |
```
|
251 |
|
252 |
+
7. Start the WebUI service
|
253 |
+
```bash
|
254 |
+
$ cd web
|
255 |
+
$ npm install --registry=https://registry.npmmirror.com --force
|
256 |
+
$ vim .umirc.ts
|
257 |
+
# Modify proxy.target to 127.0.0.1:9380
|
258 |
+
$ npm run dev
|
259 |
+
```
|
260 |
+
|
261 |
+
8. Deploy the WebUI service
|
262 |
+
```bash
|
263 |
+
$ cd web
|
264 |
+
$ npm install --registry=https://registry.npmmirror.com --force
|
265 |
+
$ umi build
|
266 |
+
$ mkdir -p /ragflow/web
|
267 |
+
$ cp -r dist /ragflow/web
|
268 |
+
$ apt install nginx -y
|
269 |
+
$ cp ../docker/nginx/proxy.conf /etc/nginx
|
270 |
+
$ cp ../docker/nginx/nginx.conf /etc/nginx
|
271 |
+
$ cp ../docker/nginx/ragflow.conf /etc/nginx/conf.d
|
272 |
+
$ systemctl start nginx
|
273 |
+
```
|
274 |
+
|
275 |
## 📚 Documentation
|
276 |
|
277 |
- [FAQ](./docs/faq.md)
|
README_zh.md
CHANGED
@@ -247,7 +247,28 @@ $ docker compose -f docker-compose-base.yml up -d
|
|
247 |
$ chmod +x ./entrypoint.sh
|
248 |
$ bash ./entrypoint.sh
|
249 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
250 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
251 |
## 📚 技术文档
|
252 |
|
253 |
- [FAQ](./docs/faq.md)
|
|
|
247 |
$ chmod +x ./entrypoint.sh
|
248 |
$ bash ./entrypoint.sh
|
249 |
```
|
250 |
+
7. 启动WebUI服务
|
251 |
+
```bash
|
252 |
+
$ cd web
|
253 |
+
$ npm install --registry=https://registry.npmmirror.com --force
|
254 |
+
$ vim .umirc.ts
|
255 |
+
# 修改proxy.target为127.0.0.1:9380
|
256 |
+
$ npm run dev
|
257 |
+
```
|
258 |
|
259 |
+
8. 部署WebUI服务
|
260 |
+
```bash
|
261 |
+
$ cd web
|
262 |
+
$ npm install --registry=https://registry.npmmirror.com --force
|
263 |
+
$ umi build
|
264 |
+
$ mkdir -p /ragflow/web
|
265 |
+
$ cp -r dist /ragflow/web
|
266 |
+
$ apt install nginx -y
|
267 |
+
$ cp ../docker/nginx/proxy.conf /etc/nginx
|
268 |
+
$ cp ../docker/nginx/nginx.conf /etc/nginx
|
269 |
+
$ cp ../docker/nginx/ragflow.conf /etc/nginx/conf.d
|
270 |
+
$ systemctl start nginx
|
271 |
+
```
|
272 |
## 📚 技术文档
|
273 |
|
274 |
- [FAQ](./docs/faq.md)
|