Docling-Serve 项目启动与配置教程

Docling-Serve 项目启动与配置教程

docling-serve Running Docling as an API service 项目地址: https://gitcode.com/gh_mirrors/do/docling-serve

1. 项目目录结构及介绍

Docling-Serve 项目的目录结构如下所示：

docling-serve/
├── .gitignore           # 忽略文件列表
├── Dockerfile           # Docker 镜像构建文件
├── README.md            # 项目说明文件
├── requirements.txt     # 项目依赖文件
├── config/              # 配置文件目录
│   └── config.json      # 配置文件
├── doc/                 # 文档目录
├── scripts/             # 脚本目录
│   └── start.sh         # 启动脚本
├── src/                 # 源代码目录
│   ├── main.py          # 主程序文件
│   └── ...              # 其他源代码文件
└── tests/               # 测试代码目录

• .gitignore：指定 Git 忽略的文件和目录。
• Dockerfile：用于构建项目 Docker 镜像的文件。
• README.md：项目的基本信息和说明。
• requirements.txt：项目运行所需的 Python 库和依赖。
• config/：存放项目配置文件的目录。
  • config.json：项目的主要配置文件，包含数据库连接、端口等信息。
• doc/：存放项目相关文档的目录。
• scripts/：存放项目运行所需脚本的目录。
  • start.sh：启动项目的脚本。
• src/：存放项目源代码的目录。
  • main.py：项目的主程序文件。
• tests/：存放项目测试代码的目录。

2. 项目的启动文件介绍

项目的启动文件为 scripts/start.sh，其主要内容如下：

#!/bin/bash

# 设置环境变量
export Flask_APP=src/main.py

# 启动 Flask 应用
flask run --host=0.0.0.0 --port=5000

该脚本设置了 Flask 应用的环境变量，并使用 Flask 的命令行工具启动应用，监听所有网络接口上的 5000 端口。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json，其主要内容如下：

{
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "password",
        "dbname": "docling"
    },
    "server": {
        "port": 5000
    }
}

该配置文件包含了数据库连接信息（包括数据库主机地址、端口、用户名、密码和数据库名）以及服务器端口设置。在实际部署项目时，需要根据实际情况修改这些配置信息。

docling-serve Running Docling as an API service 项目地址: https://gitcode.com/gh_mirrors/do/docling-serve