mirror of
https://github.com/mudler/LocalAI.git
synced 2026-06-14 19:58:44 -04:00
7e59a5c7c5
* docs: add 'how LocalAI works' architecture diagram Add a blueprint-style architecture diagram: clients -> small core (API, router, WebUI, agents) -> gRPC -> backend processes pulled on demand as OCI images. Place it on the overview page and replace the stale external architecture image on the reference page. Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add blueprint diagrams across feature, distributed & getting-started docs Add 24 architecture/flow/comparison diagrams (PNG + HTML source) under docs/static/images/diagrams/, wired into their docs pages, from an impact-vs-effort audit of the docs. Broaden the API surface on the overview architecture diagram (OpenAI, Anthropic, ElevenLabs, Ollama, and LocalAI's own API) and move the gRPC boundary label clear of the arrows. Pages: distributed mode (architecture, scheduling, ds4 layer-split), distributed inferencing, MLX, realtime, quantization, MCP, agents, mitm & cloud proxy, middleware, reverse-proxy TLS, VRAM, voice & face recognition, reranker, function calling, fine-tuning (recipe + jobs), diarization, audio transform, quickstart, model resolution. Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: add composable-core diagram to README hero Commit the composable-core card (small core + on-demand backend tiles) alongside the other diagrams and reference it from the README hero via a repo-relative path, so it renders on GitHub. Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: fix composable-core connectors/badge and federated-vs-worker layout - composable-core: thicken the plug-in connectors so they read clearly, and widen the SEPARATE IMAGE badge so its text no longer overflows the box. - federated-vs-worker: shorten the WHOLE/SPLIT REQUEST pills to fit, and replace the tangled node-to-node activation arrows with a clean fan-out (request split across all sharded nodes), mirroring the federated panel. Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
160 lines
8.2 KiB
HTML
160 lines
8.2 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link href="https://fonts.googleapis.com/css2?family=Bricolage+Grotesque:opsz,wght@12..96,600;12..96,700;12..96,800&family=Archivo:wght@500;600;700&display=swap" rel="stylesheet">
|
|
<style>
|
|
:root{
|
|
--paper:#F3E8D2; --paper2:#ECDFC2; --ink:#211C14; --ink-soft:#5A5142;
|
|
--rust:#B43A2C; --rust-deep:#8F2C20; --cold:#3F6E73; --hi:#E7D6AE; --dim:#A99F88;
|
|
}
|
|
*{box-sizing:border-box;margin:0;padding:0}
|
|
html,body{width:1600px;height:900px}
|
|
body{
|
|
background:var(--paper);color:var(--ink);font-family:"Archivo",sans-serif;
|
|
position:relative;overflow:hidden;
|
|
background-image:
|
|
linear-gradient(var(--paper2) 1px,transparent 1px),
|
|
linear-gradient(90deg,var(--paper2) 1px,transparent 1px);
|
|
background-size:40px 40px;
|
|
}
|
|
.frame{position:absolute;inset:26px;border:3px solid var(--ink);}
|
|
.wrap{position:absolute;inset:26px;padding:30px 56px 26px;display:flex;flex-direction:column}
|
|
header{display:flex;align-items:flex-end;justify-content:space-between;gap:30px}
|
|
.eyebrow{font-weight:700;letter-spacing:.22em;text-transform:uppercase;font-size:17px;color:var(--rust-deep)}
|
|
.eyebrow b{color:var(--ink)}
|
|
h1{font-family:"Bricolage Grotesque",sans-serif;font-weight:800;font-size:50px;line-height:.98;letter-spacing:-.015em;margin-top:6px}
|
|
h1 em{font-style:normal;color:var(--rust)}
|
|
.stamp{border:3px solid var(--ink);padding:10px 16px 8px;transform:rotate(3deg);text-align:center;background:var(--paper);box-shadow:6px 6px 0 var(--ink);flex:none}
|
|
.stamp .k{font-family:"Bricolage Grotesque";font-weight:800;font-size:21px;letter-spacing:.04em;line-height:1.05}
|
|
.stamp .s{font-weight:700;font-size:11px;letter-spacing:.18em;text-transform:uppercase;color:var(--ink-soft);margin-top:5px}
|
|
.stage{flex:1;margin-top:8px}
|
|
svg{width:100%;height:100%;overflow:visible}
|
|
footer{display:flex;align-items:center;justify-content:space-between;margin-top:6px;gap:24px}
|
|
.note{font-weight:600;font-size:18px;color:var(--ink-soft);line-height:1.3;max-width:1080px}
|
|
.note b{color:var(--ink)}
|
|
.url{font-family:"Bricolage Grotesque";font-weight:800;font-size:22px;color:var(--rust-deep);letter-spacing:.01em;flex:none}
|
|
.url span{color:var(--ink)}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="frame"></div>
|
|
<div class="wrap">
|
|
<header>
|
|
<div>
|
|
<div class="eyebrow">LocalAI <b>·</b> Middleware</div>
|
|
<h1>The request <em>lifecycle</em></h1>
|
|
</div>
|
|
<div class="stamp">
|
|
<div class="k">HOOK</div>
|
|
<div class="s">chain</div>
|
|
</div>
|
|
</header>
|
|
<div class="stage"><svg viewBox="0 0 1480 560" id="svg"></svg></div>
|
|
<footer>
|
|
<div class="note">One shared hook chain: <b>auth, model routing, and PII</b>, with decision and event logs.</div>
|
|
<div class="url">localai.io<span>/features/middleware</span></div>
|
|
</footer>
|
|
</div>
|
|
<script>
|
|
const INK="#211C14", PAPER="#F3E8D2", PAPER2="#ECDFC2", HI="#E7D6AE", SOFT="#5A5142", RUST="#B43A2C", RUSTD="#8F2C20", COLD="#3F6E73", DIM="#A99F88";
|
|
function el(t,a,x){const e=document.createElementNS("http://www.w3.org/2000/svg",t);for(const k in a)e.setAttribute(k,a[k]);if(x!=null)e.textContent=x;return e;}
|
|
const svg=document.getElementById("svg");
|
|
function shadowRect(x,y,w,h,fill,stroke,sw,dash){
|
|
svg.appendChild(el("rect",{x:x+7,y:y+7,width:w,height:h,fill:INK}));
|
|
svg.appendChild(el("rect",{x,y,width:w,height:h,fill,stroke:stroke||INK,"stroke-width":sw||3.5,"stroke-dasharray":dash||"none"}));
|
|
}
|
|
function txt(x,y,s,o){o=o||{};svg.appendChild(el("text",{x,y,"font-family":o.f||"Archivo","font-weight":o.w||700,"font-size":o.sz||15,"letter-spacing":o.ls||"0","text-anchor":o.a||"start",fill:o.fill||INK},s));}
|
|
function arrow(x1,y1,x2,y2,color,dash){
|
|
const mx=(x1+x2)/2;
|
|
svg.appendChild(el("path",{d:`M ${x1} ${y1} C ${mx} ${y1}, ${mx} ${y2}, ${x2-11} ${y2}`,fill:"none",stroke:color,"stroke-width":3.5,"stroke-linecap":"round","stroke-dasharray":dash||"none"}));
|
|
const a=7;
|
|
svg.appendChild(el("path",{d:`M ${x2-11} ${y2} l -${a+4} -${a} M ${x2-11} ${y2} l -${a+4} ${a}`,fill:"none",stroke:color,"stroke-width":3.5,"stroke-linecap":"round"}));
|
|
}
|
|
// vertical arrow (straight down)
|
|
function arrowDown(x,y1,y2,color,dash){
|
|
svg.appendChild(el("path",{d:`M ${x} ${y1} L ${x} ${y2-11}`,fill:"none",stroke:color,"stroke-width":3.5,"stroke-linecap":"round","stroke-dasharray":dash||"none"}));
|
|
const a=7;
|
|
svg.appendChild(el("path",{d:`M ${x} ${y2-11} l -${a} -${a+4} M ${x} ${y2-11} l ${a} -${a+4}`,fill:"none",stroke:color,"stroke-width":3.5,"stroke-linecap":"round"}));
|
|
}
|
|
|
|
// ===== PIPELINE STAGES =====
|
|
// label
|
|
txt(20,40,"REQUEST PIPELINE",{w:700,sz:14,ls:".2em",fill:SOFT});
|
|
|
|
// node geometry: 7 nodes across. client endpoints are cold; hook chain stages are paper/hi; backend is rust.
|
|
const ROW_Y=120, NH=120;
|
|
// columns laid out within 1480 viewBox
|
|
const nodes=[
|
|
{x:20, w:150, fill:PAPER2, name:"client", sub:"request", kind:"end"},
|
|
{x:210, w:178, fill:HI, name:"auth", sub:"API key · access", kind:"hook"},
|
|
{x:428, w:220, fill:HI, name:"route model", sub:"may rewrite input.Model", kind:"hook"},
|
|
{x:688, w:200, fill:HI, name:"per-model PII", sub:"redact input", kind:"hook"},
|
|
{x:928, w:178, fill:RUST, name:"backend", sub:"model runs", kind:"backend"},
|
|
{x:1146, w:188, fill:HI, name:"streaming PII", sub:"redact output", kind:"hook"},
|
|
{x:1374, w:86, fill:PAPER2, name:"client", sub:"response", kind:"end2"},
|
|
];
|
|
|
|
nodes.forEach(n=>{
|
|
const stroke = n.kind==="backend" ? INK : INK;
|
|
shadowRect(n.x,ROW_Y,n.w,NH,n.fill,stroke,n.kind==="backend"?4:3.5);
|
|
const nameFill = n.kind==="backend" ? PAPER : INK;
|
|
const subFill = n.kind==="backend" ? "#F1D9C8" : SOFT;
|
|
// wrap name if needed
|
|
if(n.name.includes(" ")){
|
|
const parts=n.name.split(" ");
|
|
txt(n.x+n.w/2,ROW_Y+50,parts[0],{f:"Bricolage Grotesque",w:800,sz:24,a:"middle",fill:nameFill});
|
|
txt(n.x+n.w/2,ROW_Y+78,parts.slice(1).join(" "),{f:"Bricolage Grotesque",w:800,sz:24,a:"middle",fill:nameFill});
|
|
txt(n.x+n.w/2,ROW_Y+104,n.sub,{w:700,sz:13,a:"middle",fill:subFill});
|
|
} else {
|
|
txt(n.x+n.w/2,ROW_Y+62,n.name,{f:"Bricolage Grotesque",w:800,sz:25,a:"middle",fill:nameFill});
|
|
txt(n.x+n.w/2,ROW_Y+92,n.sub,{w:700,sz:13,a:"middle",fill:subFill});
|
|
}
|
|
});
|
|
|
|
// ===== HOOK CHAIN bracket (under the four middleware stages) =====
|
|
const chainStart=nodes[1].x, chainEnd=nodes[5].x+nodes[5].w;
|
|
const braceY=ROW_Y+NH+34;
|
|
svg.appendChild(el("line",{x1:chainStart,y1:braceY,x2:chainEnd,y2:braceY,stroke:RUSTD,"stroke-width":3,"stroke-dasharray":"3 8"}));
|
|
svg.appendChild(el("line",{x1:chainStart,y1:braceY-10,x2:chainStart,y2:braceY+10,stroke:RUSTD,"stroke-width":3}));
|
|
svg.appendChild(el("line",{x1:chainEnd,y1:braceY-10,x2:chainEnd,y2:braceY+10,stroke:RUSTD,"stroke-width":3}));
|
|
// chain label badge
|
|
const lbW=210,lbH=32,lbx=(chainStart+chainEnd)/2-lbW/2,lby=braceY-lbH/2;
|
|
svg.appendChild(el("rect",{x:lbx,y:lby,width:lbW,height:lbH,fill:PAPER,stroke:RUSTD,"stroke-width":2.5}));
|
|
txt((chainStart+chainEnd)/2,braceY+6,"SHARED HOOK CHAIN",{f:"Bricolage Grotesque",w:800,sz:16,a:"middle",ls:".04em",fill:RUSTD});
|
|
|
|
// ===== HORIZONTAL ARROWS between nodes =====
|
|
const midY=ROW_Y+NH/2;
|
|
for(let i=0;i<nodes.length-1;i++){
|
|
const a=nodes[i], b=nodes[i+1];
|
|
// backend boundary (gRPC) into and out of backend dashed; others solid
|
|
const intoBackend = b.kind==="backend";
|
|
const outBackend = a.kind==="backend";
|
|
const dash = (intoBackend||outBackend) ? "2 8" : "none";
|
|
const color = (intoBackend||outBackend) ? RUSTD : INK;
|
|
arrow(a.x+a.w, midY, b.x, midY, color, dash);
|
|
}
|
|
|
|
// ===== SIDE-CHANNEL LOG BOXES (downward) =====
|
|
const logY=braceY+76, logH=88;
|
|
const logs=[
|
|
{name:"decision log", sub:"auth · routing", srcNode:2},
|
|
{name:"event log", sub:"PII · backend", srcNode:4},
|
|
];
|
|
logs.forEach(l=>{
|
|
const src=nodes[l.srcNode];
|
|
const cx=src.x+src.w/2;
|
|
const lw=210, lx=cx-lw/2;
|
|
shadowRect(lx,logY,lw,logH,PAPER2,COLD,3.5);
|
|
txt(cx,logY+42,l.name,{f:"Bricolage Grotesque",w:800,sz:22,a:"middle",fill:INK});
|
|
txt(cx,logY+68,l.sub,{w:700,sz:13,a:"middle",fill:COLD});
|
|
// arrow from chain brace down to box
|
|
arrowDown(cx,braceY+14,logY,COLD,"2 8");
|
|
});
|
|
|
|
</script>
|
|
</body>
|
|
</html>
|