mirror of
https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git
synced 2025-06-04 11:24:00 +08:00
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:
parent
9348616659
commit
b2c33b4df7
@ -120,7 +120,7 @@ The [.env](./.env) file contains important environment variables for Docker.
|
|||||||
### Maximum file size
|
### Maximum file size
|
||||||
|
|
||||||
- `MAX_CONTENT_LENGTH`
|
- `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
|
## 🐋 Service configuration
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 6
|
sidebar_position: 7
|
||||||
slug: /deploy_local_llm
|
slug: /deploy_local_llm
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 5
|
sidebar_position: 6
|
||||||
slug: /llm_api_key_setup
|
slug: /llm_api_key_setup
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 4
|
sidebar_position: 5
|
||||||
slug: /manage_files
|
slug: /manage_files
|
||||||
---
|
---
|
||||||
|
|
||||||
|
39
docs/guides/manage_team_members.md
Normal file
39
docs/guides/manage_team_members.md
Normal 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:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
_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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Remove team members
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Accept or decline team invite
|
||||||
|
|
||||||
|

|
||||||
|
|
31
docs/guides/run_health_check.md
Normal file
31
docs/guides/run_health_check.md
Normal 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:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You can click on a specific 30-second time interval to view the details of completed and failed tasks:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
sidebar_position: 7
|
sidebar_position: 11
|
||||||
slug: /upgrade_ragflow
|
slug: /upgrade_ragflow
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ slug: /http_api_reference
|
|||||||
|
|
||||||
# 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).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ slug: /python_api_reference
|
|||||||
|
|
||||||
# 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).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user