fakeridoo/paperless-scanner repository overview

⁠Paperless Scanner

A lightweight web-based scanner bridge for Paperless-ngx — runs as a Docker container.

⁠Features

• 📄 Web-based scanning interface to trigger scans
• ⚙️ Persistent settings (saved to config/config.json)
• 🔧 Connection testing to verify Paperless-ngx access
• 📜 Real-time logs (server-sent events)
• 🏷️ Configurable default tags for uploads
• 📱 Mobile-friendly UI

⁠Quick start

docker pull fakeridoo/paperless-scanner:latest

⁠Run (example)

docker run --rm -it \
   -p 3000:3000 \
   --device /dev/bus/usb:/dev/bus/usb \
   -v $(pwd)/scans:/tmp \
   -v $(pwd)/config:/usr/src/app/config:rw \
   --privileged \
   fakeridoo/paperless-scanner:latest

Note: If config/config.json is not present in the bound host directory, the container entrypoint will create a default config/config.json file at first boot. You can then edit this file with your Paperless-ngx URL and API token.

⁠Docker Compose (example)

version: '3.8'
services:
   scanner:
      image: fakeridoo/paperless-scanner:latest
      container_name: paperless-scanner
      ports:
         - "3000:3000"
      volumes:
         - ./scans:/tmp
         - ./config:/usr/src/app/config:rw
      devices:
         - "/dev/bus/usb:/dev/bus/usb"
      network_mode: host
      restart: unless-stopped
      privileged: true