How to Install Docspell on Your Synology NAS

by

How to Install Docspell on Your Synology NAS

Docspell aims to be a simple, yet effective document organizer that makes stowing documents away very quick and finding them later reliable (and also fast). It is a bit opinionated and more targeted for home use and small/medium organizations. In this step by step guide I will show you how to install Docspell on your Synology NAS using Docker & Portainer.

šŸ’”Note:Ā This guide works perfectly with the latest Docspell v0.42.0 release.

  • 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Ā docspell. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Docspell Synology NAS Set up 1

  • STEP 4

Now create two new folders inside the docspell folder that you created at STEP 3 and name them db andĀ solr. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Docspell Synology NAS Set up 2

  • 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 docspell. Follow the instructions in the image below.

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

version: '3.9'
services:
  docspell-db:
    image: postgres
    container_name: Docspell-DB
    hostname: docspell-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "docspell", "-U", "docspelluser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/docspell/db:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=docspell
      - POSTGRES_USER=docspelluser
      - POSTGRES_PASSWORD=docspellpass
    restart: always

  docspell-solr:
    image: solr
    command:
      - solr-precreate
      - docspell
    container_name: Docspell-SOLR
    hostname: docspell-solr
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8983/solr/docspell/admin/ping"]
      interval: 45s
      timeout: 10s
      retries: 2
      start_period: 30s
    user: 1026:100
    volumes:
      - /volume1/docker/docspell/solr:/var/solr
    restart: always

  restserver:
    image: docspell/restserver:latest
    container_name: Docspell-RESTSERVER
    hostname: docspell-restserver
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    ports:
      - 8486:7880
    environment:
      - TZ=Europe/Bucharest
      - DOCSPELL_SERVER_INTERNAL__URL=http://docspell-restserver:7880
      - DOCSPELL_SERVER_ADMIN__ENDPOINT_SECRET=superdupersecretyeah
      - DOCSPELL_SERVER_AUTH_SERVER__SECRET=evenmoresuperdupersecret
      - DOCSPELL_SERVER_BACKEND_JDBC_PASSWORD=docspellpass
      - DOCSPELL_SERVER_BACKEND_JDBC_URL=jdbc:postgresql://docspell-db:5432/docspell
      - DOCSPELL_SERVER_BACKEND_JDBC_USER=docspelluser
      - DOCSPELL_SERVER_BIND_ADDRESS=0.0.0.0
      - DOCSPELL_SERVER_FULL__TEXT__SEARCH_ENABLED=true
      - DOCSPELL_SERVER_FULL__TEXT__SEARCH_SOLR_URL=http://docspell-solr:8983/solr/docspell
      - DOCSPELL_SERVER_INTEGRATION__ENDPOINT_ENABLED=true
      - DOCSPELL_SERVER_INTEGRATION__ENDPOINT_HTTP__HEADER_ENABLED=true
      - DOCSPELL_SERVER_INTEGRATION__ENDPOINT_HTTP__HEADER_HEADER__VALUE=superduperpassword123
      - DOCSPELL_SERVER_BACKEND_SIGNUP_MODE=open
      - DOCSPELL_SERVER_BACKEND_SIGNUP_NEW__INVITE__PASSWORD=
      - DOCSPELL_SERVER_BACKEND_ADDONS_ENABLED=false
    restart: always
    depends_on:
      docspell-db:
        condition: service_started
      docspell-solr:
        condition: service_healthy
  joex:
    image: docspell/joex:latest
    container_name: Docspell-JOEX
    hostname: docspell-joex
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    environment:
      - TZ=Europe/Bucharest
      - DOCSPELL_JOEX_APP__ID=joex1
      - DOCSPELL_JOEX_PERIODIC__SCHEDULER_NAME=joex1
      - DOCSPELL_JOEX_SCHEDULER_NAME=joex1
      - DOCSPELL_JOEX_BASE__URL=http://docspell-joex:7878
      - DOCSPELL_JOEX_BIND_ADDRESS=0.0.0.0
      - DOCSPELL_JOEX_FULL__TEXT__SEARCH_ENABLED=true
      - DOCSPELL_JOEX_FULL__TEXT__SEARCH_SOLR_URL=http://docspell-solr:8983/solr/docspell
      - DOCSPELL_JOEX_JDBC_PASSWORD=docspellpass
      - DOCSPELL_JOEX_JDBC_URL=jdbc:postgresql://docspell-db:5432/docspell
      - DOCSPELL_JOEX_JDBC_USER=docspelluser
      - DOCSPELL_JOEX_ADDONS_EXECUTOR__CONFIG_RUNNER=docker,trivial
      - DOCSPELL_JOEX_CONVERT_HTML__CONVERTER=weasyprint
    restart: always
    depends_on:
      docspell-db:
        condition: service_started
      docspell-solr:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for TZ.Ā (Select your current Time Zone from this list.)

Docspell Synology NAS Set up 3

  • 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.

Docspell 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ā€œ.

Docspell Synology NAS Set up 5

  • STEP 9

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • 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:8486 Select your language and your theme (Dark or White). Click Sign up. Follow the instructions in the image below.

Docspell Synology NAS Set up 6

  • STEP 11

Add your own credentials and remember that the Collective ID and User Login should be the same. Click Submit. Follow the instructions in the image below.

Docspell Synology NAS Set up 7

  • STEP 12

Add your own Username and Password that you have previously created at STEP 11. Click Login. Follow the instructions in the image below.

Docspell Synology NAS Set up 8

  • STEP 13

Click Select yo upload files from your PC. Follow the instructions in the image below.

Docspell Synology NAS Set up 9

  • STEP 14

After you upload the files at STEP 13, click Submit to process your files. Follow the instructions in the image below.

Docspell Synology NAS Set up 10

  • STEP 15

The files will be processed one by one and this will require some minutes to finish.

Docspell Synology NAS Set up 11

Enjoy Docspell!

šŸ†˜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 Docspell container over HTTPS, check 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 Docspell 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 Thursday / January 9th, 2025 at 7:46 PM

šŸ§” I Need Your Help!