LiteRegistry Docs

Usage-focused guides for running and operating LiteRegistry. Start with the main README for a full end-to-end workflow, then use these pages for argument details and behavior.

Guide	What it covers
CLI	Full literegistry subcommand reference and Fire usage
Registry	Redis vs filesystem backends, how entries are stored, inspecting the roster
Gateway	OpenAI-compatible proxy, CLI args, endpoints, retries
Package layout	Core modules, runnable services, gateway routes, and compatibility aliases
vLLM & SGLang	Launching model servers, registry registration, passthrough flags
Code & Terminal	Python executor and restricted log pipelines
Podman	Rootless stateful containers, handshake affinity, commands, and cleanup
Docker mirror	Docker Hub pull-through cache, warming, discovery, and gateway use
Load balancing	Exp3 bandit routing, failover, latency feedback
Runtimes	local vs apptainer, binds, env, image pull
Console	Streamlit dashboard for gateway / vLLM / registry

Optional companions: The core package does not require the separately versioned Podman client or Beaker launchers. Add only the extension you need: literegistry[podman_client] for the async PodmanClient, literegistry[podman_beaker] for a Podman/mirror Beaker stack, or literegistry[base_deployment] for the broader tools and model-serving stack. literegistry[all] installs all three. See their repository guides: Podman client, Podman Beaker, and base deployment.

Typical flow

literegistry redis          →  registry backend
literegistry vllm / sglang  →  model workers (heartbeat into registry)
literegistry code / terminal→  stateless tool workers (optional)
literegistry bm25          →  local Lucene search workers (optional)
literegistry podman         →  stateful rootless container workers (optional)
literegistry docker-mirror  →  stateless Docker Hub pull-through cache (optional)
literegistry gateway        →  single HTTP front door + strict affinity
literegistry console        →  live ops view (optional)

All CLI commands go through literegistry <subcommand> (Fire). Registry URLs are either redis://host:port or a filesystem path.

This site is built with MkDocs and published via GitHub Pages from master.