diff --git a/website/docs/configurations.md b/website/docs/configurations.md index 973bdbc..76fe1a8 100644 --- a/website/docs/configurations.md +++ b/website/docs/configurations.md @@ -35,7 +35,7 @@ docker compose -f docker/docker-compose.yml up -d Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis. :::danger IMPORTANT -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. +We do not actively maintain **docker-compose-CN-oc9.yml**, **docker-compose-macos.yml**, so use them at your own risk. However, you are welcome to file a pull request to improve them. ::: ## Docker environment variables @@ -109,18 +109,23 @@ RAGFlow utilizes MinIO as its object storage solution, leveraging its scalabilit :::tip NOTE If you cannot download the RAGFlow Docker image, try the following mirrors. -- For the `nightly-slim` edition: - - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly-slim` or, - - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:nightly-slim`. - For the `nightly` edition: - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly` or, - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:nightly`. ::: +### Embedding service + +- `TEI_MODEL` + The embedding model which text-embeddings-inference serves. Allowed values are one of `Qwen/Qwen3-Embedding-0.6B`(default), `BAAI/bge-m3`, and `BAAI/bge-small-en-v1.5`. + +- `TEI_PORT` + The port used to expose the text-embeddings-inference service to the host machine, allowing **external** access to the text-embeddings-inference service running inside the Docker container. Defaults to `6380`. + ### Timezone -- `TIMEZONE` - The local time zone. Defaults to `'Asia/Shanghai'`. +- `TZ` + The local time zone. Defaults to `Asia/Shanghai`. ### Hugging Face mirror site diff --git a/website/docs/develop/build_docker_image.mdx b/website/docs/develop/build_docker_image.mdx index 16b5e86..94f63d6 100644 --- a/website/docs/develop/build_docker_image.mdx +++ b/website/docs/develop/build_docker_image.mdx @@ -39,25 +39,6 @@ This image is approximately 2 GB in size and relies on external LLM and embeddin - For ARM64 platforms, please upgrade the `xgboost` version in **pyproject.toml** to `1.6.0` and ensure **unixODBC** is properly installed. ::: -```bash -git clone https://github.com/infiniflow/ragflow.git -cd ragflow/ -uv run download_deps.py -docker build -f Dockerfile.deps -t infiniflow/ragflow_deps . -docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim . -``` - - - - - -This image is approximately 9 GB in size. As it includes embedding models, it relies on external LLM services only. - -:::danger IMPORTANT -- While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. However, you can build an image yourself on a `linux/arm64` or `darwin/arm64` host machine as well. -- For ARM64 platforms, please upgrade the `xgboost` version in **pyproject.toml** to `1.6.0` and ensure **unixODBC** is properly installed. -::: - ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ @@ -66,18 +47,19 @@ docker build -f Dockerfile.deps -t infiniflow/ragflow_deps . docker build -f Dockerfile -t infiniflow/ragflow:nightly . ``` + ## Launch a RAGFlow Service from Docker for MacOS -After building the infiniflow/ragflow:nightly-slim image, you are ready to launch a fully-functional RAGFlow service with all the required components, such as Elasticsearch, MySQL, MinIO, Redis, and more. +After building the infiniflow/ragflow:nightly image, you are ready to launch a fully-functional RAGFlow service with all the required components, such as Elasticsearch, MySQL, MinIO, Redis, and more. ## Example: Apple M2 Pro (Sequoia) 1. Edit Docker Compose Configuration -Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.21.1-slim` to `infiniflow/ragflow:nightly-slim` to use the pre-built image. +Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.21.1` to `infiniflow/ragflow:nightly` to use the pre-built image. 2. Launch the Service diff --git a/website/docs/develop/launch_ragflow_from_source.md b/website/docs/develop/launch_ragflow_from_source.md index b81e14e..7c96fe5 100644 --- a/website/docs/develop/launch_ragflow_from_source.md +++ b/website/docs/develop/launch_ragflow_from_source.md @@ -48,7 +48,7 @@ cd ragflow/ ``` - full: ```bash - uv sync --python 3.10 --all-extras # install RAGFlow dependent python modules + uv sync --python 3.10 # install RAGFlow dependent python modules ``` *A virtual environment named `.venv` is created, and all Python dependencies are installed into the new environment.* diff --git a/website/docs/develop/mcp/launch_mcp_server.md b/website/docs/develop/mcp/launch_mcp_server.md index 3df5284..7544ed4 100644 --- a/website/docs/develop/mcp/launch_mcp_server.md +++ b/website/docs/develop/mcp/launch_mcp_server.md @@ -116,51 +116,51 @@ Run `docker compose -f docker-compose.yml up` to launch the RAGFlow server toget *The following ASCII art confirms a successful launch:* ```bash - ragflow-server | Starting MCP Server on 0.0.0.0:9382 with base URL http://127.0.0.1:9380... - ragflow-server | Starting 1 task executor(s) on host 'dd0b5e07e76f'... - ragflow-server | 2025-04-18 15:41:18,816 INFO 27 ragflow_server log path: /ragflow/logs/ragflow_server.log, log levels: {'peewee': 'WARNING', 'pdfminer': 'WARNING', 'root': 'INFO'} - ragflow-server | - ragflow-server | __ __ ____ ____ ____ _____ ______ _______ ____ - ragflow-server | | \/ |/ ___| _ \ / ___|| ____| _ \ \ / / ____| _ \ - ragflow-server | | |\/| | | | |_) | \___ \| _| | |_) \ \ / /| _| | |_) | - ragflow-server | | | | | |___| __/ ___) | |___| _ < \ V / | |___| _ < - ragflow-server | |_| |_|\____|_| |____/|_____|_| \_\ \_/ |_____|_| \_\ - ragflow-server | - ragflow-server | MCP launch mode: self-host - ragflow-server | MCP host: 0.0.0.0 - ragflow-server | MCP port: 9382 - ragflow-server | MCP base_url: http://127.0.0.1:9380 - ragflow-server | INFO: Started server process [26] - ragflow-server | INFO: Waiting for application startup. - ragflow-server | INFO: Application startup complete. - ragflow-server | INFO: Uvicorn running on http://0.0.0.0:9382 (Press CTRL+C to quit) - ragflow-server | 2025-04-18 15:41:20,469 INFO 27 found 0 gpus - ragflow-server | 2025-04-18 15:41:23,263 INFO 27 init database on cluster mode successfully - ragflow-server | 2025-04-18 15:41:25,318 INFO 27 load_model /ragflow/rag/res/deepdoc/det.onnx uses CPU - ragflow-server | 2025-04-18 15:41:25,367 INFO 27 load_model /ragflow/rag/res/deepdoc/rec.onnx uses CPU - ragflow-server | ____ ___ ______ ______ __ - ragflow-server | / __ \ / | / ____// ____// /____ _ __ - ragflow-server | / /_/ // /| | / / __ / /_ / // __ \| | /| / / - ragflow-server | / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / - ragflow-server | /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ - ragflow-server | - ragflow-server | - ragflow-server | 2025-04-18 15:41:29,088 INFO 27 RAGFlow version: v0.18.0-285-gb2c299fa full - ragflow-server | 2025-04-18 15:41:29,088 INFO 27 project base: /ragflow - ragflow-server | 2025-04-18 15:41:29,088 INFO 27 Current configs, from /ragflow/conf/service_conf.yaml: - ragflow-server | ragflow: {'host': '0.0.0.0', 'http_port': 9380} + docker-ragflow-cpu-1 | Starting MCP Server on 0.0.0.0:9382 with base URL http://127.0.0.1:9380... + docker-ragflow-cpu-1 | Starting 1 task executor(s) on host 'dd0b5e07e76f'... + docker-ragflow-cpu-1 | 2025-04-18 15:41:18,816 INFO 27 ragflow_server log path: /ragflow/logs/ragflow_server.log, log levels: {'peewee': 'WARNING', 'pdfminer': 'WARNING', 'root': 'INFO'} + docker-ragflow-cpu-1 | + docker-ragflow-cpu-1 | __ __ ____ ____ ____ _____ ______ _______ ____ + docker-ragflow-cpu-1 | | \/ |/ ___| _ \ / ___|| ____| _ \ \ / / ____| _ \ + docker-ragflow-cpu-1 | | |\/| | | | |_) | \___ \| _| | |_) \ \ / /| _| | |_) | + docker-ragflow-cpu-1 | | | | | |___| __/ ___) | |___| _ < \ V / | |___| _ < + docker-ragflow-cpu-1 | |_| |_|\____|_| |____/|_____|_| \_\ \_/ |_____|_| \_\ + docker-ragflow-cpu-1 | + docker-ragflow-cpu-1 | MCP launch mode: self-host + docker-ragflow-cpu-1 | MCP host: 0.0.0.0 + docker-ragflow-cpu-1 | MCP port: 9382 + docker-ragflow-cpu-1 | MCP base_url: http://127.0.0.1:9380 + docker-ragflow-cpu-1 | INFO: Started server process [26] + docker-ragflow-cpu-1 | INFO: Waiting for application startup. + docker-ragflow-cpu-1 | INFO: Application startup complete. + docker-ragflow-cpu-1 | INFO: Uvicorn running on http://0.0.0.0:9382 (Press CTRL+C to quit) + docker-ragflow-cpu-1 | 2025-04-18 15:41:20,469 INFO 27 found 0 gpus + docker-ragflow-cpu-1 | 2025-04-18 15:41:23,263 INFO 27 init database on cluster mode successfully + docker-ragflow-cpu-1 | 2025-04-18 15:41:25,318 INFO 27 load_model /ragflow/rag/res/deepdoc/det.onnx uses CPU + docker-ragflow-cpu-1 | 2025-04-18 15:41:25,367 INFO 27 load_model /ragflow/rag/res/deepdoc/rec.onnx uses CPU + docker-ragflow-cpu-1 | ____ ___ ______ ______ __ + docker-ragflow-cpu-1 | / __ \ / | / ____// ____// /____ _ __ + docker-ragflow-cpu-1 | / /_/ // /| | / / __ / /_ / // __ \| | /| / / + docker-ragflow-cpu-1 | / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + docker-ragflow-cpu-1 | /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ + docker-ragflow-cpu-1 | + docker-ragflow-cpu-1 | + docker-ragflow-cpu-1 | 2025-04-18 15:41:29,088 INFO 27 RAGFlow version: v0.18.0-285-gb2c299fa full + docker-ragflow-cpu-1 | 2025-04-18 15:41:29,088 INFO 27 project base: /ragflow + docker-ragflow-cpu-1 | 2025-04-18 15:41:29,088 INFO 27 Current configs, from /ragflow/conf/service_conf.yaml: + docker-ragflow-cpu-1 | ragflow: {'host': '0.0.0.0', 'http_port': 9380} ... - ragflow-server | * Running on all addresses (0.0.0.0) - ragflow-server | * Running on http://127.0.0.1:9380 - ragflow-server | * Running on http://172.19.0.6:9380 - ragflow-server | ______ __ ______ __ - ragflow-server | /_ __/___ ______/ /__ / ____/ _____ _______ __/ /_____ _____ - ragflow-server | / / / __ `/ ___/ //_/ / __/ | |/_/ _ \/ ___/ / / / __/ __ \/ ___/ - ragflow-server | / / / /_/ (__ ) ,< / /____> 80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:9380->9380/tcp, :::9380->9380/tcp ragflow-server + 5bc45806b680 infiniflow/ragflow:latest "./entrypoint.sh" 11 hours ago Up 11 hours 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:9380->9380/tcp, :::9380->9380/tcp docker-ragflow-cpu-1 91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01 d8c86f06c56b mysql:5.7.18 "docker-entrypoint.s…" 7 days ago Up 16 seconds (healthy) 0.0.0.0:3306->3306/tcp, :::3306->3306/tcp ragflow-mysql cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio diff --git a/website/docs/guides/agent/agent_component_reference/retrieval.mdx b/website/docs/guides/agent/agent_component_reference/retrieval.mdx index a2215a2..9c8fd84 100644 --- a/website/docs/guides/agent/agent_component_reference/retrieval.mdx +++ b/website/docs/guides/agent/agent_component_reference/retrieval.mdx @@ -47,7 +47,7 @@ By default, a combination of weighted keyword similarity and weighted vector cos As a starter, you can skip this step to stay with the default retrieval method. :::caution WARNING -Using a rerank model will *significantly* increase the system's response time. If you must use a rerank model, ensure you use a SaaS reranker; if you prefer a locally deployed rerank model, ensure you start RAGFlow with **docker-compose-gpu.yml**. +Using a rerank model will *significantly* increase the system's response time. ::: ### 5. Enable cross-language search @@ -140,6 +140,5 @@ The global variable name for the output of the **Retrieval** component, which ca Go through the checklist below for best performance: -- Leave the **Rerank model** field empty. -- If you must use a rerank model, ensure you use a SaaS reranker; if you prefer a locally deployed rerank model, ensure you start RAGFlow with **docker-compose-gpu.yml**. +- Leave the **Rerank model** field empty to disable rerank. - Disable **Use knowledge graph**. diff --git a/website/docs/guides/models/deploy_local_llm.mdx b/website/docs/guides/models/deploy_local_llm.mdx index 6553e7c..ba4ac09 100644 --- a/website/docs/guides/models/deploy_local_llm.mdx +++ b/website/docs/guides/models/deploy_local_llm.mdx @@ -62,7 +62,7 @@ $ sudo docker exec ollama ollama pull bge-m3 - If RAGFlow runs in Docker, the localhost is mapped within the RAGFlow Docker container as `host.docker.internal`. If Ollama runs on the same host machine, the right URL to use for Ollama would be `http://host.docker.internal:11434/' and you should check that Ollama is accessible from inside the RAGFlow container with: ```bash -$ sudo docker exec -it ragflow-server bash +$ sudo docker exec -it docker-ragflow-cpu-1 bash $ curl http://host.docker.internal:11434/ > Ollama is running ``` diff --git a/website/docs/guides/upgrade_ragflow.mdx b/website/docs/guides/upgrade_ragflow.mdx index 166efde..c54d42d 100644 --- a/website/docs/guides/upgrade_ragflow.mdx +++ b/website/docs/guides/upgrade_ragflow.mdx @@ -7,15 +7,15 @@ slug: /upgrade_ragflow import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Upgrade RAGFlow to `nightly-slim`/`nightly` or the latest, published release. +Upgrade RAGFlow to `nightly` or the latest, published release. :::info NOTE Upgrading RAGFlow in itself will *not* remove your uploaded/historical data. However, be aware that `docker compose -f docker/docker-compose.yml down -v` will remove Docker container volumes, resulting in data loss. ::: -## Upgrade RAGFlow to `nightly-slim`/`nightly`, the most recent, tested Docker image +## Upgrade RAGFlow to `nightly`, the most recent, tested Docker image -`nightly-slim` refers to the RAGFlow Docker image *without* embedding models, while `nightly` refers to the RAGFlow Docker image with embedding models. For details on their differences, see [ragflow/docker/.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env). +`nightly` refers to the RAGFlow Docker image without embedding models. To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker image: @@ -27,27 +27,9 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag 2. Update **ragflow/docker/.env**: - - - -```bash -RAGFLOW_IMAGE=infiniflow/ragflow:nightly-slim -``` - - - - -```bash -RAGFLOW_IMAGE=infiniflow/ragflow:nightly -``` - - - + ```bash + RAGFLOW_IMAGE=infiniflow/ragflow:nightly + ``` 3. Update RAGFlow image and restart RAGFlow: @@ -74,27 +56,9 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag 3. Update **ragflow/docker/.env**: - - - -```bash -RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1-slim -``` - - - - -```bash -RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1 -``` - - - + ```bash + RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1 + ``` 4. Update the RAGFlow image and restart RAGFlow: diff --git a/website/docs/quickstart.mdx b/website/docs/quickstart.mdx index 3d1ccf9..6df16e1 100644 --- a/website/docs/quickstart.mdx +++ b/website/docs/quickstart.mdx @@ -196,9 +196,6 @@ This section provides instructions on setting up the RAGFlow server on Linux. If ```bash # Use CPU for embedding and DeepDoc tasks: $ docker compose -f docker-compose.yml up -d - - # To use GPU to accelerate embedding and DeepDoc tasks: - # docker compose -f docker-compose-gpu.yml up -d ``` ```mdx-code-block @@ -207,10 +204,9 @@ This section provides instructions on setting up the RAGFlow server on Linux. If | RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? | | ------------------- | --------------- | ----------------------------------------- | ------------------------ | -| `v0.21.1` | ≈9 | :heavy_check_mark: | Stable release | -| `v0.21.1-slim` | ≈2 | ❌ | Stable release | -| `nightly` | ≈9 | :heavy_check_mark: | *Unstable* nightly build | -| `nightly-slim` | ≈2 | ❌ | *Unstable* nightly build | +| v0.21.1 | ≈9 | ✔️ | Stable release | +| v0.21.1-slim | ≈2 | ❌ | Stable release | +| nightly | ≈2 | ❌ | _Unstable_ nightly build | ```mdx-code-block @@ -232,7 +228,7 @@ The image size shown refers to the size of the *downloaded* Docker image, which 4. Check the server status after having the server up and running: ```bash - $ docker logs -f ragflow-server + $ docker logs -f docker-ragflow-cpu-1 ``` _The following output confirms a successful launch of the system:_