Skip to content

QUICKSTART-MAINTAINER.adoc

Latest commit

 

History

History
129 lines (90 loc) · 2.31 KB

QUICKSTART-MAINTAINER.adoc

File metadata and controls

129 lines (90 loc) · 2.31 KB

k9-rs — Quick Start for Platform Maintainers

Table of Contents

Overview

This guide covers packaging, deploying, and maintaining k9-rs for distribution on your platform.

Runtime Dependencies

{{DEPS}}

Build from Source

git clone https://github.com/hyperpolymath/k9-rs.git
cd k9-rs
just build-release

Output: {{BUILD_OUTPUT_PATH}}

Packaging

Guix

guix build -f guix.scm

Nix

nix build

Container (Stapeln)

just stapeln-export    # Generates Containerfile
podman build -t k9-rs .

Manual Package

just install --prefix=/usr/local

Files installed:

Path Contents

$PREFIX/bin/

Executables

$PREFIX/share/{{PACKAGE_NAME}}/

Data files, assets

$PREFIX/share/doc/{{PACKAGE_NAME}}/

Documentation

$PREFIX/share/applications/

.desktop file (Linux, if GUI)

$PREFIX/share/man/man1/

Man pages

Configuration

Default config location: $XDG_CONFIG_HOME/{{PACKAGE_NAME}}/config.toml

Fallback: $HOME/.config/{{PACKAGE_NAME}}/config.toml

Health Checks

just doctor            # Full diagnostic
just run --version   # Version check
just run --selftest  # Built-in self-test

Updating

git pull
just build-release
just install --prefix=/usr/local

Or via OPSM: opsm update {{PACKAGE_NAME}}

Security Notes

  • License: PMPL-1.0-or-later (Palimpsest License)

  • All dependencies SHA-pinned

  • panic-attacker scan results: INSTALL-SECURITY-REPORT.adoc

  • OpenSSF Scorecard: see badge in README

Multi-Instance Deployment

For deploying multiple instances (e.g., different users or tenants):

just install --prefix=/opt/{{PACKAGE_NAME}}-instance1 --config=/etc/{{PACKAGE_NAME}}/instance1.toml
just install --prefix=/opt/{{PACKAGE_NAME}}-instance2 --config=/etc/{{PACKAGE_NAME}}/instance2.toml

Each instance has isolated config, data, and logs.

Reporting Issues