Nomploy Nomad Packs

← All packs

vikunja v0.1.0

Apps

Vikunja — an open-source, self-hosted to-do and project management app (lists, kanban, gantt, reminders). Deployed as a single host-networked Nomad service using the bundled SQLite database, with a persistent volume for data and file uploads.

nomad-pack run vikunja --registry nomploy
2 tasks http 3456 1 volume image vikunja/vikunja:latest
Variables 10
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run vikunja -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "vikunja"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Vikunja (unified frontend+API) container image. Pin a tag in production.
image = "vikunja/vikunja:latest"

# Host port for Vikunja (web UI + API).
port = 3456

# Public URL Vikunja is served at, e.g. https://tasks.example.com/ (trailing slash). Needed so the frontend can reach the API when behind a domain/proxy. Empty = same-origin (works for direct http://<node-ip>:<port> access).
public_url = ""

# Secret used to sign JWT sessions. Set a random string and keep it stable (changing it logs everyone out). Empty = Vikunja generates a new one each start.
service_secret = ""

# Docker named volume for /db (SQLite database + file uploads under /db/files). A prestart task chowns it to uid 1000 (Vikunja's user) so it can write. Back it up.
data_volume = "vikunja_data"

# Placement constraints — pin to one node so the local volume stays put. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }
NameTypeDefaultDescription
job_name string
"vikunja"
The name of the Nomad job.
namespace string
"default"
The Nomad namespace to deploy into.
datacenters list
["*"]
The datacenters to deploy to.
image string
"vikunja/vikunja:latest"
The Vikunja (unified frontend+API) container image. Pin a tag in production.
port number
3456
Host port for Vikunja (web UI + API).
public_url string
""
Public URL Vikunja is served at, e.g. https://tasks.example.com/ (trailing slash). Needed so the frontend can reach the API when behind a domain/proxy. Empty = same-origin (works for direct http://<node-ip>:<port> access).
service_secret key string
""
Secret used to sign JWT sessions. Set a random string and keep it stable (changing it logs everyone out). Empty = Vikunja generates a new one each start.
data_volume string
"vikunja_data"
Docker named volume for /db (SQLite database + file uploads under /db/files). A prestart task chowns it to uid 1000 (Vikunja's user) so it can write. Back it up.
constraints list
[]
Placement constraints — pin to one node so the local volume stays put. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object
{
    cpu    = 300
    memory = 256
  }
The task resources.
Readme

vikunja

Vikunja — an open-source, self-hosted to-do and project management app: lists, kanban, table and gantt views, reminders, labels, and sharing. Deployed as a single host-networked Nomad service using the bundled SQLite database (no external dependency).

Usage

nomad-pack registry add nomploy github.com/Nomploy/nomad-packs
nomad-pack run vikunja --registry nomploy

In nomploy: create a Compose service, type Nomad Pack, pack vikunja, custom registry github.com/Nomploy/nomad-packs, then Deploy.

Open http://<node-ip>:3456 and register the first account.

Key variables

Variable Default Notes
image vikunja/vikunja:latest Pin a tag in production.
port 3456 Web UI + API.
public_url "" Set (with trailing slash) when behind a domain/proxy so the frontend can reach the API.
service_secret "" JWT signing secret; set a stable value or sessions reset on restart.
data_volume vikunja_data SQLite DB + uploads. Back it up.
constraints [] Pin to a node so the local volume stays put.
resources cpu 300 / mem 256 Lightweight.

Notes