|
| 1 | +--- |
| 2 | +sidebar_position: 6 |
| 3 | +slug: /using_admin_ui |
| 4 | +--- |
| 5 | + |
| 6 | +# Admin UI |
| 7 | + |
| 8 | +The RAGFlow Admin UI is a web-based interface that provides comprehensive system status monitoring and user management capabilities. |
| 9 | + |
| 10 | + |
| 11 | +## Accessing the Admin UI |
| 12 | + |
| 13 | +### Launching from source code |
| 14 | + |
| 15 | +1. Start the RAGFlow front-end (if not already running): |
| 16 | + |
| 17 | + ```bash |
| 18 | + cd web |
| 19 | + npm run dev |
| 20 | + ``` |
| 21 | + |
| 22 | + Typically, the front-end server is running on port `9222`. The following output confirms a successful launch of the RAGFlow UI: |
| 23 | + |
| 24 | + ```bash |
| 25 | + ╔════════════════════════════════════════════════════╗ |
| 26 | + ║ App listening at: ║ |
| 27 | + ║ > Local: http://localhost:9222 ║ |
| 28 | + ready - ║ > Network: http://192.168.1.92:9222 ║ |
| 29 | + ║ ║ |
| 30 | + ║ Now you can open browser with the above addresses↑ ║ |
| 31 | + ╚════════════════════════════════════════════════════╝ |
| 32 | + ``` |
| 33 | + |
| 34 | + |
| 35 | +2. Login to RAGFlow Admin UI |
| 36 | + |
| 37 | + Open your browser and navigate to: |
| 38 | + |
| 39 | + ``` |
| 40 | + http://localhost:9222/admin |
| 41 | + ``` |
| 42 | + |
| 43 | + Or if accessing from a remote machine: |
| 44 | + |
| 45 | + ``` |
| 46 | + http://[YOUR_MACHINE_IP]:9222/admin |
| 47 | + ``` |
| 48 | + |
| 49 | + > Replace `[YOUR_MACHINE_IP]` with your actual machine IP address (e.g., `http://192.168.1.49:9222/admin`). |
| 50 | +
|
| 51 | + Then, you will be presented with a login page where you need to enter your admin user email address and password. |
| 52 | + |
| 53 | +3. After a successful login, you will be redirected to the **Service Status** page, which is the default landing page for the Admin UI. |
| 54 | + |
| 55 | + |
| 56 | +## Admin UI Overview |
| 57 | + |
| 58 | +### Service status |
| 59 | + |
| 60 | +The service status page displays of all services within the RAGFlow system. |
| 61 | + |
| 62 | +- **Service List**: View all services in a table format. |
| 63 | +- **Filtering**: Use the filter button to filter services by **Service Type**. |
| 64 | +- **Search**: Use the search bar to quickly find services by **Name** or **Service Type**. |
| 65 | +- **Actions** (hover over a row to see action buttons): |
| 66 | + - **Extra Info**: Display additional configuration information of a service in a dialog. |
| 67 | + - **Service Details**: Display detailed status information of a service in a dialog. According to services's type, a service's status information could be displayed as a plain text, a key-value data list, a data table or a bar chart. |
| 68 | + |
| 69 | + |
| 70 | +### User management |
| 71 | + |
| 72 | +The user management page provides comprehensive tools for managing all users in the RAGFlow system. |
| 73 | + |
| 74 | +- **User List**: View all users in a table. |
| 75 | +- **Search Users**: Use the search bar to find users by email or nickname. |
| 76 | +- **Filter Users**: Click the filter icon to filter by **Status**. |
| 77 | +- Click the **"New User"** button to create a new user account in a dialog. |
| 78 | +- Activate or deactivate a user by using the switch toggle in **Enable** column, changes take effect immediately. |
| 79 | +- **Actions** (hover over a row to see action buttons): |
| 80 | + - **View Details**: Navigate to the user detail page to see comprehensive user information. |
| 81 | + - **Change Password**: Force reset the user's password. |
| 82 | + - **Delete User**: Remove the user from the system with confirmation. |
| 83 | + |
| 84 | + |
| 85 | +### User detail |
| 86 | + |
| 87 | +The user detail page displays a user's detailed information and all resources created or owned by the user, categorized by type (e.g. Dataset, Agent). |
0 commit comments