Skip to content

Vikunja Vikunja

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Vikunja Host Port
Vikunja /config Path

Build Status Last Commit OCI Pulls

Vikunja is an open-source, self-hostable to-do app. It helps you organize your tasks and projects with features like list, kanban, gantt, and table views - all while keeping your data under your control.

Port 3456
Registry ghcr.io/daemonless/vikunja
Daemonless daemonless/vikunja
Source vikunja.io
Website vikunja.io

Version Tags

Tag Description Best For
pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

services:
  vikunja:
    image: "ghcr.io/daemonless/vikunja:latest"
    container_name: vikunja
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - VIKUNJA_SERVICE_PUBLICURL=  # Address you open Vikunja at, e.g. http://192.168.1.10:3456/ (used in links and emails it sends)
    volumes:
      - "/containers/vikunja:/config"
    ports:
      - "3456:3456"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

1
2
3
4
5
6
7
8
podman run -d --name vikunja \
  -p 3456:3456 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e VIKUNJA_SERVICE_PUBLICURL= \
  -v /containers/vikunja:/config \
  ghcr.io/daemonless/vikunja:latest

Save as run.sh, then run sh run.sh.

- name: Deploy vikunja
  containers.podman.podman_container:
    name: vikunja
    image: "ghcr.io/daemonless/vikunja:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      VIKUNJA_SERVICE_PUBLICURL: ""
    ports:
      - "3456:3456"
    volumes:
      - "/containers/vikunja:/config"

Save as vikunja-deploy.yaml, then run ansible-playbook vikunja-deploy.yaml.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
7
# .env

DIRECTOR_PROJECT=vikunja
PUID=1000
PGID=1000
TZ=UTC
VIKUNJA_SERVICE_PUBLICURL=
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  vikunja:
    name: vikunja
    options:
      - container: 'args:--pull'
      - expose: '3456:3456 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - VIKUNJA_SERVICE_PUBLICURL: !ENV '${VIKUNJA_SERVICE_PUBLICURL}'
    volumes:
      - VIKUNJA_CONFIG_PATH: /config
volumes:
  VIKUNJA_CONFIG_PATH:
    device: '/containers/vikunja'
1
2
3
4
5
6
7
# Makejail

ARG tag=pkg

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/vikunja:${tag}

Save the files above, then run appjail-director up.

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="3456:3456 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e VIKUNJA_SERVICE_PUBLICURL= \
  -o fstab="/containers/vikunja /config <pseudofs>" \
  ghcr.io/daemonless/vikunja:latest vikunja

Save the files above, then run sh run.sh.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  vikunja:
    name: vikunja
    image: "ghcr.io/daemonless/vikunja:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - VIKUNJA_SERVICE_PUBLICURL=
    volumes:
      - "/containers/vikunja:/config"

Save as bastille-compose.yml, then run bastille up.

1
2
3
4
5
6
7
bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --env VIKUNJA_SERVICE_PUBLICURL= \
  --volume /containers/vikunja /config \
  vikunja ghcr.io/daemonless/vikunja:latest inherit

Access at: http://localhost:3456

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
VIKUNJA_SERVICE_PUBLICURL `` Address you open Vikunja at, e.g. http://192.168.1.10:3456/ (used in links and emails it sends)

Volumes

Path Description
/config Database (vikunja.db), uploaded files and the login secret

Ports

Port Protocol Description
3456 TCP Web UI

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.