Synology: Install Paperless NGX With Office Files Support

Synology Install Paperless NGX With Office Files Support

Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper. After my article on How to Install Paperless NGX on Your Synology NAS, many people have contacted me asking for an even more comprehensive guide so that office files such as .docx could also be uploaded. In this step by step guide I will show you how to install Paperless-ngx with Office files support on your Synology NAS using Docker & Portainer.

Note: This guide works perfectly with the latest Paperless-ngx 1.10.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 three new folders and name them paperdb, paperedis, paperlessngx. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Paperless ngx office Synology NAS Set up 1

  • STEP 4

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

Paperless ngx office 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 paperlessngxdoc. Follow the instructions in the image below.

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

version: "3.6"
services:
  redis:
    image: redis
    container_name: paperless-redis
    restart: always
    volumes:
      - /volume1/docker/paperedis:/data

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

  webserver:
    image: ghcr.io/paperless-ngx/paperless-ngx
    container_name: paperlessngx
    restart: always
    depends_on:
      - db
      - redis
      - gotenberg
      - tika
    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://redis: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
      PAPERLESS_TIKA_ENABLED: 1
      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000/forms/libreoffice/convert#
      PAPERLESS_TIKA_ENDPOINT: http://tika:9998

  gotenberg:
    image: gotenberg/gotenberg
    restart: always
    container_name: gotenberg
    ports:
      - 3000:3000
    command:
      - "gotenberg"
      - "--chromium-disable-routes=true"
  
  tika:
    image: ghcr.io/paperless-ngx/tika
    container_name: tika
    ports:
      - 9998:9998
    restart: always

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 of 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 of a password. You have to insert your own password.

Paperlessngx office Synology NAS Set up 0 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 office Synology NAS Set up 1 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“.

3 Paperlessngx office Synology NAS Set up

  • 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 Add your own Username and Password you have chosen at STEP 6 then click Sign in. Follow the instructions in the image below.

Paperless ngx office Synology NAS Set up 7

  • STEP 11

Start uploading your documents now with Office files support!

Paperlessngx office Synology NAS Set up 2 new 2023

Enjoy Paperless-ngx with Office files support!

Paperlessngx office Synology NAS Set up 3 new 2023

You can also enable dark mode and change the theme sidebar color. On the left sidebar click on Settings. Check Enable dark mode then click Save. Follow the instructions in the image below.

Paperlessngx office Synology NAS Set up 4 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:

Troubleshoot: If you get the “Error while converting document to PDF: 503 Server Error: Service Unavailable for url: http://gotenberg:3000/forms/libreoffice/convert” – This is usually due to the server being “down” for scheduled maintenance or due to a heavy traffic load that prevents it from properly serving all incoming requests. You need to wait until the server is back up again.

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.

This post was updated on Monday / November 28th, 2022 at 6:18 PM