Self-host Vikunja on a VPS

An open-source task and project manager for teams that outgrew sticky notes.

levelrail-cli templates deploy vikunja --name my-vikunja

Specification

Status
Verified on arm64 with image tag 16-alpine
Category
Productivity
Services
db, vikunja
Ports
3456
Volumes
2
Memory
about 256 MiB
arm64
tested
amd64
image published
Settings to fill in
none

About Vikunja

An open-source task and project manager for teams that outgrew sticky notes. Runs 2 containers (db, vikunja), with vikunja listening on port 3456; data is kept in named volumes.

What it deploys

Vikunja runs as 2 services in a single Compose app, listening on port 3456, with 2 named volume mounts.

ServiceImageTagPortsVolumes
db postgres 16-alpine none vikunja_db_data -> /var/lib/postgresql/data
vikunja vikunja/vikunja 0.24.1 3456 vikunja_data -> /app/vikunja/files

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Verified. Verified on arm64 with image tag 16-alpine. Verified means our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 3456 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 3 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbPOSTGRES_DBPreset by the template
dbPOSTGRES_PASSWORDGenerated at deploy
dbPOSTGRES_USERPreset by the template
vikunjaVIKUNJA_DATABASE_DATABASEPreset by the template
vikunjaVIKUNJA_DATABASE_HOSTPreset by the template
vikunjaVIKUNJA_DATABASE_PASSWORDGenerated at deploy
vikunjaVIKUNJA_DATABASE_TYPEPreset by the template
vikunjaVIKUNJA_DATABASE_USERPreset by the template
vikunjaVIKUNJA_SERVICE_JWTSECRETGenerated at deploy
vikunjaVIKUNJA_SERVICE_PUBLICURLPreset by the template

Install Vikunja on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get vikunja
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy vikunja --name my-vikunja

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Vikunja.

More in Productivity

All Productivity templates