How to Install YouTrack on Your Synology NAS

How to Install YouTrack on Your Synology NAS

YouTrack is a proprietary, commercial browser-based bug tracker, issue tracking system and project management software developed by JetBrains. It focuses on query-based issue search with auto-completion, manipulating issues in batches, customizing the set of issue attributes, and creating custom workflows. In this step by step guide I will show you how to install YouTrack on your Synology NAS with Docker & Portainer.

💡Note: This guide works perfectly with the latest version of YouTrack 2023.3.22268

  • 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

Install Text Editor via Synology “Package Center”. (Mandatory STEP.) If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • STEP 5

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

YouTrack Synology NAS Set up 1

  • STEP 6

Now click the “Create” button. Follow the instructions in the image below.

YouTrack Synology NAS Set up 2

  • STEP 7

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 YouTrack. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: youtrack.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 4072

YouTrack Synology NAS Set up 3

  • STEP 8

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 9

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

YouTrack Synology NAS Set up 4

  • STEP 10

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

YouTrack Synology NAS Set up 5

  • STEP 11

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

YouTrack Synology NAS Set up 6

  • STEP 12

Now create four new folders inside the youtrack folder that you created at STEP 11 and name them backups, config, data, logs. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

YouTrack Synology NAS Set up 7

  • STEP 13

Right click on the youtrack folder that you have previously created at STEP 11 then click Properties. Follow the instructions in the image below.

YouTrack Synology NAS Set up 8

  • STEP 14

Go to the Permission tab then click Advanced options. From the drop-down menu choose “Make inherited permissions explicit“. Follow the instructions in the image below.

YouTrack Synology NAS Set up 9

  • STEP 15

Select Everyone then click the Edit tab. Follow the instructions in the image below.

YouTrack Synology NAS Set up 10

  • STEP 16

Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.

YouTrack Synology NAS Set up 11

  • STEP 17

After you click Done on STEP 16, check “Apply to this folder, sub-folders and files“. Click Save. Follow the instructions in the image below.

YouTrack Synology NAS Set up 12

 

  • STEP 18

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 19

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

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

version: "3.9"
services:
  youtrack:
    image: jetbrains/youtrack:2023.3.22268
    container_name: YouTrack
    hostname: youtrack
    mem_limit: 4g
    shm_size: 2g
    cpu_shares: 1024
    security_opt:
      - seccomp:unconfined
    ports:
      - 4072:8080
    volumes:
      - /volume1/docker/youtrack/data:/opt/youtrack/data:rw
      - /volume1/docker/youtrack/config:/opt/youtrack/conf:rw
      - /volume1/docker/youtrack/logs:/opt/youtrack/logs:rw
      - /volume1/docker/youtrack/backups:/opt/youtrack/backups:rw
    restart: on-failure:5

YouTrack Synology NAS Set up 13

  • STEP 20

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.

YouTrack Synology NAS Set up 14

  • STEP 21

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

YouTrack Synology NAS Set up 15

⌛Now just wait because the YouTrack image is about 1GB.

  • STEP 22

Go to docker / youtrack / config / internal / services / configurationWizard then open the wizard_token.txt file. Follow the instructions in the image below.
Note: You can visualize the wizard_token.txt file only if you have Synology Text Editor installed as per the instructions at STEP 4.

YouTrack Synology NAS Set up 16

  • STEP 23

Copy the Token Key inside the wizard_token.txt file. You will need it later at STEP 25. Follow the instructions in the image below.

YouTrack Synology NAS Set up 17

  • STEP 24

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

  • STEP 25

Now open your browser and type in your HTTPS/SSL certificate like this https://youtrack.yourname.synology.me In my case it’s https://youtrack.mariushosting.synology.me If everything goes right, you will see the YouTrack setup page. In the Token area type in your own token key that you have previously copied at STEP 23. Click Log in. Follow the instructions in the image below.

YouTrack Synology NAS Set up 18

  • STEP 26

Click Set up. Follow the instructions in the image below.

YouTrack Synology NAS Set up 19

  • STEP 27

Click on the HTTP tab, then type in the https:// your synology.me DDNS address that you have previously created at STEP 7. Click Next. Follow the instructions in the image below.

YouTrack Synology NAS Set up 20

  • STEP 28

Click Finish. Follow the instructions in the image below.

YouTrack Synology NAS Set up 21

  • STEP 29

Choose Use Built-in Hub. Create your Admin login Username and Password then click Next. Follow the instructions in the image below.

YouTrack Synology NAS Set up 22

  • STEP 30

Wait approximately 5 minutes until YouTrack is installed. Follow the instructions in the image below.

YouTrack Synology NAS Set up 23

  • STEP 31

Type in your own Username and Password that you have previously created at STEP 29 then click Log in. Follow the instructions in the image below.

YouTrack Synology NAS Set up 24

  • STEP 32

Your YouTrack dashboard at a glance!

YouTrack Synology NAS Set up 25

Enjoy YouTrack!

🆘TROUBLESHOOTING

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

Note: YouTrack Full Documentation.

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 YouTrack 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 Saturday / February 24th, 2024 at 5:37 AM