Portainer Templates logo

Portainer Templates

Vikunja Vikunja

Stack

ToolsProductivity

The to-do app to organize your life.| Before use create custom template and Edit: VIKUNJASERVICEFRONTENDURL , VIKUNJAAPIURL & VIKUNJASERVICEJWTSECRET

Configuration

Type
Compose
Platform
linux
Env vars
PUID=1000PGID=1000PORT=''
Source
Repo

Template by xneo1·Source

Services

vikunjadb

Configuration

Image
mariadb:10
Command
--character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
Volumes
/var/lib/mysql : ./db
Env vars
MYSQL_ROOT_PASSWORD=supersecretMYSQL_USER=vikunjaMYSQL_PASSWORD=secretMYSQL_DATABASE=vikunja
Restart
unless-stopped

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 2 days ago
Status: active

api

Configuration

Image
vikunja/api
Ports
3456:3456
Volumes
/app/vikunja/files : ./files
Env vars
VIKUNJA_DATABASE_HOST=vikunjadbVIKUNJA_DATABASE_PASSWORD=secretVIKUNJA_DATABASE_TYPE=mysqlVIKUNJA_DATABASE_USER=vikunjaVIKUNJA_DATABASE_DATABASE=vikunjaVIKUNJA_SERVICE_JWTSECRET=lgdfjgdlamsvcnlsVIKUNJA_SERVICE_FRONTENDURL=http://10.11.11.128:1180/api/v1/
Restart
unless-stopped

Image details

Pulls: 8.3M
User: vikunja
Created: Sep 08, 2018
Updated: 2 years ago
Status: active

frontend

Configuration

Image
vikunja/frontend
Ports
1180:80
Env vars
VIKUNJA_API_URL=http://10.11.11.128:3456/api/v1
Restart
unless-stopped

Image details

Pulls: 8.2M
User: vikunja
Created: Sep 08, 2018
Updated: 2 years ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Vikunja

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Vikunja, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  vikunjadb:
    image: mariadb:10
    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    environment:
      MYSQL_ROOT_PASSWORD: supersecret
      MYSQL_USER: vikunja
      MYSQL_PASSWORD: secret
      MYSQL_DATABASE: vikunja
    volumes:
      - ./db:/var/lib/mysql
    restart: unless-stopped
  api:
    image: vikunja/api
    environment:
      VIKUNJA_DATABASE_HOST: vikunjadb
      VIKUNJA_DATABASE_PASSWORD: secret
      VIKUNJA_DATABASE_TYPE: mysql
      VIKUNJA_DATABASE_USER: vikunja
      VIKUNJA_DATABASE_DATABASE: vikunja
      VIKUNJA_SERVICE_JWTSECRET: lgdfjgdlamsvcnls
      VIKUNJA_SERVICE_FRONTENDURL: http://10.11.11.128:1180/api/v1/
    ports:
      - 3456:3456
    volumes:
      - ./files:/app/vikunja/files
    depends_on:
      - vikunjadb
    restart: unless-stopped
  frontend:
    image: vikunja/frontend
    ports:
      - 1180:80
    environment:
      VIKUNJA_API_URL: http://10.11.11.128:3456/api/v1
    restart: unless-stopped

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/vikunja.yml up -d

More install options in our documentation.

Container Documentation

vikunjadb Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

api Documentation

DEPRECATED, PLEASE USE vikunja/vikunja

frontend Documentation

DEPRECATED; PLEASE USE vikunja/vikunja

Serve Vikunja on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying vikunja.example.com to http://frontend:80

Add this to your Caddyfile

vikunja.example.com {
	reverse_proxy http://frontend:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3456 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3456
  • Stop the other service, or pick a different host port. In 3456:3456 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:1180. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Vikunja can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 1180

Image won't pull

Test the pull directly on the host: docker pull mariadb:10

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.
  • Relative volume paths like ./db often fail in Portainer because there's no working directory. Swap them for absolute paths.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Vikunja is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • vikunjadb runs mariadb:10
  • api runs vikunja/api, starts after vikunjadb
  • frontend runs vikunja/frontend

Ports

A port is the door the app answers on. A mapping like 3456:3456 means it's reachable on port 3456 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:1180 in a browser. It opens:

  • 3456:3456
  • 1180:80, likely the web interface

Volumes

A volume is where Vikunja keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/mysql from ./db on the host
  • /app/vikunja/files from ./files on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Vikunja takes 12 of them, all with defaults you can leave alone or tweak:

  • MYSQL_ROOT_PASSWORD, defaults to supersecret
  • MYSQL_USER, defaults to vikunja
  • MYSQL_PASSWORD, defaults to secret
  • MYSQL_DATABASE, defaults to vikunja
  • VIKUNJA_DATABASE_HOST, defaults to vikunjadb
  • VIKUNJA_DATABASE_PASSWORD, defaults to secret
  • VIKUNJA_DATABASE_TYPE, defaults to mysql
  • VIKUNJA_DATABASE_USER, defaults to vikunja
  • VIKUNJA_DATABASE_DATABASE, defaults to vikunja
  • VIKUNJA_SERVICE_JWTSECRET, defaults to lgdfjgdlamsvcnls
  • VIKUNJA_SERVICE_FRONTENDURL, defaults to http://10.11.11.128:1180/api/v1/
  • VIKUNJA_API_URL, defaults to http://10.11.11.128:3456/api/v1

Restart policy

The restart policy here is unless-stopped, so Docker restarts Vikunja after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like vikunjadb) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Vikunja up. Add the template list to Portainer once, then deploying Vikunja is a click rather than a wall of config.