From 05e5244d94558b5e05cb5ad5a7844c0164caa082 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Wed, 31 Dec 2025 14:42:53 +0800 Subject: [PATCH] Refactor docs of RAGFlow admin (#12361) ### What problem does this PR solve? as title ### Type of change - [x] Documentation Update Signed-off-by: Jin Hai --- docs/guides/admin/_category_.json | 8 ++++ .../admin_cli.md} | 40 ++----------------- docs/guides/admin/admin_service.md | 39 ++++++++++++++++++ .../admin_ui.md} | 4 +- 4 files changed, 53 insertions(+), 38 deletions(-) create mode 100644 docs/guides/admin/_category_.json rename docs/guides/{manage_users_and_services.md => admin/admin_cli.md} (90%) create mode 100644 docs/guides/admin/admin_service.md rename docs/guides/{accessing_admin_ui.md => admin/admin_ui.md} (97%) diff --git a/docs/guides/admin/_category_.json b/docs/guides/admin/_category_.json new file mode 100644 index 000000000..590d62083 --- /dev/null +++ b/docs/guides/admin/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Administration", + "position": 6, + "link": { + "type": "generated-index", + "description": "RAGFlow administration" + } +} diff --git a/docs/guides/manage_users_and_services.md b/docs/guides/admin/admin_cli.md similarity index 90% rename from docs/guides/manage_users_and_services.md rename to docs/guides/admin/admin_cli.md index 0ec0b112d..8123473a2 100644 --- a/docs/guides/manage_users_and_services.md +++ b/docs/guides/admin/admin_cli.md @@ -1,43 +1,11 @@ --- -sidebar_position: 6 -slug: /manage_users_and_services +sidebar_position: 2 +slug: /admin_cli --- +# Admin CLI -# Admin CLI and Admin Service - - - -The Admin CLI and Admin Service form a client-server architectural suite for RAGFlow system administration. The Admin CLI serves as an interactive command-line interface that receives instructions and displays execution results from the Admin Service in real-time. This duo enables real-time monitoring of system operational status, supporting visibility into RAGFlow Server services and dependent components including MySQL, Elasticsearch, Redis, and MinIO. In administrator mode, they provide user management capabilities that allow viewing users and performing critical operations—such as user creation, password updates, activation status changes, and comprehensive user data deletion—even when corresponding web interface functionalities are disabled. - - - -## Starting the Admin Service - -### Launching from source code - -1. Before start Admin Service, please make sure RAGFlow system is already started. - -2. Launch from source code: - - ```bash - python admin/server/admin_server.py - ``` - - The service will start and listen for incoming connections from the CLI on the configured port. - -### Using docker image - -1. Before startup, please configure the `docker_compose.yml` file to enable admin server: - - ```bash - command: - - --enable-adminserver - ``` - -2. Start the containers, the service will start and listen for incoming connections from the CLI on the configured port. - - +The RAGFlow Admin CLI is a command-line-based system administration tool that offers administrators an efficient and flexible method for system interaction and control. Operating on a client-server architecture, it communicates in real-time with the Admin Service, receiving administrator commands and dynamically returning execution results. ## Using the Admin CLI diff --git a/docs/guides/admin/admin_service.md b/docs/guides/admin/admin_service.md new file mode 100644 index 000000000..7e5f13025 --- /dev/null +++ b/docs/guides/admin/admin_service.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 0 +slug: /admin_service +--- + + +# Admin Service + +The Admin Service is the core backend management service of the RAGFlow system, providing comprehensive system administration capabilities through centralized API interfaces for managing and controlling the entire platform. Adopting a client-server architecture, it supports access and operations via both a Web UI and an Admin CLI, ensuring flexible and efficient execution of administrative tasks. + +The core functions of the Admin Service include real-time monitoring of the operational status of the RAGFlow server and its critical dependent components—such as MySQL, Elasticsearch, Redis, and MinIO—along with full-featured user management. In administrator mode, it enables key operations such as viewing user information, creating users, updating passwords, modifying activation status, and performing complete user data deletion. These functions remain accessible via the Admin CLI even when the web management interface is disabled, ensuring the system stays under control at all times. + +With its unified interface design, the Admin Service combines the convenience of visual administration with the efficiency and stability of command-line operations, serving as a crucial foundation for the reliable operation and secure management of the RAGFlow system. + +## Starting the Admin Service + +### Launching from source code + +1. Before start Admin Service, please make sure RAGFlow system is already started. + +2. Launch from source code: + + ```bash + python admin/server/admin_server.py + ``` + + The service will start and listen for incoming connections from the CLI on the configured port. + +### Using docker image + +1. Before startup, please configure the `docker_compose.yml` file to enable admin server: + + ```bash + command: + - --enable-adminserver + ``` + +2. Start the containers, the service will start and listen for incoming connections from the CLI on the configured port. + diff --git a/docs/guides/accessing_admin_ui.md b/docs/guides/admin/admin_ui.md similarity index 97% rename from docs/guides/accessing_admin_ui.md rename to docs/guides/admin/admin_ui.md index aafd6e997..148257ae5 100644 --- a/docs/guides/accessing_admin_ui.md +++ b/docs/guides/admin/admin_ui.md @@ -1,6 +1,6 @@ --- -sidebar_position: 7 -slug: /accessing_admin_ui +sidebar_position: 1 +slug: /admin_ui --- # Admin UI