writinwaters commited on
Commit
71b8b06
·
1 Parent(s): 1b46744

DOC: Added health check and team management (#3630)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

docker/README.md CHANGED
@@ -120,7 +120,7 @@ The [.env](./.env) file contains important environment variables for Docker.
120
  ### Maximum file size
121
 
122
  - `MAX_CONTENT_LENGTH`
123
- The maximum file size for each uploaded file, in bytes. You can uncomment this line if you wish to change 128M file size limit.
124
 
125
  ## 🐋 Service configuration
126
 
 
120
  ### Maximum file size
121
 
122
  - `MAX_CONTENT_LENGTH`
123
+ The maximum file size for each uploaded file, in bytes. You can uncomment this line if you wish to change the 128M file size limit.
124
 
125
  ## 🐋 Service configuration
126
 
docs/guides/deploy_local_llm.mdx CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- sidebar_position: 6
3
  slug: /deploy_local_llm
4
  ---
5
 
 
1
  ---
2
+ sidebar_position: 7
3
  slug: /deploy_local_llm
4
  ---
5
 
docs/guides/llm_api_key_setup.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- sidebar_position: 5
3
  slug: /llm_api_key_setup
4
  ---
5
 
 
1
  ---
2
+ sidebar_position: 6
3
  slug: /llm_api_key_setup
4
  ---
5
 
docs/guides/manage_files.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- sidebar_position: 4
3
  slug: /manage_files
4
  ---
5
 
 
1
  ---
2
+ sidebar_position: 5
3
  slug: /manage_files
4
  ---
5
 
docs/guides/manage_team_members.md ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ sidebar_position: 4
3
+ slug: /manage_team_members
4
+ ---
5
+
6
+ # Manage team members
7
+
8
+ Invite or remove team members, join or leave a team.
9
+
10
+ By default, each RAGFlow user is assigned a single team named after their name. RAGFlow allows you to invite RAGFlow users to your team. Your team members can help you:
11
+
12
+ - Upload documents to your datasets.
13
+ - Update document configurations in your datasets.
14
+ - Parse documents in your datasets.
15
+
16
+ :::tip NOTE
17
+ Team members are currently *not* allowed to invite users to your team, and only you, the team owner, is permitted to do so.
18
+ :::
19
+
20
+ To enter the **Team** page, click on your avatar on the top right corner of the page **>** Team:
21
+
22
+ ![team](https://github.com/user-attachments/assets/0eac2503-26bc-4568-b3f2-bcd84069a07a)
23
+
24
+ _On the **Team** page, you can view the information about members of your team and the teams you have joined._
25
+
26
+ ## Invite team members
27
+
28
+ You are, by default, the owner of your own team and the only person permitted to invite users to join your team or remove team members.
29
+
30
+ ![invite_team_member](https://github.com/user-attachments/assets/75e19d53-3a00-480e-8b16-fe00c23c4486)
31
+
32
+ ## Remove team members
33
+
34
+ ![remove_members](https://github.com/user-attachments/assets/5c1a6ab5-8862-47a0-ad09-77fe88866508)
35
+
36
+ ## Accept or decline team invite
37
+
38
+ ![accept_or_decline_team_invite](https://github.com/user-attachments/assets/6a2cb61f-03d5-4423-9ed1-71df97ff4114)
39
+
docs/guides/run_health_check.md ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ sidebar_position: 7
3
+ slug: /run_health_check
4
+ ---
5
+
6
+ # Run health check on RAGFlow's dependencies
7
+
8
+ Double check the health status of RAGFlow's dependencies.
9
+
10
+ The operation of RAGFlow depends on four services:
11
+
12
+ - **Elasticsearch** (default) or [Infinity](https://github.com/infiniflow/infinity) as the document engine
13
+ - **MySQL**
14
+ - **Redis**
15
+ - **MinIO** for object storage
16
+
17
+ If an exception or error occurs related to any of the above services, such as `Exception: Can't connect to ES cluster`, refer to this document to check their health status.
18
+
19
+ You can also click you avatar on the top right corner of the page **>** System to view the visualized health status of RAGFlow's core services. The following screenshot shows that all services are 'green' (running healthily). The task executor displays the *cumulative* number of completed and failed document parsing tasks from the past 30 minutes:
20
+
21
+ ![system_status_page](https://github.com/user-attachments/assets/b0c1a11e-93e3-4947-b17a-1bfb4cdab6e4)
22
+
23
+ Services with a yellow or red light are not running properly. The following is a screenshot of the system page after running `docker stop ragflow-es-10`:
24
+
25
+ ![es_failed](https://github.com/user-attachments/assets/06056540-49f5-48bf-9cc9-a7086bc75790)
26
+
27
+ You can click on a specific 30-second time interval to view the details of completed and failed tasks:
28
+
29
+ ![done_tasks](https://github.com/user-attachments/assets/49b25ec4-03af-48cf-b2e5-c892f6eaa261)
30
+
31
+ ![done_vs_failed](https://github.com/user-attachments/assets/eaa928d0-a31c-4072-adea-046091e04599)
docs/guides/upgrade_ragflow.mdx CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- sidebar_position: 7
3
  slug: /upgrade_ragflow
4
  ---
5
 
 
1
  ---
2
+ sidebar_position: 11
3
  slug: /upgrade_ragflow
4
  ---
5
 
docs/references/http_api_reference.md CHANGED
@@ -5,7 +5,7 @@ slug: /http_api_reference
5
 
6
  # HTTP API Reference
7
 
8
- A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md).
9
 
10
  ---
11
 
 
5
 
6
  # HTTP API Reference
7
 
8
+ A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key).
9
 
10
  ---
11
 
docs/references/python_api_reference.md CHANGED
@@ -5,7 +5,7 @@ slug: /python_api_reference
5
 
6
  # Python API Reference
7
 
8
- A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md).
9
 
10
  ---
11
 
 
5
 
6
  # Python API Reference
7
 
8
+ A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key).
9
 
10
  ---
11