Просмотр исходного кода

fix: update service startup instructions and FAQ links in documentation

myhloli 4 месяцев назад
Родитель
Сommit
f3e982cc3f

+ 1 - 1
docs/en/quick_start/docker_deployment.md

@@ -38,7 +38,7 @@ docker run --gpus all \
 ```
 
 After executing this command, you will enter the Docker container's interactive terminal with some ports mapped for potential services. You can directly run MinerU-related commands within the container to use MinerU's features.
-You can also directly start MinerU services by replacing `/bin/bash` with service startup commands. For detailed instructions, please refer to the [MinerU Usage Documentation](../usage/index.md).
+You can also directly start MinerU services by replacing `/bin/bash` with service startup commands. For detailed instructions, please refer to the [Start the service via command](https://opendatalab.github.io/MinerU/usage/quick_usage/#advanced-usage-via-api-webui-sglang-clientserver).
 
 ## Start Services Directly with Docker Compose
 

+ 1 - 1
docs/en/quick_start/index.md

@@ -1,6 +1,6 @@
 # Quick Start
 
-If you encounter any installation issues, please check the [FAQ](../FAQ/index.md) first.
+If you encounter any installation issues, please check the [FAQ](../faq/index.md) first.
 
 ## Online Experience
 

+ 3 - 3
docs/en/usage/quick_usage.md

@@ -38,16 +38,16 @@ If you need to adjust parsing options through custom parameters, you can also ch
 - Direct Python API calls: [Python Usage Example](https://github.com/opendatalab/MinerU/blob/master/demo/demo.py)
 - FastAPI calls:
   ```bash
-  mineru-api --host 127.0.0.1 --port 8000
+  mineru-api --host 0.0.0.0 --port 8000
   ```
   >[!TIP]
   >Access `http://127.0.0.1:8000/docs` in your browser to view the API documentation.
 - Start Gradio WebUI visual frontend:
   ```bash
   # Using pipeline/vlm-transformers/vlm-sglang-client backends
-  mineru-gradio --server-name 127.0.0.1 --server-port 7860
+  mineru-gradio --server-name 0.0.0.0 --server-port 7860
   # Or using vlm-sglang-engine/pipeline backends (requires sglang environment)
-  mineru-gradio --server-name 127.0.0.1 --server-port 7860 --enable-sglang-engine true
+  mineru-gradio --server-name 0.0.0.0 --server-port 7860 --enable-sglang-engine true
   ```
   >[!TIP]
   >

+ 1 - 1
docs/zh/quick_start/docker_deployment.md

@@ -37,7 +37,7 @@ docker run --gpus all \
 ```
 
 执行该命令后,您将进入到Docker容器的交互式终端,并映射了一些端口用于可能会使用的服务,您可以直接在容器内运行MinerU相关命令来使用MinerU的功能。
-您也可以直接通过替换`/bin/bash`为服务启动命令来启动MinerU服务,详细说明请参考[MinerU使用文档](../usage/index.md)。
+您也可以直接通过替换`/bin/bash`为服务启动命令来启动MinerU服务,详细说明请参考[通过命令启动服务](https://opendatalab.github.io/MinerU/zh/usage/quick_usage/#apiwebuisglang-clientserver)。
 
 ## 通过 Docker Compose 直接启动服务
 

+ 1 - 1
docs/zh/quick_start/index.md

@@ -1,6 +1,6 @@
 # 快速开始
 
-如果遇到任何安装问题,请先查询 [FAQ](../FAQ/index.md) 
+如果遇到任何安装问题,请先查询 [FAQ](../faq/index.md) 
 
 ## 在线体验
 

+ 3 - 3
docs/zh/usage/quick_usage.md

@@ -37,16 +37,16 @@ mineru -p <input_path> -o <output_path> -b vlm-transformers
 - 通过python api直接调用:[Python 调用示例](https://github.com/opendatalab/MinerU/blob/master/demo/demo.py)
 - 通过fast api方式调用:
   ```bash
-  mineru-api --host 127.0.0.1 --port 8000
+  mineru-api --host 0.0.0.0 --port 8000
   ```
   >[!TIP]
   >在浏览器中访问 `http://127.0.0.1:8000/docs` 查看API文档。
 - 启动gradio webui 可视化前端:
   ```bash
   # 使用 pipeline/vlm-transformers/vlm-sglang-client 后端
-  mineru-gradio --server-name 127.0.0.1 --server-port 7860
+  mineru-gradio --server-name 0.0.0.0 --server-port 7860
   # 或使用 vlm-sglang-engine/pipeline 后端(需安装sglang环境)
-  mineru-gradio --server-name 127.0.0.1 --server-port 7860 --enable-sglang-engine true
+  mineru-gradio --server-name 0.0.0.0 --server-port 7860 --enable-sglang-engine true
   ```
   >[!TIP]
   >