@yunus/kayra (0.3.0)

Published 2026-10-12 20:22:47 +00:00 by yunus

Installation

@yunus:registry=
npm config set @yunus:registry=
npm install @yunus/kayra@0.3.0
"@yunus/kayra": "0.3.0"

About this package

kayra

A self-hosted app platform and the CLI that runs it. Traefik, Authelia, Jenkins, a registry and rootless BuildKit on each server, set up with OpenTofu and Ansible; apps live in their own repositories and are built and deployed from there — a push to an app's branch is a deploy.

kayra is the engine. A fleet is its configuration: a repository holding servers/, one folder per server (server.yml, vars.yml, secrets.yml, apps/, terraform/ or a hand-written inventory). kayra knows no fleet and no app by name.

Where What
CLAUDE.md how everything fits together, and the rules that keep it working — read first
docs/app-contract.md what an app provides and what it may not do
docs/authentication.md staff login (Authelia), adding people, recovery
docs/ci-isolation.md why app code cannot reach the host or the platform

Prerequisites

Node 24, yq, jq, OpenTofu, Ansible, and for local test servers Multipass and mkcert (brew install yq jq opentofu ansible mkcert nss && mkcert -install). Git credentials that can read the apps' repositories (gh auth login && gh auth setup-git). A fleet pins kayra in its package.json (@yunus/kayra, from https://git.yunusozturk.de/api/packages/yunus/npm/); any kayra on PATH runs the version the fleet pins. Once per machine, from a checkout: npm ci && npm link, then kayra doctor in a fleet to see what is still missing.

Use

From anywhere in a fleet:

kayra status              # every server + status
kayra up shop-test        # provision + set up everything
kayra deploy shop-prod    # host setup + apps, no re-provision (from main only)
kayra ssh shop-prod
kayra down shop-test

Layout

.
├── ansible/          # playbooks per server kind, roles
├── compose/          # the platform's compose stack (Traefik, Authelia, Jenkins, registry, BuildKit)
├── terraform/        # OpenTofu modules (hcloud, multipass)
├── ci/               # pipeline library, platform jobs, compose policy, checks
├── cli/              # kayra, the CLI
├── scripts/          # local/ (the operator's machine) and server/ (/opt/platform/bin)
└── docs/

License

MIT © Yunus Öztürk

Dependencies

Dependencies

ID Version
@optique/core 1.3.3
@optique/run 1.3.3
yaml 2.9.1

Development dependencies

ID Version
@eslint/js 10.0.1
@tsconfig/node24 24.0.5
@tsconfig/strictest 2.0.8
@types/node 24.19.1
eslint 10.12.0
eslint-plugin-functional 10.0.1
typescript 6.0.3
typescript-eslint 8.71.1
Details
npm
2026-10-12 20:22:47 +00:00
12
2026-11-01 11:16:04 +00:00
Yunus Öztürk
MIT
latest
59 KiB
Assets (1)
Versions (2) View all
0.3.0 2026-10-12
0.2.0 2026-10-12