dschlueter b8680cc049 docs: move BEDIENUNGSANLEITUNG and INSTALL_FROM_ARCHIVE into docs/

Keep only README, LICENSE, and CHANGELOG as prose at the repo root
(tooling/convention) and move the remaining manuals under docs/ next to
SECURITY_AND_OPERATIONS.md.

- git mv the two files into docs/ (history preserved).
- Update all cross-references: README doc-index links, the internal
  SECURITY_AND_OPERATIONS link and the §12 pointer list in
  BEDIENUNGSANLEITUNG, and the repo inventory in SECURITY_AND_OPERATIONS §1.
- build_archive.py: point REQUIRED_FILES at docs/ and drop the now-redundant
  INCLUDE_FILES entries (the docs/ dir is included wholesale).
- build_archive.py: drop the obsolete requirements.txt<->pyproject dependency
  mirror check, which broke once requirements.txt was reduced to `.`
  (pyproject is the single source of truth). Verified by building and
  re-opening the archive.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-07-07 11:17:41 +02:00

3.3 KiB

Raw Blame History

Installation aus dem Archiv — llamacppctl

Diese Anleitung beschreibt, wie du llamacppctl aus dem fertigen Archiv llamacppctl-installable.tar.gz installierst. Für die vollständige Bedienung siehe BEDIENUNGSANLEITUNG.md.

1. Voraussetzungen auf der Zielmaschine

Python ≥ 3.10 (python3 --version)
Docker mit erreichbarem Daemon (docker version)
NVIDIA-GPU + Treiber + NVIDIA Container Toolkit (für --gpus)
Ein GGUF-Modell auf dem Host

Für einen reinen Konfigurations-/Trockenlauf (--print-effective-config, --dry-run) reicht Python; Docker/GPU/Modell werden erst für echte --start/--check/--chat-Aufrufe gebraucht.

2. Integrität prüfen (optional, empfohlen)

gzip -t llamacppctl-installable.tar.gz && echo "Archiv OK"
tar tzf llamacppctl-installable.tar.gz | head        # Inhalt ansehen

Das Archiv enthält ausschließlich Quellcode, Tests, Doku, Manpage, llama.cpp.config.example und scripts/smoke.sh — keine persönliche llama.cpp.config, keine .venv, keine .git-Historie und keine Geheimnisse.

3. Entpacken und installieren

tar xzf llamacppctl-installable.tar.gz
cd llamacppctl

python3 -m venv .venv
source .venv/bin/activate
pip install .

Danach steht das Konsolen-Kommando llamacppctl zur Verfügung:

llamacppctl --help

Zum Entwickeln stattdessen pip install -e ".[dev]" (editable + Tests).

4. Konfiguration anlegen

cp llama.cpp.config.example llama.cpp.config
# llama.cpp.config an den Host anpassen: hf_home (z. B. ${HF_HOME}),
# model_path, gpu_device, host_port, container_name …

Auflösung prüfen, ohne etwas zu starten:

llamacppctl --print-effective-config --config llama.cpp.config --start --dry-run

Das zeigt die vollständig aufgelöste Konfiguration als JSON und das docker run-Kommando, das --start ausführen würde.

5. Erststart

llamacppctl --start --config llama.cpp.config
llamacppctl --check --config llama.cpp.config
llamacppctl --chat  --config llama.cpp.config -p "Sag kurz Hallo."

Weitere Aktionen, Optionen und Fehlersuche: BEDIENUNGSANLEITUNG.md.

6. Tests (optional)

pip install -e ".[dev]"
python -m pytest -q

7. Archiv selbst neu bauen / verifizieren

Das Archiv wird reproduzierbar von build_archive.py erzeugt. Es

prüft, ob alle erforderlichen Projektdateien vorhanden sind,
gleicht die deklarierten Abhängigkeiten in einer frischen venv ab,
lässt die komplette Test-Suite laufen,
baut das .tar.gz (nur Allowlist: src/ tests/ docs/ man/ scripts/ + pyproject.toml, README.md, LICENSE, CHANGELOG.md, requirements*.txt, llama.cpp.config.example, build_archive.py),
öffnet das Archiv erneut und verifiziert die enthaltenen Dateien,
installiert das Paket aus dem Archiv in einer weiteren frischen venv und testet das Konsolenskript.

python3 build_archive.py                       # -> ../llamacppctl-installable.tar.gz
python3 build_archive.py --output /pfad/x.tar.gz
python3 build_archive.py --skip-pip-check --skip-smoke-test   # ohne Netz-Schritte

Weil build_archive.py selbst im Archiv liegt, lässt sich das Archiv jederzeit unabhängig neu bauen und verifizieren.

3.3 KiB Raw Blame History