hwdsl2/docling-server repository overview

⁠ParseCrate

Open-source, self-hosted document processing API.

GitHub: https://github.com/hwdsl2/parsecrate⁠

ParseCrate is a self-hosted document processing API powered by Docling⁠ and docling-serve⁠. Convert PDF, DOCX, PPTX, XLSX, HTML, Markdown, LaTeX, and other supported formats into structured Markdown, JSON, or HTML on your own server. Deploy with Docker on CPU or an NVIDIA GPU.

Features:

• Document conversion API: convert PDF, DOCX, PPTX, HTML, and more to Markdown/JSON.
• Private, local processing: document data stays on your server and is not sent to third parties.
• Layout, OCR, and tables: powered by IBM Docling⁠ for high-accuracy layout analysis, OCR, and table structure recognition.
• Flexible input and processing: synchronous and asynchronous conversion with file uploads or URL-based input.
• RAG chunking: hierarchical and hybrid chunking endpoints for RAG applications.
• Web playground: optional web UI playground enabled with DOCLING_ENABLE_UI.
• CPU and GPU support: run on CPU or use the :cuda image for NVIDIA GPU acceleration.
• Offline operation: run without internet access using pre-cached models (DOCLING_LOCAL_ONLY).
• Automated builds: images are automatically built and published through GitHub Actions⁠.

Also available as part of the Self-Hosted AI Stack⁠, which deploys a complete self-hosted AI stack with a single command.

Also available:

• Related AI services: ScribeCrate⁠, SpeakCrate⁠, EmbedCrate⁠, GatewayCrate⁠, InferCrate⁠, UplinkCrate⁠

⁠Quick start

Use this command to set up a ParseCrate server:

docker run \
    --name docling \
    --restart=always \
    -v docling-data:/var/lib/docling \
    -p 5001:5001 \
    -d hwdsl2/docling-server

Note: For internet-facing deployments, use a reverse proxy⁠ to add HTTPS. Also replace -p 5001:5001 with -p 127.0.0.1:5001:5001 in the docker run command above, to prevent direct access to the unencrypted port.

cp docling.env.example docling.env
# Edit docling.env as needed, then:
docker compose -f docker-compose.cuda.yml up -d
docker logs docling

services:
  docling:
    image: hwdsl2/docling-server:cuda
    container_name: docling
    restart: always
    ports:
      - "5001:5001/tcp"  # For a host-based reverse proxy, change to "127.0.0.1:5001:5001/tcp"
    volumes:
      - docling-data:/var/lib/docling
      - ./docling.env:/docling.env:ro
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [gpu]

volumes:
  docling-data:
    name: docling-data

docker run \
    --name docling \
    --restart=always \
    --gpus=all \
    -v docling-data:/var/lib/docling \
    -p 5001:5001 \
    -d hwdsl2/docling-server:cuda

Models are baked into the image and loaded into memory on first start. Check the logs to confirm the server is ready:

docker logs docling

Once you see "ParseCrate document parsing server is ready", convert your first document:

Fresh persistent installations require an API key. Retrieve it for the following examples:

parse_api_key="$(docker exec docling docling_manage --getkey)"

curl -X POST http://your_server_ip:5001/v1/convert/source \
    -H "X-Api-Key: $parse_api_key" \
    -H "Content-Type: application/json" \
    -d '{"sources": [{"kind": "http", "url": "https://arxiv.org/pdf/2501.17887"}]}'

⁠Community

• 📬 Get project updates and free deployment guides⁠ (1–2 emails/month)
• 💬 Join the r/selfhostedstack⁠ community for discussions and showcases
• ⭐ Star the repository if you find it useful — it helps others discover it

⁠Requirements

• A Linux server (local or cloud) with Docker installed
• Supported architectures: amd64 (x86_64), arm64 (aarch64)
• Minimum RAM: ~2 GB free (for CPU inference with default models)
• Disk: ~4 GB for the Docker image
• Internet access is NOT required for document conversion (models are baked into the image). Internet is needed only if fetching documents from URLs.

For GPU acceleration (:cuda image):

• NVIDIA GPU with CUDA support (Compute Capability 6.0+)
• NVIDIA driver⁠ 575.57.08+ (Linux) or 576.57+ (Windows) installed on the host
• NVIDIA Container Toolkit⁠ installed
• The :cuda image supports linux/amd64 only

For internet-facing deployments, see Using a reverse proxy⁠ to add HTTPS.

⁠Download

Get the trusted build from the Docker Hub registry⁠:

docker pull hwdsl2/docling-server

Alternatively, you may download from Quay.io⁠:

docker pull quay.io/hwdsl2/docling-server
docker image tag quay.io/hwdsl2/docling-server hwdsl2/docling-server

For NVIDIA GPU acceleration, pull the :cuda tag instead:

docker pull hwdsl2/docling-server:cuda

Supported platforms: linux/amd64 and linux/arm64. The :cuda tag supports linux/amd64 only.

⁠Environment variables

All variables are optional. Fresh installs with a mounted /var/lib/docling volume auto-generate an API key. Existing installs without a key remain open for backward compatibility.

This Docker image uses the following variables, that can be declared in an env file (see example⁠):

Note: In your env file, you may enclose values in single quotes, e.g. VAR='value'. Do not add spaces around =. If you change DOCLING_PORT, update the -p flag in the docker run command accordingly.

Example using an env file:

cp docling.env.example docling.env
# Edit docling.env with your settings, then:
docker run \
    --name docling \
    --restart=always \
    -v docling-data:/var/lib/docling \
    -v ./docling.env:/docling.env:ro \
    -p 5001:5001 \
    -d hwdsl2/docling-server

The env file is bind-mounted into the container, so changes are picked up on every restart without recreating the container.

docker run \
    --name docling \
    --restart=always \
    -v docling-data:/var/lib/docling \
    -p 5001:5001 \
    --env-file=docling.env \
    -d hwdsl2/docling-server

⁠Using docker-compose

cp docling.env.example docling.env
# Edit docling.env as needed, then:
docker compose up -d
docker logs docling

Example docker-compose.yml (already included):

services:
  docling:
    image: hwdsl2/docling-server
    container_name: docling
    restart: always
    ports:
      - "5001:5001/tcp"  # For a host-based reverse proxy, change to "127.0.0.1:5001:5001/tcp"
    volumes:
      - docling-data:/var/lib/docling
      - ./docling.env:/docling.env:ro

volumes:
  docling-data:
    name: docling-data

Note: For internet-facing deployments, use a reverse proxy⁠ to add HTTPS. Also change "5001:5001/tcp" to "127.0.0.1:5001:5001/tcp" in docker-compose.yml, to prevent direct access to the unencrypted port.

⁠API reference

Fresh persistent installations require an API key. Retrieve it for the following examples:

parse_api_key="$(docker exec docling docling_manage --getkey)"

If API key authentication is disabled, omit the X-Api-Key header.

⁠Convert a document from URL

POST /v1/convert/source
Content-Type: application/json

Parameters:

Example:

curl -X POST http://your_server_ip:5001/v1/convert/source \
    -H "X-Api-Key: $parse_api_key" \
    -H "Content-Type: application/json" \
    -d '{"sources": [{"kind": "http", "url": "https://arxiv.org/pdf/2501.17887"}]}'

With API key authentication:

curl -X POST http://your_server_ip:5001/v1/convert/source \
    -H "X-Api-Key: $parse_api_key" \
    -H "Content-Type: application/json" \
    -d '{"sources": [{"kind": "http", "url": "https://arxiv.org/pdf/2501.17887"}]}'

⁠Convert an uploaded file

POST /v1/convert/file
Content-Type: multipart/form-data

Example:

curl -X POST http://your_server_ip:5001/v1/convert/file \
    -H "X-Api-Key: $parse_api_key" \
    -F "[email protected]"

⁠Async conversion

For large documents, use async endpoints to avoid timeouts:

POST /v1/convert/source/async    → returns task_id
GET  /v1/status/poll/{task_id}   → poll task status
GET  /v1/result/{task_id}        → retrieve result

⁠Health check

GET /health    → liveness check (always returns 200)
GET /ready     → readiness check (503 until models are loaded)

⁠Version info

GET /version

Returns docling, docling-serve, and docling-core versions.

⁠Interactive API docs

A full interactive Swagger UI is available at:

http://your_server_ip:5001/docs

Note: API key authentication uses the X-Api-Key header (not Authorization: Bearer). Health, version, and documentation endpoints (/health, /ready, /version, /docs) do not require the API key.

⁠Persistent data

All runtime data is stored in the Docker volume (/var/lib/docling inside the container):

/var/lib/docling/
├── .port               # Active port (used by docling_manage)
├── .server_addr        # Cached server IP (used by docling_manage)
└── hub/                # HuggingFace Hub cache for runtime-downloaded models

Note: Document conversion models (layout, table structure, OCR) are baked into the Docker image and do not need to be downloaded separately. The Docker volume stores runtime data only.

⁠Managing the server

Use docling_manage inside the running container to inspect and manage the server.

Show server info:

docker exec docling docling_manage --showinfo

List supported formats:

docker exec docling docling_manage --showformats

Download/update models:

docker exec docling docling_manage --downloadmodels

Show version info:

docker exec docling docling_manage --version

⁠Supported formats

Input formats:

Output formats:

Output format is controlled per-request via the API. See the interactive API docs at /docs for full request options.

⁠Securing your server

See Securing your server⁠.

⁠Using a reverse proxy

For internet-facing deployments, place a reverse proxy in front of the ParseCrate server to handle HTTPS termination. The server works without HTTPS on a local or trusted network, but HTTPS is recommended when the API endpoint is exposed to the internet.

Use one of the following addresses to reach the ParseCrate container from your reverse proxy:

• docling:5001 — if your reverse proxy runs as a container in the same Docker network as the ParseCrate server (e.g. defined in the same docker-compose.yml).
• 127.0.0.1:5001 — if your reverse proxy runs on the host and port 5001 is published (the default docker-compose.yml publishes it).

Example with Caddy⁠ (Docker image⁠) (automatic TLS via Let's Encrypt, reverse proxy in the same Docker network):

Caddyfile:

docling.example.com {
  reverse_proxy docling:5001
}

Example with nginx (reverse proxy on the host):

server {
    listen 443 ssl;
    server_name docling.example.com;

    ssl_certificate     /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;

    location / {
        proxy_pass         http://127.0.0.1:5001;
        proxy_set_header   Host $host;
        proxy_set_header   X-Real-IP $remote_addr;
        proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto $scheme;
        proxy_read_timeout 300s;
    }
}

Fresh persistent installs auto-generate a DOCLING_API_KEY. Display it with docker exec docling docling_manage --showkey, or use docker exec docling docling_manage --getkey in scripts. For existing installs without a key, set DOCLING_API_KEY in your env file to enable authentication.

⁠Update Docker image

To update the Docker image and container, first download⁠ the latest version:

docker pull hwdsl2/docling-server

If the Docker image is already up to date, you should see:

Status: Image is up to date for hwdsl2/docling-server:latest

Otherwise, it will download the latest version. Remove and re-create the container:

docker rm -f docling
# Then re-run the docker run command from Quick start with the same volume and port.

Your runtime data is preserved in the docling-data volume.

⁠Using with other AI services

ParseCrate can be used as the document conversion service in a broader self-hosted AI setup.

For full and lightweight Docker Compose stacks, manual docker run examples, and voice/RAG/MCP pipeline examples with SpeakCrate, EmbedCrate, GatewayCrate, InferCrate, ParseCrate, and UplinkCrate, see Self-Hosted AI Stack⁠.

⁠Usage counts

See Usage counts⁠.

⁠Technical details

• Base image: ghcr.io/docling-project/docling-serve-cpu:latest (CentOS Stream 9), CUDA: ghcr.io/docling-project/docling-serve:latest
• Document parsing engine: IBM Docling⁠ with Docling Serve⁠ API
• API: RESTful /v1/convert/* and /v1/chunk/* endpoints (served by FastAPI/Uvicorn)
• Models: Layout analysis, table structure recognition, OCR — baked into the image
• Data directory: /var/lib/docling (Docker volume for runtime data)
• Authentication: Optional X-Api-Key header (health/version endpoints exempt)

⁠License

Note: The software components inside the pre-built image (such as IBM Docling and its dependencies) are under the respective licenses chosen by their respective copyright holders. As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

Copyright (C) 2026 Lin Song
This work is licensed under the MIT License⁠.

Docling and Docling Serve are Copyright (C) 2024 International Business Machines, and are distributed under the MIT License⁠.

This project is an independent Docker setup for IBM Docling and is not affiliated with, endorsed by, or sponsored by International Business Machines (IBM).