Self-host Kimai on a VPS

A self-hosted time tracking tool for freelancers and teams, with invoicing and reporting.

levelrail-cli templates deploy kimai --name my-kimai

Specification

Status
Listed
Category
Productivity
Services
db, kimai
Ports
8001
Volumes
2
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About Kimai

A self-hosted time tracking tool for freelancers and teams, with invoicing and reporting. Runs 2 containers (db, kimai), with kimai listening on port 8001; data is kept in named volumes.

What it deploys

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

ServiceImageTagPortsVolumes
db mysql 8 none kimai_db_data -> /var/lib/mysql
kimai kimai/kimai2 apache 8001 kimai_data -> /opt/kimai/var

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.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 8001 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. 4 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbMYSQL_DATABASEPreset by the template
dbMYSQL_PASSWORDGenerated at deploy
dbMYSQL_ROOT_PASSWORDGenerated at deploy
dbMYSQL_USERPreset by the template
kimaiADMINMAILPreset by the template
kimaiADMINPASSGenerated at deploy
kimaiDATABASE_URLGenerated at deploy

Install Kimai 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 kimai
  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 kimai --name my-kimai

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

More in Productivity

All Productivity templates