Install Paperless-ngx on Your Synology NAS with Docker

Last updated on May 9th, 2023 at 10:42 am

Paperless-NGX is a web-based platform that provides an electronic paperless solution to various industries and businesses. It’s an innovative platform that enables organizations to move away from traditional paper-based methods to a more efficient and environmentally friendly digital process. With Paperless-NGX, businesses can automate their processes, reduce the use of paper, and improve overall efficiency.

Code Source: GitHub

Skip to Docker Run Code / Skip to Compose & Portainer Code

Features

• Organize and index your scanned documents with tags, correspondents, types, and more.
• Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
• Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
• Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
• Email processing: Paperless adds documents from your email accounts.

For more features, click here

Install Docker

Before we start, please ensure you have Docker installed. This can be installed through the Synology Package Center.

Create the Paperless Docker Folders

We will now create the Docker folder. Head into File Station and open the Docker folder. Select Create, choose Create folder and name it paperless_ngx. Inside the paperless_ngx folder, create a new folder and call this data. (see demonstration)

Create the Scheduled Task

We will now head into Control Panel > Task Scheduler > Create > Scheduled Task and click User-defined script. (see demonstration)

Configure the Scheduled Task

In the window that appears, insert the following:

In the General tab, In the Task field, enter Paperless. From the User list, select root. Uncheck the Enabled option.

In the Schedule tab, Select Run on the following date (make sure It’s today’s date). Now select Do not repeat.

In the Task Settings tab, under Notification, You can choose to turn this on, otherwise skip this. Now copy-paste the following code into the Run command area. Now click OK.

docker run -d \
  --name=paperless-ngx \
  -e PUID=1026 \
  -e PGID=100 \
  -e TZ=Europe/London \
  -e REDIS_URL= `#optional` \
  -p 8000:8000 \
  -v /volume1/docker/paperless_ngx:/config \
  -v /volume1/docker/paperless_ngx/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/paperless-ngx

Important: Make sure you change the Directory paths to match your own. You will also need to ensure you update the PUID and the PGID values.

REDIS_URL: Specify an external redis instance to use. Can optionally include a port (redis:6379) and/or db (redis/foo). If left blank or not included, will use a built-in redis instance. If changed after initial setup will also require manual modification of /config/settings.py

Accept the warning prompt

When the below warning appears, press OK.

Run the Paperless Scheduled Task

From the list of tasks, select Paperless. From the top menu, press Run. When asked to run, press Yes.

Paperless is Installed

Paperless has now finished installing. Give it a few seconds to appear in your Docker list.

Access Paperless

You can now access the Paperless container using http://synologyip:8000.

Important: The default username and password is admin.

Docker Compose and Portainer

If you would prefer to install with Docker Compose or Portainer, use the following code. You can also view a demonstration here.

version: '3.3'
services:
    linuxserver:
        container_name: paperless-ngx
        environment:
            - PUID=1026
            - PGID=100
            - TZ=Europe/London
            - REDIS_URL=
        ports:
            - '8000:8000'
        volumes:
            - '/volume1/docker/paperless_ngx:/config'
            - '/volume1/docker/paperless_ngx/data:/data'
        restart: unless-stopped
        image: lscr.io/linuxserver/paperless-ngx

---

More Guides:

Actual AdGuard airsonic Audiobookshelf autobrr Bitcoin Calibre-Web ChatpadAI Cleanarr Composerize Crypto DailyTxT Dashy deemix Deluge Emby EmulatorJS Ethereum Euterpe FileBot FilePizza FileZilla Flame Focalboard FreshRSS Grafana Grocy Heimdall Homarr Home Assistant Homebridge Jackett Jellyfin Jellyseerr Joplin Kavita Komga LanguageTool LibreOffice Lidarr Mealie MediaGoblin Medusa Memegen Minecraft Minecraft Bedrock MQTT MusicBrainz MyMediaForAlexa Navidrome Node-RED NZBGet NZBHydra Ombi Overseerr PaperlessNGX Pashword Password Cards Petio Pi-Hole Picard Plex Portainer PostgreSQL Prowlarr PUID & PGID pwndrop Radarr Radicale Readarr ruTorrent SABnzbd SearX Seed Phrase Shiori Sonarr SpeedTest Stash Storm Tailscale TasmoAdmin Tautulli Theia Trilium TubeSync Unpackerr Uptime Kuma Vaultwarden Watchtower WebPDF Whisparr Wordle YouTubeDL

---