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

### What problem does this PR solve?



### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters 2024-11-25 14:31:01 +08:00 committed by GitHub
parent 9348616659
commit b2c33b4df7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 77 additions and 7 deletions

View File

@ -120,7 +120,7 @@ The [.env](./.env) file contains important environment variables for Docker.
### Maximum file size
- `MAX_CONTENT_LENGTH`
The maximum file size for each uploaded file, in bytes. You can uncomment this line if you wish to change 128M file size limit.
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.
## 🐋 Service configuration

View File

@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
slug: /deploy_local_llm
---

View File

@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
slug: /llm_api_key_setup
---

View File

@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
slug: /manage_files
---

View File

@ -0,0 +1,39 @@
---
sidebar_position: 4
slug: /manage_team_members
---
# Manage team members
Invite or remove team members, join or leave a team.
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:
- Upload documents to your datasets.
- Update document configurations in your datasets.
- Parse documents in your datasets.
:::tip NOTE
Team members are currently *not* allowed to invite users to your team, and only you, the team owner, is permitted to do so.
:::
To enter the **Team** page, click on your avatar on the top right corner of the page **>** Team:
![team](https://github.com/user-attachments/assets/0eac2503-26bc-4568-b3f2-bcd84069a07a)
_On the **Team** page, you can view the information about members of your team and the teams you have joined._
## Invite team members
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.
![invite_team_member](https://github.com/user-attachments/assets/75e19d53-3a00-480e-8b16-fe00c23c4486)
## Remove team members
![remove_members](https://github.com/user-attachments/assets/5c1a6ab5-8862-47a0-ad09-77fe88866508)
## Accept or decline team invite
![accept_or_decline_team_invite](https://github.com/user-attachments/assets/6a2cb61f-03d5-4423-9ed1-71df97ff4114)

View File

@ -0,0 +1,31 @@
---
sidebar_position: 7
slug: /run_health_check
---
# Run health check on RAGFlow's dependencies
Double check the health status of RAGFlow's dependencies.
The operation of RAGFlow depends on four services:
- **Elasticsearch** (default) or [Infinity](https://github.com/infiniflow/infinity) as the document engine
- **MySQL**
- **Redis**
- **MinIO** for object storage
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.
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:
![system_status_page](https://github.com/user-attachments/assets/b0c1a11e-93e3-4947-b17a-1bfb4cdab6e4)
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`:
![es_failed](https://github.com/user-attachments/assets/06056540-49f5-48bf-9cc9-a7086bc75790)
You can click on a specific 30-second time interval to view the details of completed and failed tasks:
![done_tasks](https://github.com/user-attachments/assets/49b25ec4-03af-48cf-b2e5-c892f6eaa261)
![done_vs_failed](https://github.com/user-attachments/assets/eaa928d0-a31c-4072-adea-046091e04599)

View File

@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 11
slug: /upgrade_ragflow
---

View File

@ -5,7 +5,7 @@ slug: /http_api_reference
# HTTP API Reference
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).
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).
---

View File

@ -5,7 +5,7 @@ slug: /python_api_reference
# Python API Reference
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).
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).
---