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

Multi-arch manifests — resolve automatically to the right image for your platform.

Tag Description Best For
pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
latest / pkg-latest FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
pkg-amd64 FreeBSD Quarterly. Uses stable, tested packages. Production stability.
latest-amd64 / pkg-latest-amd64 FreeBSD Latest. Rolling package updates. Staying current.
Tag Description Best For
pkg-aarch64 FreeBSD Quarterly. Uses stable, tested packages. Production stability.
latest-aarch64 / pkg-latest-aarch64 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

Database Where the app keeps its data. The default needs nothing else running.

vikunja:latest — data in /containers/vikunja

A file in the app's config folder. Right for one person, nothing extra to run.

1. Save as .env and fill in what is empty:

1
2
3
PUID=1000
PGID=1000
TZ=UTC

2. Save as compose.yaml:

name: vikunja

services:
  vikunja:
    image: ghcr.io/daemonless/vikunja:latest
    container_name: vikunja
    # "always", not "unless-stopped": FreeBSD's podman rc.d only auto-starts
    # containers with restart-policy=always at boot (needs podman_enable=YES).
    restart: always
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      # Optional: the address Vikunja puts in the links it sends.
      - VIKUNJA_SERVICE_PUBLICURL=
      # The database, from the Database choice; sqlite needs nothing else.
      - VIKUNJA_DATABASE_TYPE=${VIKUNJA_DATABASE_TYPE:-sqlite}
      - VIKUNJA_DATABASE_HOST=${VIKUNJA_DATABASE_HOST:-}
      - VIKUNJA_DATABASE_USER=${VIKUNJA_DATABASE_USER:-}
      - VIKUNJA_DATABASE_PASSWORD=${VIKUNJA_DATABASE_PASSWORD:-}
      - VIKUNJA_DATABASE_DATABASE=${VIKUNJA_DATABASE_DATABASE:-}

    volumes:
      - "/containers/vikunja:/config"

    ports:
      - 3456:3456

Then run podman-compose up -d.

Database Where the app keeps its data. The default needs nothing else running.

vikunja:latest — data in /containers/vikunja

A file in the app's config folder. Right for one person, nothing extra to run.

# .env

DIRECTOR_PROJECT=vikunja
PUID=1000
PGID=1000
TZ=UTC
VIKUNJA_SERVICE_PUBLICURL=
VIKUNJA_DATABASE_TYPE=sqlite
VIKUNJA_DATABASE_HOST=
VIKUNJA_DATABASE_USER=
VIKUNJA_DATABASE_PASSWORD=<VIKUNJA_DATABASE_PASSWORD>
VIKUNJA_DATABASE_DATABASE=
# 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}'
        - VIKUNJA_DATABASE_TYPE: !ENV '${VIKUNJA_DATABASE_TYPE}'
        - VIKUNJA_DATABASE_HOST: !ENV '${VIKUNJA_DATABASE_HOST}'
        - VIKUNJA_DATABASE_USER: !ENV '${VIKUNJA_DATABASE_USER}'
        - VIKUNJA_DATABASE_PASSWORD: !ENV '${VIKUNJA_DATABASE_PASSWORD}'
        - VIKUNJA_DATABASE_DATABASE: !ENV '${VIKUNJA_DATABASE_DATABASE}'
    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.

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)
VIKUNJA_DATABASE_TYPE sqlite sqlite, postgres or mysql -- set by the Database choice
VIKUNJA_DATABASE_HOST `` Database host (the PostgreSQL and MariaDB choices fill this in)
VIKUNJA_DATABASE_USER `` Database user
VIKUNJA_DATABASE_PASSWORD <VIKUNJA_DATABASE_PASSWORD> Database password
VIKUNJA_DATABASE_DATABASE `` Database name

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, aarch64
  • 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.