writinwaters commited on
Commit
e57dead
·
1 Parent(s): 360c75c

Updated FAQ and Upgrade guide (#3636)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

docs/guides/upgrade_ragflow.mdx CHANGED
@@ -7,7 +7,11 @@ slug: /upgrade_ragflow
7
  import Tabs from '@theme/Tabs';
8
  import TabItem from '@theme/TabItem';
9
 
10
- ## Upgrade RAGFlow to `dev`, the most recent, tested Docker image
 
 
 
 
11
 
12
  1. Clone the repo
13
 
@@ -15,11 +19,29 @@ import TabItem from '@theme/TabItem';
15
  git clone https://github.com/infiniflow/ragflow.git
16
  ```
17
 
18
- 2. Update **ragflow/docker/.env** as follows:
19
 
20
- ```bash
21
- RAGFLOW_IMAGE=infiniflow/ragflow:dev
22
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
 
24
  3. Update RAGFlow image and restart RAGFlow:
25
 
@@ -28,7 +50,7 @@ import TabItem from '@theme/TabItem';
28
  docker compose -f docker/docker-compose.yml up -d
29
  ```
30
 
31
- ## Upgrade RAGFlow to `latest`, the most recent, officially published release
32
 
33
  1. Clone the repo
34
 
@@ -45,7 +67,7 @@ import TabItem from '@theme/TabItem';
45
  3. Update **ragflow/docker/.env** as follows:
46
 
47
  ```bash
48
- RAGFLOW_IMAGE=infiniflow/ragflow:latest
49
  ```
50
 
51
  4. Update the RAGFlow image and restart RAGFlow:
 
7
  import Tabs from '@theme/Tabs';
8
  import TabItem from '@theme/TabItem';
9
 
10
+ Upgrade RAGFlow to `dev-slim`/`dev` or the latest, published release.
11
+
12
+ ## Upgrade RAGFlow to `dev-slim`/`dev`, the most recent, tested Docker image
13
+
14
+ `dev-slim` refers to the RAGFlow Docker image *without* embedding models, while `dev` refers to the RAGFlow Docker image with embedding models. For details on their differences, see **docker/.env**.
15
 
16
  1. Clone the repo
17
 
 
19
  git clone https://github.com/infiniflow/ragflow.git
20
  ```
21
 
22
+ 2. Update **ragflow/docker/.env**:
23
 
24
+ <Tabs
25
+ defaultValue="dev-slim"
26
+ values={[
27
+ {label: 'dev-slim', value: 'dev-slim'},
28
+ {label: 'dev', value: 'dev'},
29
+ ]}>
30
+ <TabItem value="dev-slim">
31
+
32
+ ```bash
33
+ RAGFLOW_IMAGE=infiniflow/ragflow:dev-slim
34
+ ```
35
+
36
+ </TabItem>
37
+ <TabItem value="dev">
38
+
39
+ ```bash
40
+ RAGFLOW_IMAGE=infiniflow/ragflow:dev
41
+ ```
42
+
43
+ </TabItem>
44
+ </Tabs>
45
 
46
  3. Update RAGFlow image and restart RAGFlow:
47
 
 
50
  docker compose -f docker/docker-compose.yml up -d
51
  ```
52
 
53
+ ## Upgrade RAGFlow to the most recent, officially published release
54
 
55
  1. Clone the repo
56
 
 
67
  3. Update **ragflow/docker/.env** as follows:
68
 
69
  ```bash
70
+ RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.0
71
  ```
72
 
73
  4. Update the RAGFlow image and restart RAGFlow:
docs/references/faq.md CHANGED
@@ -5,7 +5,7 @@ slug: /faq
5
 
6
  # Frequently asked questions
7
 
8
- Queries regarding general features, troubleshooting, performance, and more.
9
 
10
  ---
11
 
@@ -248,48 +248,50 @@ tail -f ragflow/docker/ragflow-logs/*.log
248
 
249
  #### How to check the status of each component in RAGFlow?
250
 
251
- ```bash
252
- $ docker ps
253
- ```
254
 
255
- *The system displays the following if all your RAGFlow components are running properly:*
 
 
256
 
257
- ```
258
- 5bc45806b680 infiniflow/ragflow:latest "./entrypoint.sh" 11 hours ago Up 11 hours 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:9380->9380/tcp, :::9380->9380/tcp ragflow-server
259
- 91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
260
- d8c86f06c56b mysql:5.7.18 "docker-entrypoint.s…" 7 days ago Up 16 seconds (healthy) 0.0.0.0:3306->3306/tcp, :::3306->3306/tcp ragflow-mysql
261
- cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio
262
- ```
 
 
 
 
 
 
 
 
263
 
264
  ---
265
 
266
  #### `Exception: Can't connect to ES cluster`
267
 
268
- 1. Check the status of your Elasticsearch component:
269
 
270
  ```bash
271
  $ docker ps
272
  ```
273
 
274
- *The status of a 'healthy' Elasticsearch component in your RAGFlow should look as follows:*
275
-
276
  ```
277
  91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
278
  ```
279
 
280
- 2. If your container keeps restarting, ensure `vm.max_map_count` >= 262144 as per [this README](https://github.com/infiniflow/ragflow?tab=readme-ov-file#-start-up-the-server). Updating the `vm.max_map_count` value in **/etc/sysctl.conf** is required, if you wish to keep your change permanent. This configuration works only for Linux.
281
 
282
- 3. If your issue persists, ensure that the ES host setting is correct:
 
 
283
 
284
- - If you are running RAGFlow with Docker, it is in **docker/service_conf.yml**. Set it as follows:
285
- ```
286
- es:
287
- hosts: 'http://es01:9200'
288
- ```
289
- - If you run RAGFlow outside of Docker, verify the ES host setting in **conf/service_conf.yml** using:
290
- ```bash
291
- curl http://<IP_OF_ES>:<PORT_OF_ES>
292
- ```
293
 
294
  ---
295
 
@@ -349,13 +351,23 @@ Ensure that you update the **MAX_CONTENT_LENGTH** environment variable:
349
 
350
  #### `FileNotFoundError: [Errno 2] No such file or directory`
351
 
352
- 1. Check if the status of your MinIO container is healthy:
 
 
 
 
 
 
353
 
354
  ```bash
355
- docker ps
356
  ```
357
 
358
- 2. Ensure that the username and password settings of MySQL and MinIO in **docker/.env** are in line with those in **docker/service_conf.yml**.
 
 
 
 
359
 
360
  ---
361
 
 
5
 
6
  # Frequently asked questions
7
 
8
+ Queries regarding general features, troubleshooting, usage, and more.
9
 
10
  ---
11
 
 
248
 
249
  #### How to check the status of each component in RAGFlow?
250
 
251
+ 1. Check the status of the Elasticsearch Docker container:
 
 
252
 
253
+ ```bash
254
+ $ docker ps
255
+ ```
256
 
257
+ *The following is an example result:*
258
+
259
+ ```bash
260
+ 5bc45806b680 infiniflow/ragflow:latest "./entrypoint.sh" 11 hours ago Up 11 hours 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:9380->9380/tcp, :::9380->9380/tcp ragflow-server
261
+ 91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
262
+ d8c86f06c56b mysql:5.7.18 "docker-entrypoint.s…" 7 days ago Up 16 seconds (healthy) 0.0.0.0:3306->3306/tcp, :::3306->3306/tcp ragflow-mysql
263
+ cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio
264
+ ```
265
+
266
+ 2. Follow [this document](../guides/run_health_check.md) to check the health status of the Elasticsearch service.
267
+
268
+ :::danger IMPORTANT
269
+ The status of a Docker container status does not necessarily reflect the status of the service. You may find that your services are unhealthy even when the corresponding Docker containers are up running. Possible reasons for this include network failures, incorrect port numbers, or DNS issues.
270
+ :::
271
 
272
  ---
273
 
274
  #### `Exception: Can't connect to ES cluster`
275
 
276
+ 1. Check the status of the Elasticsearch Docker container:
277
 
278
  ```bash
279
  $ docker ps
280
  ```
281
 
282
+ *The status of a healthy Elasticsearch component should look as follows:*
283
+
284
  ```
285
  91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
286
  ```
287
 
288
+ 2. Follow [this document](../guides/run_health_check.md) to check the health status of the Elasticsearch service.
289
 
290
+ :::danger IMPORTANT
291
+ The status of a Docker container status does not necessarily reflect the status of the service. You may find that your services are unhealthy even when the corresponding Docker containers are up running. Possible reasons for this include network failures, incorrect port numbers, or DNS issues.
292
+ :::
293
 
294
+ 3. If your container keeps restarting, ensure `vm.max_map_count` >= 262144 as per [this README](https://github.com/infiniflow/ragflow?tab=readme-ov-file#-start-up-the-server). Updating the `vm.max_map_count` value in **/etc/sysctl.conf** is required, if you wish to keep your change permanent. Note that this configuration works only for Linux.
 
 
 
 
 
 
 
 
295
 
296
  ---
297
 
 
351
 
352
  #### `FileNotFoundError: [Errno 2] No such file or directory`
353
 
354
+ 1. Check the status of the MinIO Docker container:
355
+
356
+ ```bash
357
+ $ docker ps
358
+ ```
359
+
360
+ *The status of a healthy Elasticsearch component should look as follows:*
361
 
362
  ```bash
363
+ cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio
364
  ```
365
 
366
+ 2. Follow [this document](../guides/run_health_check.md) to check the health status of the Elasticsearch service.
367
+
368
+ :::danger IMPORTANT
369
+ The status of a Docker container status does not necessarily reflect the status of the service. You may find that your services are unhealthy even when the corresponding Docker containers are up running. Possible reasons for this include network failures, incorrect port numbers, or DNS issues.
370
+ :::
371
 
372
  ---
373