Skip to content

Commit 0f6d77a

Browse files
committed
documentation
1 parent dca2bf5 commit 0f6d77a

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

docs/faq.mdx

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -543,8 +543,39 @@ uv pip install -U "mineru[core]" -i https://mirrors.aliyun.com/pypi/simple
543543
1. Set `MINERU_EXECUTABLE` (default: `mineru`) to the path of the MinerU executable.
544544
2. Set `MINERU_DELETE_OUTPUT` to `0` to keep MinerU's output. (Default: `1`, which deletes temporary output)
545545
3. Set `MINERU_OUTPUT_DIR` to specify the output directory for MinerU.
546-
4. Set `MINERU_BACKEND` to `"pipeline"`. (Options: `"pipeline"` (default) | `"vlm-transformers"`)
546+
4. Set `MINERU_BACKEND` to specify the parsing backend. Options:
547+
- `"pipeline"` (default): Traditional multi-model pipeline
548+
- `"vlm-transformers"`: Vision-language model using HuggingFace Transformers
549+
- `"vlm-vllm-engine"`: Vision-language model using local vLLM engine (requires local GPU)
550+
- `"vlm-http-client"`: Vision-language model via HTTP client to remote vLLM server (RAGFlow only needs CPU)
551+
5. When using `vlm-http-client` backend, set `MINERU_SERVER_URL` to the URL of your vLLM server.
547552

548553
:::tip NOTE
549554
For information about other environment variables natively supported by MinerU, see [here](https://opendatalab.github.io/MinerU/usage/cli_tools/#environment-variables-description).
550555
:::
556+
557+
---
558+
559+
### How to use MinerU with vLLM server for document parsing?
560+
561+
RAGFlow supports MinerU's `vlm-http-client` backend, which allows you to connect to a remote vLLM server for document parsing. This enables you to leverage powerful GPU resources on a dedicated server without requiring GPUs on the RAGFlow server.
562+
563+
To use MinerU with vLLM server:
564+
565+
1. Set up a vLLM server running MinerU:
566+
```bash
567+
mineru-vllm-server --port 30000
568+
```
569+
570+
2. Configure the following environment variables in your **docker/.env** file:
571+
- `MINERU_EXECUTABLE=/ragflow/uv_tools/.venv/bin/mineru` (or the path to your MinerU executable)
572+
- `MINERU_BACKEND="vlm-http-client"`
573+
- `MINERU_SERVER_URL="http://your-vllm-server-ip:30000"`
574+
575+
3. Follow the standard MinerU setup steps as described above.
576+
577+
With this configuration, RAGFlow will connect to your vLLM server to perform document parsing, which can significantly improve parsing performance for complex documents while reducing the resource requirements on your RAGFlow server.
578+
579+
:::tip NOTE
580+
When using the `vlm-http-client` backend, the RAGFlow server only requires CPU and network connectivity, not GPUs. This enables cost-effective distributed deployment where multiple RAGFlow instances can share a single powerful vLLM server. The `vlm-vllm-engine` backend is available in MinerU but requires local GPU resources on the RAGFlow server.
581+
:::

0 commit comments

Comments
 (0)