Skip to content

Stirling-PDF Stirling-PDF

Build Status Last Commit OCI Pulls

Locally hosted web application for performing various operations on PDF files — merge, split, compress, convert, OCR, and more.

Port 8080
Registry ghcr.io/daemonless/stirling-pdf
Daemonless daemonless/stirling-pdf
Source Stirling-Tools/Stirling-PDF
Website www.stirlingpdf.com

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

Customize Paths, UID & Ports

Install and manage Stirling-PDF on FreeBSD with fjord:

fjord install stirling-pdf

Or open the App Store in the fjord web UI and install Stirling-PDF from the wizard. New to fjord? See the Install Guide.

services:
  stirling-pdf:
    image: "ghcr.io/daemonless/stirling-pdf:latest"
    container_name: stirling-pdf
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/containers/stirling-pdf:/config"
    ports:
      - "8080:8080"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
# .env

DIRECTOR_PROJECT=stirling-pdf
PUID=1000
PGID=1000
TZ=UTC
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  stirling-pdf:
    name: stirling_pdf
    options:
      - container: 'args:--pull'
      - expose: '8080:8080 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - stirling-pdf: /config
volumes:
  stirling-pdf:
    device: '/containers/stirling-pdf'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/stirling-pdf:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  stirling-pdf:
    name: stirling-pdf
    image: "ghcr.io/daemonless/stirling-pdf:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/stirling-pdf:/config"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:8080 from another machine (the server's own browser can't use a published port).

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/config Configuration directory

Ports

Port Protocol Description
8080 TCP Web UI

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Alternative build.
pkg / pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.