Skip to content

daemonless/stirling-pdf

Repository files navigation

Stirling-PDF

Build Status Last Commit

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
Source https://github.com/Stirling-Tools/Stirling-PDF
Website https://www.stirlingpdf.com/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Alternative build.
pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest FreeBSD Latest. Rolling package updates. Newest FreeBSD packages.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  stirling-pdf:
    image: ghcr.io/daemonless/stirling-pdf:latest
    container_name: stirling-pdf
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/stirling-pdf:/config"
    ports:
      - 8080:8080
    restart: unless-stopped

AppJail Director

.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: 'boot args:--pull'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - stirling-pdf: /config
volumes:
  stirling-pdf:
    device: '/path/to/containers/stirling-pdf'

Makejail:

ARG tag=latest

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

Podman CLI

podman run -d --name stirling-pdf \
  -p 8080:8080 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/stirling-pdf:/config \
  ghcr.io/daemonless/stirling-pdf:latest

Ansible

- name: Deploy stirling-pdf
  containers.podman.podman_container:
    name: stirling-pdf
    image: ghcr.io/daemonless/stirling-pdf:latest
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "8080:8080"
    volumes:
      - "/path/to/containers/stirling-pdf:/config"

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

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.0


Need help? Join our Discord community.

About

Stirling-PDF: A robust, locally hosted web-based PDF manipulation tool. Native FreeBSD OCI image (Daemonless).

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors