Updated RAGFlow Agent UI (#4029)

### What problem does this PR solve?


### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters 2024-12-13 18:57:22 +08:00 committed by GitHub
parent 9b9039de92
commit e5c3083826
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 43 additions and 62 deletions

View File

@ -158,6 +158,11 @@
| nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
> [!TIP]
> 如果你遇到 Docker 镜像拉不下来的问题,可以在 **docker/.env** 文件内根据变量 `RAGFLOW_IMAGE` 的注释提示选择华为云或者阿里云的相应镜像。
> - 华为云镜像名:`swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow`
> - 阿里云镜像名:`registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow`
4. 服务器启动成功后再次确认服务器状态:
```bash

View File

@ -16,6 +16,9 @@
- **docker-compose-base.yml**
Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
> [!CAUTION]
> We do not actively maintain **docker-compose-CN-oc9.yml**, **docker-compose-gpu-CN-oc9.yml**, or **docker-compose-gpu.yml**, so use them at your own risk. However, you are welcome to file a pull request to improve any of them.
## 🐬 Docker environment variables
The [.env](./.env) file contains important environment variables for Docker.

View File

@ -1,3 +1,5 @@
# The RAGFlow team do not actively maintain docker-compose-CN-oc9.yml, so use them at your own risk.
# However, you are welcome to file a pull request to improve it.
include:
- ./docker-compose-base.yml

View File

@ -1,37 +0,0 @@
include:
- path: ./docker-compose.yml
env_file: ./.env
services:
kibana:
image: kibana:${STACK_VERSION}
container_name: ragflow-kibana
environment:
ELASTICSEARCH_USERNAME: ${KIBANA_USER}
ELASTICSEARCH_PASSWORD: ${KIBANA_PASSWORD}
ELASTICSEARCH_HOSTS: "http://es01:9200"
ports:
- ${KIBANA_PORT}:5601
depends_on:
es01:
condition: service_healthy
kibana-user-init:
condition: service_completed_successfully
networks:
- ragflow
kibana-user-init:
image: appropriate/curl
depends_on:
es01:
condition: service_healthy
volumes:
- ./init-kibana.sh:/app/init-kibana.sh
environment:
- ELASTIC_PASSWORD=${ELASTIC_PASSWORD}
- KIBANA_USER=${KIBANA_USER}
- KIBANA_PASSWORD=${KIBANA_PASSWORD}
command: /bin/sh -c "sh /app/init-kibana.sh"
networks:
- ragflow
restart: 'no'

View File

@ -1,3 +1,5 @@
# The RAGFlow team do not actively maintain docker-compose-gpu-CN-oc9.yml, so use them at your own risk.
# However, you are welcome to file a pull request to improve it.
include:
- ./docker-compose-base.yml

View File

@ -1,3 +1,5 @@
# The RAGFlow team do not actively maintain docker-compose-gpu.yml, so use them at your own risk.
# However, you are welcome to file a pull request to improve it.
include:
- ./docker-compose-base.yml

View File

@ -34,6 +34,10 @@ docker compose -f docker/docker-compose.yml up -d
- **docker-compose-base.yml**
Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
:::danger IMPORTANT
**docker-compose-CN-oc9.yml**, **docker-compose-gpu-CN-oc9.yml**, **docker-compose-gpu.yml** have been contributed by our community. We do not actively maintain these files, so use them at your own risk. However, you are welcome to file a pull request to improve any of them.
:::
## Docker environment variables
The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file contains important environment variables for Docker.

View File

@ -760,23 +760,23 @@ The above is the content you need to summarize.`,
language: 'Language',
googleScholar: 'Google Scholar',
googleScholarDescription:
'This component is used to get search result from https://scholar.google.com/. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt.',
'A component that searches https://scholar.google.com/. You can use Top N to specify the number of search results.',
yearLow: 'Year low',
yearHigh: 'Year high',
patents: 'Patents',
data: 'Data',
deepL: 'DeepL',
deepLDescription:
'This component is used to get translations from https://www.deepl.com/. Typically, it provides a more specialized translation result.',
'A component that gets more specialized translations from https://www.deepl.com/.',
authKey: 'Auth key',
sourceLang: 'Source language',
targetLang: 'Target language',
gitHub: 'GitHub',
gitHubDescription:
'This component is used to search the repository from https://github.com/. Top N specifies the number of search results to be adjusted.',
'A component that searches for repositories from https://github.com/. You can use Top N to specify the number of search results.',
baiduFanyi: 'BaiduFanyi',
baiduFanyiDescription:
'This component is used to get translations from https://fanyi.baidu.com/. Typically, it provides a more specialized translation result',
'A component that gets specialized translations from https://fanyi.baidu.com/.',
appid: 'App id',
secretKey: 'Secret key',
domain: 'Domain',
@ -831,7 +831,7 @@ The above is the content you need to summarize.`,
},
qWeather: 'QWeather',
qWeatherDescription:
'This component is used to get weather related information from https://www.qweather.com/. You can get weather, indices, air quality.',
'A component that retrieves weather information, such as temperature and air quality, from https://www.qweather.com/.',
lang: 'Language',
type: 'Type',
webApiKey: 'Web API key',
@ -890,7 +890,7 @@ The above is the content you need to summarize.`,
publish: 'API',
exeSQL: 'ExeSQL',
exeSQLDescription:
'The component queries the results from the corresponding relational database via SQL statements. Supports MySQL, PostgreSQL, MariaDB. ',
'A component that performs SQL queries on a relational database, supporting querying from MySQL, PostgreSQL, or MariaDB.',
dbType: 'Database Type',
database: 'Database',
username: 'Username',
@ -923,7 +923,7 @@ The above is the content you need to summarize.`,
wenCai: 'WenCai',
queryType: 'Query type',
wenCaiDescription:
'The component can be used to obtain information on a wide range of financial areas, including but not limited to stocks, funds, etc...',
'A component that obtains financial information, including stock prices and funding news, from a wide range of financial websites.',
wenCaiQueryTypeOptions: {
stock: 'stock',
zhishu: 'index',
@ -939,13 +939,13 @@ The above is the content you need to summarize.`,
},
akShare: 'AkShare',
akShareDescription:
'This component can be used to obtain news information for the corresponding stock from the Eastmoney website.',
'A component that obtains news about stocks from https://www.eastmoney.com/.',
yahooFinance: 'YahooFinance',
yahooFinanceDescription:
'The component queries information about the company based on the provided ticker symbol.',
'A component that queries information about a publicly traded company using its ticker symbol.',
crawler: 'Web Crawler',
crawlerDescription:
'This component can be used to crawl HTML source code from a specified URL.',
'A component that crawls HTML source code from a specified URL.',
proxy: 'Proxy',
crawlerResultOptions: {
html: 'Html',
@ -960,7 +960,7 @@ The above is the content you need to summarize.`,
cashFlowStatement: 'Cash flow statement',
jin10: 'Jin10',
jin10Description:
'This component can be used to access information in the financial sector from the Jin10 Open Platform, including quick news, calendar, quotes, reference.',
'A component that retrieves financial information from the Jin10 Open Platform, including news updates, calendars, quotes, and references.',
flashType: 'Flash type',
filter: 'Filter',
contain: 'Contain',
@ -1007,7 +1007,7 @@ The above is the content you need to summarize.`,
'A component that receives the output from the upstream component and passes it on as input to the downstream components.',
tuShare: 'TuShare',
tuShareDescription:
'This component can be used to obtain financial news briefs from mainstream financial websites, aiding industry and quantitative research.',
'A component that obtains financial news briefs from mainstream financial websites, aiding industry and quantitative research.',
tuShareSrcOptions: {
sina: 'Sina',
wallstreetcn: 'wallstreetcn',
@ -1027,7 +1027,7 @@ The above is the content you need to summarize.`,
notePlaceholder: 'Please enter a note',
invoke: 'Invoke',
invokeDescription:
'This component can invoke remote end point call. Put the output of other components as parameters or set constant parameters to call remote functions.',
`A component capable of calling remote services, using other components' outputs or constants as inputs.`,
url: 'Url',
method: 'Method',
timeout: 'Timeout',
@ -1048,9 +1048,9 @@ The above is the content you need to summarize.`,
testRun: 'Test Run',
template: 'Template',
templateDescription:
'This component is used for typesetting the outputs of various components.',
'A component that formats the output of another component.',
emailComponent: 'Email',
emailDescription: 'Send email to specified address',
emailDescription: 'Send an email to a specified address.',
smtpServer: 'SMTP Server',
smtpPort: 'SMTP Port',
senderEmail: 'Sender Email',