mirror of
https://github.com/mudler/LocalAI.git
synced 2026-07-08 23:37:43 -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>
136 lines
6.6 KiB
HTML
136 lines
6.6 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> Quickstart</div>
|
|
<h1>Install, run, <em>serve</em></h1>
|
|
</div>
|
|
<div class="stamp">
|
|
<div class="k">QUICK</div>
|
|
<div class="s">start</div>
|
|
</div>
|
|
</header>
|
|
<div class="stage"><svg viewBox="0 0 1480 560" id="svg"></svg></div>
|
|
<footer>
|
|
<div class="note">From install to your first <b>/v1</b> call in three steps.</div>
|
|
<div class="url">localai.io<span>/basics/getting_started</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"}));
|
|
}
|
|
|
|
// ============ MAIN FLOW STRIP (four steps) ============
|
|
const SW=300, SH=200, SY=70;
|
|
const cols=[20, 392, 764, 1136];
|
|
const steps=[
|
|
{num:"1", title:"Install", rust:false, lines:["Docker image","macOS DMG","or static binary"]},
|
|
{num:"2", title:"Start LocalAI", rust:false, lines:["run the container","or the binary","core comes up"]},
|
|
{num:"3", title:"Pick a model", rust:false, alt:true, lines:["Open the Web UI","— OR —","local-ai run <model>"]},
|
|
{num:"4", title:"Talk to it", rust:true, alt:true, lines:["Chat in the UI","— OR —","curl /v1/chat/…"]},
|
|
];
|
|
|
|
steps.forEach((s,i)=>{
|
|
const x=cols[i], y=SY;
|
|
const fill = s.rust ? PAPER : PAPER2;
|
|
shadowRect(x,y,SW,SH, fill, INK, 4);
|
|
// header bar
|
|
const barFill = s.rust ? RUST : INK;
|
|
svg.appendChild(el("rect",{x:x,y:y,width:SW,height:54,fill:barFill}));
|
|
svg.appendChild(el("line",{x1:x,y1:y+54,x2:x+SW,y2:y+54,stroke:INK,"stroke-width":3}));
|
|
// step number badge
|
|
txt(x+22,y+38,"STEP "+s.num,{w:700,sz:15,ls:".14em",fill:PAPER});
|
|
txt(x+SW-22,y+37,s.title,{f:"Bricolage Grotesque",w:800,sz:25,a:"end",fill:PAPER});
|
|
// body lines
|
|
let ly=y+102;
|
|
s.lines.forEach(t=>{
|
|
const sep = t.indexOf("OR")>=0;
|
|
txt(x+SW/2, ly, t, {f:"Bricolage Grotesque", w: sep?700:700, sz: sep?17:22, a:"middle", fill: sep?(s.alt?COLD:SOFT):INK});
|
|
ly += sep?40:46;
|
|
});
|
|
});
|
|
|
|
// ---- arrows between steps ----
|
|
for(let i=0;i<3;i++){
|
|
const c = (i===2) ? RUST : INK;
|
|
arrow(cols[i]+SW, SY+SH/2, cols[i+1], SY+SH/2, c);
|
|
}
|
|
|
|
// ============ OPTIONAL DOWNWARD BRANCHES (below step 3 & 4) ============
|
|
const optY=380, optH=110, optW=300;
|
|
const opts=[
|
|
{x:cols[2], title:"Agents", sub:"LocalAGI · tools & memory", from:2},
|
|
{x:cols[3], title:"Distributed mode", sub:"scale across machines", from:3},
|
|
];
|
|
|
|
// "optional" tag
|
|
txt(cols[2]+SW/2, 345, "OPTIONAL — GO FURTHER", {w:700, sz:14, ls:".18em", a:"middle", fill:DIM});
|
|
|
|
opts.forEach(o=>{
|
|
// dashed connector from parent step bottom down to option box
|
|
const px = o.x + SW/2;
|
|
arrow(px, SY+SH, px, optY, COLD, "2 8");
|
|
// option box (dashed, cold)
|
|
svg.appendChild(el("rect",{x:o.x+7,y:optY+7,width:optW,height:optH,fill:INK}));
|
|
svg.appendChild(el("rect",{x:o.x,y:optY,width:optW,height:optH,fill:PAPER,stroke:COLD,"stroke-width":3.5,"stroke-dasharray":"4 7"}));
|
|
txt(o.x+22, optY+50, o.title, {f:"Bricolage Grotesque", w:800, sz:26, fill:COLD});
|
|
txt(o.x+22, optY+82, o.sub, {w:700, sz:15, fill:SOFT});
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|