Paperless-ngx

Notes/Docs

Scan, OCR and archive your paperwork with full-text search.

Paperless-ngx is a community-supported document management system that scans, OCRs, tags and archives all your paper documents so you can go (mostly) paperless. It automatically detects correspondents, tags and document types, and offers full-text search across your entire archive.

License

GPL-3.0

GitHub stars

46,500

Official website

https://docs.paperless-ngx.com

Source code

https://github.com/paperless-ngx/paperless-ngx

Compatibility

Architectures

amd64, arm64

Database

PostgreSQL

Resource footprint

2048 MB RAM · 2 CPU

2 GB RAM / 2 cores handles typical scan-and-archive workloads. OCR (via Tesseract) is the main CPU cost during document consumption; add Tika + Gotenberg containers if you need Office-document conversion, which increases footprint further.

Proof of Work Gallery

Dashboard
Settings
Tasks

Deployment

services:
  broker:
    image: docker.io/library/redis:8
    restart: unless-stopped
    volumes:
      - redisdata:/data

  db:
    image: docker.io/library/postgres:17
    restart: unless-stopped
    volumes:
      - pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless

  webserver:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - data:/usr/src/paperless/data
      - media:/usr/src/paperless/media
      - ./export:/usr/src/paperless/export
      - ./consume:/usr/src/paperless/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
      PAPERLESS_URL: https://paperless.example.com
      PAPERLESS_SECRET_KEY: change-me
      PAPERLESS_TIME_ZONE: Europe/Sofia
      PAPERLESS_OCR_LANGUAGE: eng

volumes:
  data:
  media:
  pgdata:
  redisdata:

Alternative to

DocuWare, M-Files, Google Drive document management