Vikunja is an open source, selfhosted application. With Vikunja you can easily organize all of your tasks in lists. Put lists together in a namespace to keep related stuff grouped together. Vikunja lets you easily share a list or a namespace with another user or a whole team! You can also assign tasks to people so everybody knows who’s working on what. In this step by step guide I will show you how to install Vikunja on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest Vikunja v0.21.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

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 / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 5

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

• STEP 6

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

• STEP 7

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

• STEP 8

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3456

• STEP 9

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.

• STEP 10

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

• STEP 11

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

• STEP 12

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 4441

• STEP 13

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.

• STEP 14

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

• STEP 15

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

• STEP 16

Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.

• STEP 17

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.

• STEP 18

In the Name field type in vikunja. 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
    container_name: Vikunja-DB
    hostname: vikunja-db
    mem_limit: 512m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "vikunja", "-U", "vikunjauser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/vikunja/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: vikunja
      POSTGRES_USER: vikunjauser
      POSTGRES_PASSWORD: vikunjapass
    restart: on-failure:5

  api:
    image: vikunja/api:latest
    container_name: Vikunja-API
    hostname: vikunja-api
    mem_limit: 512m
    cpu_shares: 512
    security_opt:
      - no-new-privileges:true
    ports:
      - 3456:3456
    volumes:
      - /volume1/docker/vikunja/data:/app/vikunja/files:rw
    environment:
      PUID: 1026
      PGID: 100
      VIKUNJA_MAILER_ENABLED: true
      VIKUNJA_MAILER_HOST: smtp.gmail.com
      VIKUNJA_MAILER_PORT: 587
      VIKUNJA_MAILER_SKIPTLSVERIFY: false
      VIKUNJA_MAILER_AUTHTYPE: login
      VIKUNJA_MAILER_USERNAME: Your-own-gmail-address
      VIKUNJA_MAILER_PASSWORD: Your-own-app-password
      VIKUNJA_MAILER_FROMEMAIL: Your-own-gmail-address
      VIKUNJA_DATABASE_HOST: vikunja-db
      VIKUNJA_DATABASE_PASSWORD: vikunjapass
      VIKUNJA_DATABASE_TYPE: postgres
      VIKUNJA_DATABASE_USER: vikunjauser
      VIKUNJA_DATABASE_DATABASE: vikunja
      VIKUNJA_SERVICE_JWTSECRET: MariushostingMariushostingMari13
      VIKUNJA_SERVICE_TIMEZONE: Europe/Bucharest
      VIKUNJA_SERVICE_FRONTENDURL: https://vikunja.yourname.synology.me/
      VIKUNJA_SERVICE_ENABLEREGISTRATION: true
    restart: on-failure:5
    depends_on:
      db:
        condition: service_healthy

  frontend:
    image: vikunja/frontend:latest
    container_name: Vikunja-FRONTEND
    hostname: vikunja-frontend
    mem_limit: 512m
    cpu_shares: 512
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: curl -f http://localhost:80/ || exit 1
    ports:
      - 4441:80
    environment:
      PUID: 1026
      PGID: 100
      VIKUNJA_API_URL: https://vikunjaapi.yourname.synology.me/api/v1
    restart: on-failure:5
    depends_on:
      api:
        condition: service_started

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 numbers for PUID and PGID with your own PUID and PGID 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 VIKUNJA_MAILER_USERNAME and type in your own Gmail address. Refer to STEP 16.
Note: Before you paste the code above in the Web editor area below, change the value for VIKUNJA_MAILER_PASSWORD and type in your own Gmail app password. Refer to STEP 16.
Note: Before you paste the code above in the Web editor area below, change the value for VIKUNJA_MAILER_FROMEMAIL and type in your own Gmail address. Refer to STEP 16.
Note: Before you paste the code above in the Web editor area below, change the value for VIKUNJA_SERVICE_JWTSECRET and add your own JWTSECRET password. MariushostingMariushostingMari13 is an example of a JWTSECRET password; you have to add your own JWTSECRET password.
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 VIKUNJA_SERVICE_FRONTENDURL and add your own synology.me DDNS address that you have previously created at STEP 12 with https:// at the beginning followed by the slash / at the end. Warning: Don’t forget the slash at the end.
Note: Before you paste the code above in the Web editor area below, change the value for VIKUNJA_API_URL and add your own synology.me DDNS address that you have previously created at STEP 8 with https:// at the beginning followed by /api/v1 at the end.

• STEP 19

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.

• STEP 20

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

• STEP 21

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

• STEP 22

Please wait approximately 2 minutes for the installation to be completed or you will get a Synology blank page if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://vikunja.yourname.synology.me In my case it’s https://vikunja.mariushosting.synology.me If everything goes right, you will see the Vikunja Login page. Click Create Account. Follow the instructions in the image below.

• STEP 23

Add your own Username, Email address and Password then hit the CREATE ACCOUNT button. Follow the instructions in the image below.

• STEP 24

Vikunja at a Glance!

• STEP 25

You can change different parameters. At the top right of the page click on your own username, then Settings. Change the Color Scheme, Language, Time Zone etc. Follow the instructions in the image below.

• STEP 26

One of the most important things you need to know about Vikunja is that anyone who can access your HTTPS Vikunja link at STEP 22 can register for a new account by default. Follow my step by step guide below to disable registration of new users in Vikunja.

• STEP 27

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

• STEP 28

Go to Portainer then click Stacks. Click on vikunja. Follow the instructions in the image below.

• STEP 29

Click on the Editor tab then scroll down the page a little bit. Change the value for VIKUNJA_SERVICE_ENABLEREGISTRATION from true to false then scroll down the page until you find the Update the stack button. Follow the instructions in the image below.

• STEP 30

Click Update the stack. Follow the instructions in the image below.

• STEP 31

After you click Update the stack at STEP 30, a new pop up window will open. Click Update. Follow the instructions in the image below.

• STEP 32

When new users try to register, they will receive the following error message: “Not Found“.

Note: Even if you have change the variable VIKUNJA_SERVICE_ENABLEREGISTRATION with the false value, the Create Account button will still be shown in the Vikunja Login page interface, but actually attempting to create an account will result in an error message.

🆘TROUBLESHOOTING

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

🔥Troubleshooting: If you experience connection issues with Vikunja, make sure RULE 5 and RULE 6 is correctly applied on your Synology NAS Firewall configuration.

Note: Find out how to update the Vikunja container with the latest image.
Note: Can I run Docker on my Synology NAS? See the supported models.
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 Sunday / September 17th, 2023 at 1:40 PM