Skip to content

z3r0-g/LLaMarr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

🦙 LLaMarr

The LLM‑Powered Sidecar That Automates Your Homarr Integrations

“Prowlarr‑style automation for Homarr, built in Python.”


⭐ Introduction

LLaMarr is a Python‑powered automation engine that discovers your containers, understands them using your chosen LLM, and automatically generates Homarr integrations, categories, widgets, and tiles. It keeps your Homarr dashboard in sync with your actual homelab, without you lifting a finger.

Think of it as:

  • Prowlarr → Indexers
  • LLaMarr → Homarr Integrations

A single source of truth for your services.
A self‑maintaining dashboard.
A homelab that configures itself.


🧩 Core Principles

1. Python‑Native

Fast to iterate, easy to extend, and aligned with a philosophy of clarity and determinism.

2. Local‑First Intelligence

Local LLMs (Ollama and LM Studio) are first‑class.
Cloud LLMs (Gemini, Meta, and Copilot) are optional.

3. Zero‑Touch Discovery

LLaMarr automatically discovers:

  • Local Docker containers
  • Remote Docker hosts
  • Compose stacks

4. Declarative Homarr Automation

LLaMarr generates:

  • Tiles
  • Integrations
  • Categories
  • Widgets
  • Groups

Then applies them safely.

5. Homarr‑First, Always

LLaMarr does not replace Homarr.
It enhances Homarr.
It feeds Homarr.
It keeps Homarr alive as your stacks grow.


🧠 How LLaMarr Works

1. Discover

  • Docker Socker or API Connection
  • Compose Files

2. Ingest

  • Container labels
  • Compose labels
  • Repo README.md
  • Docs folder
  • Docker Hub / GHCR metadata

3. Interpret (LLM)

  • What the service is
  • What integrations it supports
  • What URLs matter
  • What category it belongs in
  • What icon fits
  • What widgets should be created

4. Generate

  • Homarr integrations
  • Homarr tiles
  • Homarr categories
  • Homarr widgets
  • Homarr groups

5. Apply

  • Writes Homarr config JSON
  • Restarts Homarr
  • Verifies the dashboard

🏗️ Roadmap (Phase‑Driven, Deckhand Style)

Phase 1 — Foundation (MVP)

“Make Homarr self‑aware.”

  • Python backend (FastAPI)
  • Local Docker socket discovery
  • Compose file ingestion
  • Basic metadata extraction
  • Local LLM support (Ollama)
  • Auto‑generate Homarr tiles
  • Auto‑generate Homarr categories
  • Safe Homarr restart
  • Minimal Web UI for “Scan → Apply”

Outcome:
Homarr becomes self‑populating for all containers on your system.


Phase 2 — Deep Understanding

“Teach LLaMarr to read.”

  • README.md ingestion
  • Docs folder ingestion
  • Docker Hub / GHCR metadata ingestion
  • AI‑powered service classification
  • AI‑powered icon selection
  • AI‑powered category selection
  • AI‑powered widget suggestions
  • Cloud LLM support (Gemini, Meta, Copilot)

Outcome:
LLaMarr understands what each service is and configures Homarr accordingly.


Phase 3 — Integration Engine

“Prowlarr for Homarr.”

  • Integration templates (Plex, Sonarr, Radarr, qBittorrent, etc.)
  • Auto‑generate Homarr integrations
  • Auto‑generate Homarr widgets
  • Auto‑generate health checks
  • Auto‑generate service URLs
  • Auto‑generate categories and groups

Outcome:
Homarr gains a full integration manager — powered by LLaMarr.


Phase 4 — Multi‑Host Intelligence

“Your entire homelab, unified.”

  • Remote Docker API support
  • Multi‑host scanning
  • Cross‑host category grouping
  • Cross‑host integration generation

Outcome:
LLaMarr becomes the single source of truth for your entire homelab.


Phase 5 — LLaMarr Health UI

LLaMarr’s dashboard is intentionally minimal, it does not replace Homarr, just provides a backend UI for powerusers.

  • Read Homarr’s existing integrations
  • Read Homarr’s existing tiles
  • Read Homarr’s existing categories
  • Read Homarr’s existing widgets
  • Display a clean, iFrame‑friendly summary page
  • Show which integrations were created by LLaMarr
  • Show which integrations were discovered but skipped
  • Show pending actions for new containers
  • Show a diff between Homarr and your containers

Strict boundaries:

  • No custom widgets
  • No custom tiles
  • No custom dashboards
  • No UI duplication
  • No feature overlap with Homarr

Outcome:
A simple, reliable, iframe‑friendly status page that reflects Homarr’s health — nothing more, nothing less.


🔧 Tech Stack

Language

  • Python 3.13+

Backend

  • Flask
  • Pydantic
  • Docker SDK for Python
  • Async multi‑host scanning

LLM Runtime

  • Local: Ollama, LM Studio
  • Cloud: Gemini, Meta, Copilot

Data Processing

  • PyYAML
  • Markdown parsing
  • JSON schema validation

Homarr Integration

  • Direct JSON config generation
  • Safe restart orchestration

📦 Installation (Placeholder)

docker run -d \
  --name llamarr \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /path/to/homarr/config:/config \
  -p 8000:8000 \
  z3r0g/llamarr:latest

🧭 Vision

LLaMarr is not a dashboard.
LLaMarr is not a monitoring suite.
LLaMarr is not a Homarr competitor.

LLaMarr is the automation layer that keeps Homarr alive, current, and self‑maintaining as your homelab grows. Because if you are like me, you are busy with life but need to keep your lab polished and at its best!

Your services evolve.
LLaMarr adapts.
Homarr reflects it.


📝 License

Apache 2.0

About

The LLM‑Powered Sidecar That Automates Your Docker-based Homarr Integrations “Prowlarr‑style automation for Homarr, built in Python.”

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors