README
¶
komizo
CLI for preparing and operating your own Compose hosts over SSH. No hosted account is required. Run it only against hosts you own or administer.
Install and use
Use a verified release archive or the Go toolchain matching go.mod and .mise.toml.
go run github.com/nicodes/komizo@v0.0.80 init --host root@your-server
init prepares the host and requires privileged access. Review its changes before using it on an existing host. komizo list, komizo report and komizo logs inspect applications; see command help for current flags. The local UI is available through the CLI’s ui command.
The supported deployment operation is app-scoped Compose deployment. Historical journaled rollout releases v0.0.30–v0.0.39 are superseded by v0.0.40 and later. Deployment actions are in komizo-actions. Verify release checksums and attestations before running a downloaded binary.
Release archive without Go
Example for Linux x86_64, using the reviewed release v0.0.80:
gh release download v0.0.80 --repo nicodes/komizo \
-p 'komizo_Linux_x86_64.tar.gz' -p checksums.txt
sha256sum -c checksums.txt --ignore-missing
gh attestation verify komizo_Linux_x86_64.tar.gz --repo nicodes/komizo
tar xzf komizo_Linux_x86_64.tar.gz
./komizo --help
Select the matching Darwin/Linux and arm64/x86_64 archive for another platform. Verify it before provisioning a host.
Protected operator lifecycle
Komizo owns the privileged operator and broker; the agent configuration repository owns agent behavior. On the Linux systemd machine that runs the operator, use a verified release to inspect and apply a concrete installation plan:
sudo ./komizo operator plan
sudo ./komizo operator apply --expected-plan <plan-sha256>
sudo ./komizo operator status
sudo ./komizo operator recover
The existing fleet-editor group, protected /etc/fleet-operator.json policy and /etc/fleet-operator-broker environment file define the caller's scope. The lifecycle refuses missing or changed authority, journals prior code before replacing it and retains consumed grants across upgrades. recover restores a prepared installation after interruption; it does not replay operations. The systemd activation socket remains owned by the service manager across broker process restarts.
The application host remains one box. App-scoped deployment, workload budgets, ingress and release admission are enforced by the host executor. Explicit static profiles and delivery-authorization requirements require an operator-reviewed migration; upgrading a binary alone does not enable them.
Documentation
¶
Overview ¶
Command komizo sets up and inspects servers that deploy from GitHub Actions.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package box is what runs ON a server: the probes that describe a machine, and the report they produce.
|
Package box is what runs ON a server: the probes that describe a machine, and the report they produce. |
|
cmd
|
|
|
komizo-box
command
Command komizo-box is what komizo installs on a server.
|
Command komizo-box is what komizo installs on a server. |
|
internal
|
|
|
agent
Package agent carries the compiled komizo-box binaries, so that installing one is something `komizo init` can do over a plain SSH connection.
|
Package agent carries the compiled komizo-box binaries, so that installing one is something `komizo init` can do over a plain SSH connection. |
|
app
Package app is komizo: the commands, and everything they do to a server.
|
Package app is komizo: the commands, and everything they do to a server. |
|
operator
Package operator distributes the privileged merge operator from one owner.
|
Package operator distributes the privileged merge operator from one owner. |
|
servicehealth
Package servicehealth shares required-service semantics between activation readiness and ongoing observation.
|
Package servicehealth shares required-service semantics between activation readiness and ongoing observation. |
|
ui
Package ui carries the local web app into the binary.
|
Package ui carries the local web app into the binary. |
|
workload
Package workload restricts repository-supplied Compose to an app's host-owned authority.
|
Package workload restricts repository-supplied Compose to an app's host-owned authority. |