How to Install Kutt on Your Synology NAS

by

How to Install Kutt on Your Synology NAS

Kutt is a modern URL shortener with support for custom domains. Create and edit links, view statistics, manage users, and more. In this step by step guide I will show you how to install KuttĀ on yourĀ Synology NASĀ using Docker & Portainer.

šŸ’”Note: This guide works perfectly with the latest version of Kutt v.3.2.3

  • 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

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

  • STEP 4

Go toĀ Control PanelĀ /Ā Login PortalĀ /Ā AdvancedĀ Tab / clickĀ Reverse Proxy. Follow the instructions in the image below.

Kutt Synology NAS Set up 1

  • STEP 5

Now click the ā€œCreateā€ button. Follow the instructions in the image below.

Kutt Synology NAS Set up 2

  • STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in Kutt. After that, add the following instructions:

Source:
Protocol:Ā HTTPS
Hostname: kutt.yourname.synology.me
Port:Ā 443

Check Enable HSTS

Destination:
Protocol:Ā HTTP
Hostname:Ā localhost
Port: 3234

Kutt Synology NAS Set up 3

  • STEP 7

On the Reverse Proxy Rules click the Custom HeaderĀ tab. ClickĀ CreateĀ and then, from the drop-down menu, clickĀ WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. ClickĀ Save. Follow the instructions in the image below.

Synology Proxy WebSocket

  • STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Kutt Synology NAS Set up 4

  • STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP CompressionĀ then click Apply. Follow the instructions in the image below.

Kutt Synology NAS Set up 5

  • STEP 10

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

Kutt Synology NAS Set up 6

  • STEP 11

Now create three new folders inside the kutt folder that you have previously created at STEP 10 and name them custom, db, redis. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Kutt Synology NAS Set up 7

  • STEP 12

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 13

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

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

services:
  kutt:
    image: kutt/kutt:latest
    container_name: Kutt
    volumes:
      - /volume1/docker/kutt/db:/var/lib/kutt:rw
      - /volume1/docker/kutt/custom:/kutt/custom:rw
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 3000 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
      DB_FILENAME: "/var/lib/kutt/data.sqlite"
      REDIS_ENABLED: true
      REDIS_HOST: redis
      REDIS_PORT: 6379
      JWT_SECRET: dOxZYTTZgXKMHkqLBIQVImayQXAVWdzGBPuFJKggzcgvgPJPXpWzqzKaUOIOGGIr
      TRUST_PROXY: true
      DEFAULT_DOMAIN: kutt.yourname.synology.me
    ports:
      - 3234:3000
    depends_on:
      redis:
       condition: service_healthy
       
  redis:
    image: redis:alpine
    container_name: Kutt-REDIS
    healthcheck:
     test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    volumes:
      - /volume1/docker/kutt/redis:/data:rw
    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 DEFAULT_DOMAINĀ and type in your own your own synology.me DDNS withoutĀ https:// at the beginning that you have previously created at STEP 6.

Kutt Synology NAS Set up 8

  • STEP 14

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.

Kutt Synology NAS Set up 9

  • STEP 15

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

Kutt Synology NAS Set up 10

  • STEP 16

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

Now open your browser and type in your HTTPS/SSL certificate like this https://kutt.yourname.synology.me In my case it’s https://kutt.mariushosting.synology.me If everything goes right, you will see the Kutt registration page. Type in your own Email address and Password. Click Create admin account. Follow the instructions in the image below.

Kutt Synology NAS Set up 11

  • STEP 18

Type in the Email address and Password that you have previously added at STEP 17. Click Log in. Follow the instructions in the image below.

Kutt Synology NAS Set up 12

  • STEP 19

In the apposite area, type in your long URL link that you want to shorten, then click the send icon. Follow the instructions in the image below.

Kutt Synology NAS Set up 13

  • STEP 20

Your shortened link at a glance! You can easily check the stats by clicking the purple statistics icon. Follow the instructions in the image below.

Kutt Synology NAS Set up 14

Enjoy Kutt!

šŸ†˜TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issuesĀ article.

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 Kutt 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 Monday / March 10th, 2025 at 12:18 PM

šŸ§” I Need Your Help!