How to Install Jellystat on Your Synology NAS

by

How to Install Jellystat on Your Synology NAS

Jellystat is a free, open-source statistics application designed for Jellyfin, a media server platform. It provides detailed insights into media usage, including session monitoring, user activity, watch history, and library statistics. In this step by step guide I will show you how to install Jellystat on your Synology NAS using Docker & Portainer.

šŸ’”Note:Ā This guide works perfectly with the latest Jellystat v1.1.5Ā release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Mandatory STEP. Install Jellyfin or Jellyfin with Hardware Transcoding using my guide. If you have already Installed Jellyfin, skip this STEP.

  • STEP 3

Open your current Jellyfin instance. On the left sidebar, click Dashboard. Follow the instructions in the image below.

Jellystat Synology NAS Set up 1

  • STEP 4

A new sidebar will open. On the left sidebar, click API Keys then API Keys +icon. Type in Jellystat as an App name. Click Ok. Follow the instructions in the image below.

Jellystat Synology NAS Set up 2

  • STEP 5

Your API Key will be automatically generated. Copy it in a safe place. You will need this API Key later at STEP 15.

Jellystat Synology NAS Set up 3

  • STEP 6

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 7

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

Jellystat Synology NAS Set up 4

  • STEP 8

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

Jellystat Synology NAS Set up 5

  • STEP 9

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 10

In the Name field type in jellystat. Follow the instructions in the image below.

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

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

  jellystat:
    image: cyfershepard/jellystat:latest
    container_name: Jellystat
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/3000' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s  
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: jellystatpass
      POSTGRES_IP: jellystat-db
      POSTGRES_PORT: 5432
      JWT_SECRET: dOxZYTTZgXKMHkqLBIQVImayQXAVWdzGBPuFJKggzcgvgPJPXpWzqzKaUOIOGGIr
      IS_EMBY_API: false # Set to true if you use Emby instead of Jellyfin.
      TZ: Europe/Bucharest
    volumes:
      - /volume1/docker/jellystat/backup:/app/backend/backup-data:rw
    ports:
      - 3791:3000
    depends_on:
      - db
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for JWT_SECRET. (Generate your own Random 64 length JWT_SECRET.)
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.)

Jellystat Synology NAS Set up 6

  • STEP 11

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.

Jellystat Synology NAS Set up 7

  • STEP 12

If everything goes right, you will see this message at the top right of your screen: ā€œSuccess Stack successfully deployedā€œ.

Jellystat Synology NAS Set up 8

  • STEP 13

šŸŸ¢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 14

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:3791 If everything goes right, you will see the Jellystat setup page. Type in your own Username and Password, then click Create User. Follow the instructions in the image below.

Jellystat Synology NAS Set up 9

  • STEP 15

In the URL area, type in your Jellyfin address. http:// then YOUR NAS LOCAL IP number followed by :8096
In the API Key area, type in your Jellyfin API Key that you have previously created at STEP 5.
Click Save Jellyfin Details. Follow the instructions in the image below.
Note: In the URL area you can also type in your Jellyfin Synology.me DDNS like https://jellyfin.yourname.synology.me

Jellystat Synology NAS Set up 10

  • STEP 16

Your Jellystat dashboard at a glance!

Jellystat Synology NAS Set up 11

Enjoy Jellystat!

šŸ†˜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 Jellystat container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Jellystat 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 Jellystat 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 Wednesday / April 23rd, 2025 at 11:45 PM

šŸ§” I Need Your Help!