pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2026-02-01 16:15:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update admin doc (#12439)

Browse Source 
### What problem does this PR solve?

update for 'list configs' and 'list envs'

### Type of change

- [x] Documentation Update

Signed-off-by: Jin Hai <haijin.chn@gmail.com>
This commit is contained in:
Jin Hai
2026-01-05 13:26:33 +08:00
committed by GitHub
parent 92780c486a
commit 42461bc378
1 changed files with 47 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
docs/guides/admin/admin_cli.md
View File

@ -118,7 +118,7 @@ Commands are case-insensitive and must be terminated with a semicolon(;).
- [Example](#example-revoke-admin) - [Example](#example-revoke-admin)
`LIST VARS` `LIST VARS`
- List all system configurations and settings. - List all system settings.
- [Example](#example-list-vars) - [Example](#example-list-vars)
`SHOW VAR <var_name>` `SHOW VAR <var_name>`
@ -129,6 +129,14 @@ Commands are case-insensitive and must be terminated with a semicolon(;).
- Set the value for a specified configuration item. - Set the value for a specified configuration item.
- [Example](#example-set-var) - [Example](#example-set-var)
`LIST CONFIGS`
- List all system configurations.
- [Example](#example-list-configs)
`LIST ENVS`
- List all system environments which can accessed by Admin service.
- [Example](#example-list-environments)
### Meta-Commands ### Meta-Commands
- \? or \help - \? or \help
@ -400,7 +408,7 @@ Revoke successfully!
<span id="example-list-vars"></span> <span id="example-list-vars"></span>
- List all system configurations and settings. - List all system settings.
``` ```
admin> list vars; admin> list vars;
@ -443,6 +451,43 @@ Set variable successfully
``` ```
<span id="example-list-configs"></span>
- List all system configurations.
```
admin> list configs;
+-------------------------------------------------------------------------------------------+-----------+----+---------------+-------+----------------+
| extra | host | id | name | port | service_type |
+-------------------------------------------------------------------------------------------+-----------+----+---------------+-------+----------------+
| {} | 0.0.0.0 | 0 | ragflow_0 | 9380 | ragflow_server |
| {'meta_type': 'mysql', 'password': 'infini_rag_flow', 'username': 'root'} | localhost | 1 | mysql | 5455 | meta_data |
| {'password': 'infini_rag_flow', 'store_type': 'minio', 'user': 'rag_flow'} | localhost | 2 | minio | 9000 | file_store |
| {'password': 'infini_rag_flow', 'retrieval_type': 'elasticsearch', 'username': 'elastic'} | localhost | 3 | elasticsearch | 1200 | retrieval |
| {'db_name': 'default_db', 'retrieval_type': 'infinity'} | localhost | 4 | infinity | 23817 | retrieval |
| {'database': 1, 'mq_type': 'redis', 'password': 'infini_rag_flow'} | localhost | 5 | redis | 6379 | message_queue |
| {'message_queue_type': 'redis'} | | 6 | task_executor | 0 | task_executor |
+-------------------------------------------------------------------------------------------+-----------+----+---------------+-------+----------------+
```
<span id="example-list-environments"></span>
- List all system environments which can accessed by Admin service.
```
admin> list envs;
+-------------------------+------------------+
| env | value |
+-------------------------+------------------+
| DOC_ENGINE | elasticsearch |
| DEFAULT_SUPERUSER_EMAIL | admin@ragflow.io |
| DB_TYPE | mysql |
| DEVICE | cpu |
| STORAGE_IMPL | MINIO |
+-------------------------+------------------+
```
<span id="example-meta-commands"></span> <span id="example-meta-commands"></span>
- Show help information. - Show help information.