How to Install Spoolman on Your Synology NAS

by

How to Install Spoolman on Your Synology NAS

Spoolman is a web service that helps you keep track of your filament spools and how they are being used. It acts as a database where other printer software such as Octoprint and Moonraker can interact with to have a centralized place for spool information. For example, if used together with Moonraker, your spool weight will automatically be reduced as your print is progressing. In this step by step guide I will show you how to install Spoolman on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Spoolman v0.20.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 spoolman. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Spoolman Synology NAS Set up 1

  • STEP 4

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

Spoolman 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 spoolman. Follow the instructions in the image below.

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

version: "3.9"
services:
  db:
    image: postgres:16
    container_name: Spoolman-DB
    hostname: spoolman-db
    mem_limit: 1g
    cpu_shares: 1024
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "spoolman", "-U", "spoolmanuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/spoolman/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: spoolman
      POSTGRES_USER: spoolmanuser
      POSTGRES_PASSWORD: spoolmanpass
    restart: on-failure:5

  spoolman:
    image: ghcr.io/donkie/spoolman:latest
    container_name: Spoolman
    hostname: spoolman
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:8000/
    ports:
      - 7912:8000
    environment:
      SPOOLMAN_DB_TYPE: postgres
      SPOOLMAN_DB_HOST: spoolman-db
      SPOOLMAN_DB_PORT: 5432
      SPOOLMAN_DB_NAME: spoolman
      SPOOLMAN_DB_USERNAME: spoolmanuser
      SPOOLMAN_DB_PASSWORD: spoolmanpass
      PUID: 1026
      PGID: 100
      TZ: Europe/Bucharest
      FORWARDED_ALLOW_IPS: "*"
      SPOOLMAN_DEBUG_MODE: TRUE
    volumes:
      - /volume1/docker/spoolman/data:/home/app/.local/share/spoolman:rw
    restart: on-failure:5
    depends_on:
      db:
        condition: service_healthy

Note: Before you paste the code above in the Web editor 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 Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

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

Spoolman 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“.

Spoolman Synology NAS Set up 5

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

Spoolman Synology NAS Set up 6

Enjoy Spoolman!

🆘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 Spoolman container over HTTPS to have access to the QR codes function, check How to Run Docker Containers Over HTTPS. In order to make Spoolman work via HTTPS, it’s mandatory to activate WebSocket.

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 Spoolman 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 / September 12th, 2024 at 12:39 PM

🧡 I Need Your Help!