kimbap

Install

kimbap runs on Linux, macOS, and Windows. How you get it running depends on the platform:

Installing on Linux

curl -fsSL https://kimbap.okonomi.cloud/install.sh | sudo bash

This downloads the latest verified kimbap binary for your OS/arch, checksums it, and installs it:

  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.

Starting kimbap

sudo kimbap start

kimbap starts right away — open http://<host>:8080/ to create the first admin account. Docker doesn't need to exist yet.

Want to reach kimbap at a real domain with HTTPS instead of an IP and port? See Domains & TLS for the two ways to do that: let kimbap handle it for you with one built-in command, or put your own reverse proxy or tunnel in front of it.

Manage the service afterward with:

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

See Configuration for every setting kimbap configure can touch.

Updating

sudo kimbap update            # check for + install a newer release, then restart if running
sudo kimbap update --check    # just report what's available, don't install it

Downloads the latest release, verifies its SHA-256 checksum, and atomically replaces the running binary. Refuses to run against a dev (unversioned, locally-built) binary, since there's no real version to compare against. Works the same way on macOS. On Windows, kimbap update isn't supported yet — download the latest release and replace kimbap.exe yourself.

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. This is a Linux command (it's undoing the systemd install above) — on macOS/Windows, just delete the kimbap binary and, if you want, its state directory.

macOS and Windows

There's no background-service install for these platforms yet — kimbap runs in the foreground, in a terminal you leave open (or under your own process manager/launchd/Task Scheduler entry, if you want it to survive a reboot). What you get once it's running is identical to Linux: the same web UI, REST API, and MCP server.

  1. Make sure Docker Desktop is installed and running — kimbap uses it to build and run the projects you deploy, and won't be able to do much without it.
  2. Download the latest binary for your platform — kimbap-darwin-arm64 (Apple Silicon), kimbap-darwin-amd64 (Intel Mac), or kimbap-windows-amd64.exe:
    curl -fLO https://kimbap.okonomi.cloud/latest/kimbap-darwin-arm64
    (Windows: download https://kimbap.okonomi.cloud/latest/kimbap-windows-amd64.exe in your browser, or the equivalent with curl/Invoke-WebRequest.)
  3. macOS only: mark it executable and let it out of quarantine, since it isn't (yet) notarized:
    chmod +x kimbap-darwin-arm64
xattr -d com.apple.quarantine kimbap-darwin-arm64   # if macOS blocks it on first run
  4. Run it:
    ./kimbap-darwin-arm64 run --state-dir ./kimbap-data
    (Windows: kimbap-windows-amd64.exe run --state-dir .\kimbap-data.)

--state-dir picks where kimbap keeps its database and config — pass whatever directory you want that to live in. Once it's running, open http://localhost:8080/ to create the first admin account. kimbap configure/start/stop/restart/status/install/uninstall aren't available here (they're systemd wrappers); everything else — projects, domains, Traefik, MCP — works the same as on Linux.

Requirements

Linux

macOS and Windows

← Overview Quick start →