esc
Type to search the docs
Back to catalog

paperless

Tested

Document management system that transforms physical documents into a searchable archive

paperless screenshot
Image: ghcr.io/paperless-ngx/paperless-ngx:latest
Launchfile View on GitHub
# yaml-language-server: $schema=https://launchfile.dev/schema/v1
version: launch/v1
name: paperless
description: "Document management system that transforms physical documents into a searchable archive"
repository: https://github.com/paperless-ngx/paperless-ngx
logo: https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/dev/resources/logo/web/svg/square.svg

image: ghcr.io/paperless-ngx/paperless-ngx:latest
provides:
  - protocol: http
    port: 8000
    exposed: true
requires:
  - type: postgres
    set_env:
      PAPERLESS_DBHOST: $host
      PAPERLESS_DBPORT: $port
      PAPERLESS_DBNAME: $name
      PAPERLESS_DBUSER: $user
      PAPERLESS_DBPASS: $password
  - type: redis
    set_env:
      PAPERLESS_REDIS: $url
env:
  PAPERLESS_SECRET_KEY:
    generator: secret
    sensitive: true
  PAPERLESS_ADMIN_USER:
    default: "admin"
    description: "Initial admin username"
  PAPERLESS_ADMIN_PASSWORD:
    generator: secret
    sensitive: true
    description: "Initial admin password"
  PAPERLESS_OCR_LANGUAGE:
    default: "eng"
    description: "OCR language (ISO 639-2/T codes, e.g., eng+deu)"
storage:
  data:
    path: /usr/src/paperless/data
    persistent: true
  media:
    path: /usr/src/paperless/media
    persistent: true
  consume:
    path: /usr/src/paperless/consume
    persistent: true
health: /api/
restart: always

Test Results

Last Tested

2026-04-06

Health Check

Passing

Startup Time

27s

Total Disk

1621 MB

Required Services

postgresredis

Learn More

Spec references for features used in this Launchfile.

Related Apps