How to Install Paperless on Your Synology NAS

by

How to Install Paperless on Your Synology NAS

Paperless, code name Paperless-ng, is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents. In this step by step guide I will show you how to install Paperless on your Synology NAS using Docker.

Paperless Deprecation Notice: Due to the upstream project no longer being in development, the Paperless container is now deprecated. This means you can continue to install it and use it, but there will be no more updates of any kind to the software. In any case, if a developer may decide to pick up and continue the project, I will update the article accordingly. As an alternative, you can check my new guide on how to install the new Paperless-NGX.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Container Manager via Synology “Package Center”. If you run an older DSM version (under 7.2), search for Docker instead of Container Manager.

Download Container Manager Synology Docker

  • STEP 3

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

Paperless Synology NAS Set up 1

  • STEP 4

Now create two new folders inside the paperless folder that you created at STEP 3 and name one “config” and the other “data“. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Paperless Synology NAS Set up 2

  • STEP 5

Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.

Synology User Defined Script

  • STEP 6

Once you click on User-defined script, a new window will open. Follow the instructions below:

  1. General: In the Task field type in Install Paperless. Uncheck the “Enabled” option. Select root User.
  2. Schedule: Select Run on the following date then select “Do not repeat“.
  3. Task Settings: Check “Send run details by email“, add your email then copy paste the code below in the Run command area. After that, click OK.
docker run -d --name=paperless-ng \
-p 8931:8000 \
-e PUID=1026 \
-e PGID=100 \
-e TZ=Europe/Bucharest \
-v /volume1/docker/paperless/config:/config \
-v /volume1/docker/paperless/data:/data \
--restart always \
ghcr.io/linuxserver/paperless-ng

Note: Before you paste the code above in the Run command area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)
Note: Before you paste the code above in the Run command area below, change the value for TZ. (Select your current Time Zone from this list.)

Paperless Synology NAS Set up 4 new 2023

  • STEP 7

After you click OK on STEP 6 a new warning pop up window will open. Click OK.

Paperless Synology NAS Set up 5

After you click OK, type in your DSM Password then click Submit. Follow the instructions in the image below.

Synology Task Scheduler Confirm Admin Password

  • STEP 8

After you click Submit on STEP 7, select your “Install Paperless” Task then click the “Run” tab. You will be asked to run Install Paperless – click OK. Follow the instructions in the image below.

Paperless Synology NAS Set up 6

  • STEP 9

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

  • STEP 10

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:8931 Type in the default username and password, then click Sign in.

⚠️Warning: the default username is admin and the default password is admin

Paperless Synology NAS Set up 7

  • STEP 11

Start to upload your documents!

Paperless Synology NAS Set up 8

Enjoy Paperless!

Paperless Synology NAS Set up 9

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the Paperless container over HTTPS, check out my guide on How to Run Docker Containers Over HTTPS.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the Paperless container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert 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 Saturday / February 24th, 2024 at 7:19 PM

🧡 I Need Your Help!