Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

docs: update admin docs with latest release (#21302)

YanZhangbcbfc676f321
diff --git a/docs/administrator/management/admin_ui/before_you_begin.md b/docs/administrator/management/admin_ui/before_you_begin.md
index e5df2b8ab1..9aa155edd3 100644
--- a/docs/administrator/management/admin_ui/before_you_begin.md
+++ b/docs/administrator/management/admin_ui/before_you_begin.md
@@ -10,7 +10,7 @@ title: Before You Begin
System administrators can access the RAGFlow Admin UI in a browser. The current Admin UI entry point is `/admin`, for example `http://192.168.1.5/admin`.
-After entering the Admin UI, administrators can perform service health checks, maintain user accounts, configure sandboxes, control registration, manage roles and permissions, configure system settings, and configure identity providers. The Admin UI should be exposed only to trusted administrators.
+After entering the Admin UI, administrators can check service status, manage user accounts, and configure the code execution sandbox. The Admin UI should be exposed only to trusted administrators.
![Enter The Admin Console](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/enter_the_admin_console.jpg)
diff --git a/docs/administrator/management/admin_ui/check_system_status.md b/docs/administrator/management/admin_ui/check_system_status.md
index 85e25edbe3..4a869251dd 100644
--- a/docs/administrator/management/admin_ui/check_system_status.md
+++ b/docs/administrator/management/admin_ui/check_system_status.md
@@ -8,7 +8,7 @@ title: Check System Status
## Check Whether Services Are Running Normally
-After entering the Admin UI, open the **Service status** page to view the status reported by the Go services and their configured dependencies. Each row contains the service type, name, host, port, status, an `elapsed` diagnostic value, and an optional message.
+After entering the Admin UI, open the **Service status** page to view the status reported by the Go services and their configured dependencies. Each row displays the service `Name`, `Service type`, `Host`, `Port`, and `Status`. Use **Actions** to view the `elapsed` diagnostic value and any status message.
![Check Whether Services Are Normal](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/check_whether_services_are_normal.jpg)
diff --git a/docs/administrator/management/admin_ui/configure_code_execution_sandbox.md b/docs/administrator/management/admin_ui/configure_code_execution_sandbox.md
index 34e1cc928c..43c75f2f70 100644
--- a/docs/administrator/management/admin_ui/configure_code_execution_sandbox.md
+++ b/docs/administrator/management/admin_ui/configure_code_execution_sandbox.md
@@ -14,16 +14,18 @@ Saving a provider makes it active for subsequent Code component runs across this
## Select a provider
+![Select a sandbox provider](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/select_sandbox_provider.jpg)
+
The page supports:
| Provider | Detailed instructions |
| --- | --- |
| **Self-Managed** | [Quickstart with Self-Managed](../../sandbox/quickstart_with_self_managed.md) |
-| **SSH** | [Configure SSH](./configure_ssh_and_cloud_providers.md#configure-ssh) |
-| **Aliyun Code Interpreter** | [Configure Aliyun Code Interpreter](./configure_ssh_and_cloud_providers.md#configure-aliyun-code-interpreter) |
-| **E2B** | [Configure E2B](./configure_ssh_and_cloud_providers.md#configure-e2b) |
-| **Tenki** | [Configure Tenki](./configure_ssh_and_cloud_providers.md#configure-tenki) |
-| **UCloud Agent Sandbox** | [Configure UCloud Agent Sandbox](./configure_ssh_and_cloud_providers.md#configure-ucloud-agent-sandbox) |
+| **SSH** | [Configure SSH](../../sandbox/configure_ssh_and_cloud_providers.md#configure-ssh) |
+| **Aliyun Code Interpreter** | [Configure Aliyun Code Interpreter](../../sandbox/configure_ssh_and_cloud_providers.md#configure-aliyun-code-interpreter) |
+| **E2B** | [Configure E2B](../../sandbox/configure_ssh_and_cloud_providers.md#configure-e2b) |
+| **Tenki** | [Configure Tenki](../../sandbox/configure_ssh_and_cloud_providers.md#configure-tenki) |
+| **UCloud Agent Sandbox** | [Configure UCloud Agent Sandbox](../../sandbox/configure_ssh_and_cloud_providers.md#configure-ucloud-agent-sandbox) |
## Test and save the configuration
diff --git a/docs/administrator/management/admin_ui/manage_user_accounts.md b/docs/administrator/management/admin_ui/manage_user_accounts.md
index 974d40905f..1015675403 100644
--- a/docs/administrator/management/admin_ui/manage_user_accounts.md
+++ b/docs/administrator/management/admin_ui/manage_user_accounts.md
@@ -8,7 +8,7 @@ title: Manage User Accounts
## View and Search Users
-User accounts are managed on the **User management** page. Administrators can view the user list, including `Email`, `Nickname`, `Status`, `User type`, and `Last login time`.
+User accounts are managed on the **User management** page. Administrators can view the user list, including `Email`, `Nickname`, `Status`, and `User type`.
![User Management](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/user_management_1.jpg)
diff --git a/docs/administrator/management/admin_ui/configure_ssh_and_cloud_providers.md b/docs/administrator/sandbox/configure_ssh_and_cloud_providers.md
similarity index 97%
rename from docs/administrator/management/admin_ui/configure_ssh_and_cloud_providers.md
rename to docs/administrator/sandbox/configure_ssh_and_cloud_providers.md
index 9746d2ca07..13fe1a9b41 100644
--- a/docs/administrator/management/admin_ui/configure_ssh_and_cloud_providers.md
+++ b/docs/administrator/sandbox/configure_ssh_and_cloud_providers.md
@@ -173,7 +173,7 @@ The defaults are appropriate for an initial test:
| **Max Artifacts** | `20` | Maximum number of files collected from the execution's `artifacts/` directory. |
| **Max Artifact Bytes** | `10485760` | Maximum size of one artifact file. |
-Select **Test connection**. Confirm that the result shows `PASSED`, then select **Save**. If the test returns `knownhosts: key is unknown`, see [Why does SSH return `knownhosts: key is unknown`?](../../sandbox/faq.md#why-does-ssh-return-knownhosts-key-is-unknown).
+Select **Test connection**. Confirm that the result shows `PASSED`, then select **Save**. If the test returns `knownhosts: key is unknown`, see [Why does SSH return `knownhosts: key is unknown`?](./faq.md#why-does-ssh-return-knownhosts-key-is-unknown).
## Configure Aliyun Code Interpreter
@@ -273,4 +273,4 @@ This verifies the complete path from RAGFlow to the selected provider. **Test co
When replacing a provider that is already in use, also test representative existing Agents. Confirm that their required packages, outbound network access, execution time, and artifact handling work in the new environment.
-If the test fails, see the [Code Execution Sandbox FAQ](../../sandbox/faq.md). For SSH, also verify the host key, authentication method, remote workspace permissions, and runtime paths. For cloud providers, verify credentials, region availability, account quota, and outbound network access from the RAGFlow server.
+If the test fails, see the [Code Execution Sandbox FAQ](./faq.md). For SSH, also verify the host key, authentication method, remote workspace permissions, and runtime paths. For cloud providers, verify credentials, region availability, account quota, and outbound network access from the RAGFlow server.
diff --git a/docs/administrator/sandbox/faq.md b/docs/administrator/sandbox/faq.md
index c1ab910dac..1896b22776 100644
--- a/docs/administrator/sandbox/faq.md
+++ b/docs/administrator/sandbox/faq.md
@@ -129,7 +129,7 @@ The network connection reached the SSH server, but RAGFlow could not find a trus
For a non-default SSH port, the `known_hosts` entry must include the port—for example, `[192.168.1.5]:2222`. Verify the server fingerprint, add the key to the file used by RAGFlow, and ensure that the file is visible to the RAGFlow process or container.
-For Docker and source deployment instructions, see [Prepare the SSH `known_hosts` file](../management/admin_ui/configure_ssh_and_cloud_providers.md#prepare-the-ssh-known_hosts-file).
+For Docker and source deployment instructions, see [Prepare the SSH `known_hosts` file](./configure_ssh_and_cloud_providers.md#prepare-the-ssh-known_hosts-file).
If the message reports a host-key mismatch instead, verify whether the server key was intentionally changed before replacing the existing entry. An unexpected key change can indicate that the connection is being intercepted.
@@ -156,7 +156,7 @@ The configured binary must be available in the non-interactive SSH session. Shel
## Cloud providers
-Return to the detailed configuration for [Aliyun Code Interpreter](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-aliyun-code-interpreter), [E2B](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-e2b), [Tenki](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-tenki), or [UCloud Agent Sandbox](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-ucloud-agent-sandbox) when checking credentials, regions, endpoints, resource settings, or network access.
+Return to the detailed configuration for [Aliyun Code Interpreter](./configure_ssh_and_cloud_providers.md#configure-aliyun-code-interpreter), [E2B](./configure_ssh_and_cloud_providers.md#configure-e2b), [Tenki](./configure_ssh_and_cloud_providers.md#configure-tenki), or [UCloud Agent Sandbox](./configure_ssh_and_cloud_providers.md#configure-ucloud-agent-sandbox) when checking credentials, regions, endpoints, resource settings, or network access.
### Why is the API credential rejected?
diff --git a/docs/administrator/sandbox/overview.md b/docs/administrator/sandbox/overview.md
index 4c472fefa0..f58304d9e1 100644
--- a/docs/administrator/sandbox/overview.md
+++ b/docs/administrator/sandbox/overview.md
@@ -24,11 +24,11 @@ Choose the provider that matches where you want code to run and who should manag
| Provider | Where code runs | Choose it when |
| --- | --- | --- |
| [**Self-Managed**](./quickstart_with_self_managed.md) | Python or Node.js Runner containers managed by Sandbox Executor Manager in your environment | You want to keep code execution under your operational control. This is the default option and the focus of the Self-Managed guides. |
-| [**SSH**](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-ssh) | An existing remote Linux host | You already operate a suitable execution server with Python or Node.js and can manage its SSH access and host keys. |
-| [**Aliyun Code Interpreter**](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-aliyun-code-interpreter) | Alibaba Cloud Code Interpreter | Your organization uses Alibaba Cloud and wants a managed execution environment. |
-| [**E2B**](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-e2b) | E2B cloud sandboxes | You want an externally managed cloud sandbox without operating local Runner containers. |
-| [**Tenki**](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-tenki) | A disposable Tenki microVM created for each execution | You want each run to use an isolated, short-lived cloud microVM. |
-| [**UCloud Agent Sandbox**](../management/admin_ui/configure_ssh_and_cloud_providers.md#configure-ucloud-agent-sandbox) | A disposable UCloud Agent Sandbox | You want a managed cloud sandbox in a supported UCloud region. |
+| [**SSH**](./configure_ssh_and_cloud_providers.md#configure-ssh) | An existing remote Linux host | You already operate a suitable execution server with Python or Node.js and can manage its SSH access and host keys. |
+| [**Aliyun Code Interpreter**](./configure_ssh_and_cloud_providers.md#configure-aliyun-code-interpreter) | Alibaba Cloud Code Interpreter | Your organization uses Alibaba Cloud and wants a managed execution environment. |
+| [**E2B**](./configure_ssh_and_cloud_providers.md#configure-e2b) | E2B cloud sandboxes | You want an externally managed cloud sandbox without operating local Runner containers. |
+| [**Tenki**](./configure_ssh_and_cloud_providers.md#configure-tenki) | A disposable Tenki microVM created for each execution | You want each run to use an isolated, short-lived cloud microVM. |
+| [**UCloud Agent Sandbox**](./configure_ssh_and_cloud_providers.md#configure-ucloud-agent-sandbox) | A disposable UCloud Agent Sandbox | You want a managed cloud sandbox in a supported UCloud region. |
:::note Before choosing a cloud provider
Confirm that your RAGFlow deployment can reach the provider's API, and that your account has valid credentials, sufficient quota, and access to the required region.
@@ -47,5 +47,5 @@ RAGFlow can run with Docker Compose or directly from source while Sandbox Execut
## Next steps
- Get started with [Quickstart with Self-Managed](./quickstart_with_self_managed.md).
-- To use SSH or a cloud service, see [Configure SSH and Cloud Providers](../management/admin_ui/configure_ssh_and_cloud_providers.md).
+- To use SSH or a cloud service, see [Configure SSH and Cloud Providers](./configure_ssh_and_cloud_providers.md).
- For maintenance and troubleshooting, see [Manage Self-Managed Sandbox](./manage_self_managed_sandbox.md) and [FAQ](./faq.md).
diff --git a/docs/administrator/sandbox/quickstart_with_self_managed.md b/docs/administrator/sandbox/quickstart_with_self_managed.md
index 78a3f8ffa3..08d62c43b1 100644
--- a/docs/administrator/sandbox/quickstart_with_self_managed.md
+++ b/docs/administrator/sandbox/quickstart_with_self_managed.md
@@ -199,4 +199,4 @@ The setup is complete when:
- To adjust Runner capacity, images, resource limits, network access, artifacts, or authentication, see [Manage Self-Managed Sandbox](./manage_self_managed_sandbox.md).
- To connect RAGFlow to an Executor Manager on another host, see [Connect to a remote Executor Manager](./manage_self_managed_sandbox.md#connect-to-a-remote-executor-manager).
- If startup, connection, authentication, or execution fails, see [Code Execution Sandbox FAQ](./faq.md).
-- To use SSH or a managed cloud service instead, see [Configure SSH and Cloud Providers](../management/admin_ui/configure_ssh_and_cloud_providers.md).
+- To use SSH or a managed cloud service instead, see [Configure SSH and Cloud Providers](./configure_ssh_and_cloud_providers.md).