How to Install Paperless NGX on Your Synology NAS

How to Install Paperless NGX on Your Synology NAS

Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper. Paperless-ngx forked from paperless-ng to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. The paperless-ng and paperless-ngx Unraid templates will coexist in the community application store. That allows existing users to still rely on the mature paperless-ng for their productive environment and make the change to paperless-ngx once they feel comfortable. NG stands for both Angular (the framework used for the Frontend) and next-gen. Publishing this project under a different name also avoids confusion between paperless and paperless-ngx. In this step by step guide I will show you how to install Paperless-ngx on your Synology NAS using Docker & Portainer. If what you are looking for is to be able to also upload Office documents such as .docx, I recommend you install Paperless-NGX with Office Files Support and enjoy a complete product.

Note: This guide works perfectly with the latest Paperless-ngx 1.12.2 release.

Note: Check out my new guide on how to Install Paperless-ngx with Office Files Support.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it paperlessngx. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Paperlessngx Synology NAS Set up 1 new 2023

  • STEP 4

Now create six new folders inside the paperlessngx folder that you created at STEP 3 and name them consume, data, db, export, media, redis. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Paperlessngx Synology NAS Set up 2 new 2023

  • STEP 5

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 6

In the Name field type in paperless-ngx. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.6"
services:
  broker:
    image: redis
    container_name: Paperless-NGX-REDIS
    restart: always
    volumes:
      - /volume1/docker/paperlessngx/redis:/data

  db:
    image: postgres
    container_name: Paperless-NGX-DB
    restart: always
    volumes:
      - /volume1/docker/paperlessngx/db:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless

  webserver:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    container_name: Paperless-NGX
    restart: always
    depends_on:
      - db
      - broker
    ports:
      - 8777:8000
    volumes:
      - /volume1/docker/paperlessngx/data:/usr/src/paperless/data
      - /volume1/docker/paperlessngx/media:/usr/src/paperless/media
      - /volume1/docker/paperlessngx/export:/usr/src/paperless/export
      - /volume1/docker/paperlessngx/consume:/usr/src/paperless/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
      USERMAP_UID: 1026
      USERMAP_GID: 100
      PAPERLESS_TIME_ZONE: Europe/Bucharest
      PAPERLESS_ADMIN_USER: marius
      PAPERLESS_ADMIN_PASSWORD: mariushosting
      PAPERLESS_OCR_LANGUAGE: deu+eng

Note: Before you paste the code above in the Web editor area, change the values for USERMAP_UID and USERMAP_GID with your own number values. (Follow my step by step guide on how to do this.)
Note: Before you paste the code above in the Web editor area, change the value for PAPERLESS_TIME_ZONE with your own time zone value. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area, change the value for PAPERLESS_ADMIN_USER and add your own username. marius is an example for a username. You have to insert your own username.
Note: Before you paste the code above in the Web editor area, change the value for PAPERLESS_ADMIN_PASSWORD and add your own password. mariushosting is an example for a password. You have to insert your own password.

Paperlessngx Synology NAS Set up 3 new 2023

  • STEP 7

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

Paperlessngx Synology NAS Set up 4 new 2023

  • STEP 8

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

Paperlessngx Synology NAS Set up 5 new 2023

  • STEP 9

Go back to STEP 1 or you will deal with karma 🙂.

  • STEP 10

Now open your browser and type in http://Synology-ip-address:8777 Type in your own Username and Password that you have previously created at STEP 6 then click Sign in. Follow the instructions in the image below.

Paperless ngx Synology NAS Set up 6 new 2023

  • STEP 11

Start uploading your documents!

Paperless ngx Synology NAS Set up 7 new 2023

Enjoy Paperless-ngx!

Paperless ngx Synology NAS Set up 8 new 2023

You can also enable Dark Mode and change the Sidebar Color Theme. On the left sidebar click on Settings then follow the instructions below.

Uncheck Use system settings
Check Enable dark mode.
Uncheck Invert thumbnails in dark mode.
Change your Theme Color then click Save. Follow the instructions in the image below.

Paperless ngx Synology NAS Set up 9 new 2023

Note: If you want to run the Paperless-ngx container over HTTPS, check my guide on How to Run Docker Containers Over HTTPS. If you want to use reverse proxy to access Paperless-ngx over HTTPS, in the code at STEP 6 you also need to add the environment PAPERLESS_URL: https://paperless.yourname.synology.me just after PAPERLESS_ADMIN_PASSWORD:

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Paperless-ngx container with the latest image.
NoteHow to Free Disk Space on Your NAS if You Run Docker.
NoteHow to Schedule Start & Stop For Docker Containers.
NoteHow to Activate Email Notifications.
NoteHow to Add Access Control Profile on Your NAS.
NoteHow to Change Docker Containers Restart Policy.
NoteHow to Use Docker Containers With VPN.
NoteConvert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Wednesday / February 1st, 2023 at 4:53 AM