kimbap

Install

kimbap targets a fresh (or existing) Linux host with systemd. It installs itself as a native systemd service — it is not distributed as a Docker image, since it needs to be able to install Docker itself (see Overview for why).

One-line install

curl -fsSL https://kimbap.<your-domain>/install.sh | sudo bash

This downloads the latest verified kimbap binary for your OS/arch, checksums it, and hands off to the binary's own installer (kimbap exec-install), which:

  1. Places the binary on PATH (/usr/local/bin/kimbap by default).
  2. Creates a system user (kimbap) and state directory (/var/lib/kimbap).
  3. Writes an environment file (/etc/kimbap.env) with every setting at its effective default — edit it later with kimbap configure.
  4. Writes and enables a hardened systemd unit — but leaves the service stopped. Starting it is an explicit next step.

Re-running the installer (e.g. via a newer install.sh) upgrades the binary in place, backfills any newly-added settings into the env file, and restarts the service only if it was already running.

Manual install

If you'd rather not pipe a script into sudo bash, download a binary directly from the GitLab release matching your architecture, verify its checksum against the published SHA256SUMS, then run:

chmod +x kimbap
sudo ./kimbap install

kimbap install accepts the same flags as install.sh passes through — --bin, --state-dir, --user, --unit-dir, --env-file, --admin-domain, --acme-email, --acme-staging. Run kimbap install --help-equivalent (kimbap help) to see the full flag list and its defaults.

Starting it

sudo kimbap start

kimbap serves its UI/API on KIMBAP_ADDR (default :8080) as soon as it starts — Docker and Traefik don't need to exist yet. Open http://<host>:8080/ (or the admin domain, once Traefik is provisioned — see Domains & TLS) to create the first admin account, then follow the in-app setup wizard to install Docker and provision Traefik.

Manage the service afterward with:

sudo kimbap stop | restart | status
sudo kimbap configure          # edit /etc/kimbap.env, then apply

Uninstalling

sudo kimbap uninstall            # stops + removes the service; keeps state + binary
sudo kimbap uninstall --purge    # also removes the state dir, system user, and binary

Uninstalling never touches Docker, Traefik, or any deployed projects — remove those separately (docker compose down in each project's directory, docker system prune, etc.) if you want a fully clean host.

Requirements

← Overview Quick start →