How to Install Mayan EDMS on Your Synology NAS

How to Install Mayan EDMS on Your Synology NAS

Mayan is a web-based free/libre document management system for managing documents within an organization. All functionality is available in its free public version. It has an active community of volunteers and third-party service and support providers. I think Mayan EDMS is the most advanced open source document management system. In this step by step guide I will show you how to install Mayan EDMS on your Synology NAS using Docker and Portainer.

Note: This guide works perfectly with the latest Mayan EDMS v4.3.3 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 mayanedms. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Mayan EDMS Synology NAS Set up 1

  • STEP 4

Now create six new folders inside the netbox folder that you created at STEP 3 and name them app, db, rabbitmq, redis, staging, watch. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Mayan EDMS 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 mayanedms. Follow the instructions in the image below.

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

version: '3.9'
services:
  mayan-redis:
    image: redis
    command:
      - redis-server
      - --appendonly
      - "no"
      - --databases
      - "3"
      - --maxmemory
      - "100mb"
      - --maxclients
      - "500"
      - --maxmemory-policy
      - "allkeys-lru"
      - --save
      - ""
      - --tcp-backlog
      - "256"
      - --requirepass
      - "mayanredispassword"
    container_name: Mayan-REDIS
    hostname: mayan-redis
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    user: 1026:100
    environment:
      - TZ=Europe/Bucharest
    volumes:
      - /volume1/docker/mayanedms/redis:/data
    restart: always

  mayan-db:
    image: postgres
    command:
      - "postgres"
      - "-c"
      - "checkpoint_completion_target=0.6"
      - "-c"
      - "default_statistics_target=200"
      - "-c"
      - "maintenance_work_mem=128MB"
      - "-c"
      - "max_connections=150"
      - "-c"
      - "shared_buffers=256MB"
      - "-c"
      - "work_mem=8MB"
    container_name: Mayan-DB
    hostname: mayan-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "mayan", "-U", "mayanuser"]
      interval: 10s
      timeout: 5s
      retries: 5
    user: 1026:100
    volumes:
      - /volume1/docker/mayanedms/db:/var/lib/postgresql/data
    environment:
      - TZ=Europe/Bucharest
      - POSTGRES_DB=mayan
      - POSTGRES_USER=mayanuser
      - POSTGRES_PASSWORD=mayandbpass
    restart: always

  maya-rabbitmq:
    image: rabbitmq:3.9-management-alpine
    container_name: Mayan-RABBITMQ
    hostname: mayan-rabbitmq
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: rabbitmq-diagnostics -q ping
      interval: 30s
      timeout: 30s
      retries: 3
    user: 1026:100
    volumes:
      - /volume1/docker/mayanedms/rabbitmq:/var/lib/rabbitmq
    environment:
      RABBITMQ_DEFAULT_USER: mayanuser
      RABBITMQ_DEFAULT_PASS: mayanrabbitpass
      RABBITMQ_DEFAULT_VHOST: mayan
    restart: always

  mayan:
    image: mayanedms/mayanedms:s4.3
    container_name: Mayan
    hostname: mayan
    security_opt:
      - no-new-privileges:true
    ports:
      - 192.168.1.18:8340:8000
    volumes:
      - /volume1/docker/mayanedms/app:/var/lib/mayan
      - /volume1/docker/mayanedms/staging:/staging_folder
      - /volume1/docker/mayanedms/watch:/watch_folder
    environment:
      MAYAN_CELERY_BROKER_URL: amqp://mayanuser:mayanrabbitpass@mayan-rabbitmq:5672/mayan
      MAYAN_CELERY_RESULT_BACKEND: redis://:mayanredispassword@mayan-redis:6379/1
      MAYAN_DATABASES: "{'default':{'ENGINE':'django.db.backends.postgresql','NAME':'mayan','PASSWORD':'mayandbpass','USER':'mayanuser','HOST':'mayan-db'}}"
      MAYAN_LOCK_MANAGER_BACKEND: mayan.apps.lock_manager.backends.redis_lock.RedisLock
      MAYAN_LOCK_MANAGER_BACKEND_ARGUMENTS: "{'redis_url':'redis://:mayanredispassword@mayan-redis:6379/2'}"
    restart: always
    depends_on:
      mayan-redis:
        condition: service_healthy
      mayan-db:
        condition: service_healthy
      maya-rabbitmq:
        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.)
Note: Before you paste the code above in the Web editor area below, change the value for ports and add your own Synology Local NAS IP. 192.168.1.18 is my own Synology Local NAS IP. You should type in your own Synology Local NAS IP.

Mayan EDMS 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.

Mayan EDMS Synology NAS Set up 4

  • STEP 8

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

Mayan EDMS Synology NAS Set up 5

  • STEP 9

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

  • STEP 10

Please wait approximately 10 minutes for the installation to be completed or you will get a blank page if you try to connect too soon. Now open your browser and type in http://Synology-ip-address:8340 add the credentials that are automatically created, username and password, then click Submit. Note: Right down your password. You will need this password at STEP 12. Follow the instructions in the image below.

Mayan EDMS Synology NAS Set up 6

  • STEP 11

The page will look like this.

Mayan EDMS Synology NAS Set up 7

  • STEP 12

At the top right of the page click User then Change password to change the default password with your own personalized password. Click Submit. Follow the instructions in the image below.

Mayan EDMS Synology NAS Set up 8

  • STEP 13

On the left Sidebar click New document. Drag & Drop your Documents then click Default. Follow the instructions in the image below.

Mayan EDMS Synology NAS Set up 9

  • STEP  14

Your documents will be successfully uploaded.

Mayan EDMS Synology NAS Set up 10

  • STEP 15

Your documents at a glance.

Mayan EDMS Synology NAS Set up 11

  • STEP 16

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

Mayan EDMS Synology NAS Set up 12

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Mayan EDMS 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 Wednesday / November 23rd, 2022 at 12:36 AM