mirror of
https://github.com/mudler/LocalAI.git
synced 2026-08-01 02:49:51 -04:00
94d5affcea
* feat(website): split the site, move docs to /docs, add a landing page The Hugo docs site has always been localai.io itself, which left nowhere to explain what LocalAI is or show what the team builds. This adds a separate marketing site at the root and moves the documentation under /docs/. Docs: The existing site keeps its content tree and its Relearn theme, and now builds with baseURL <root>/docs/. Its _index.md, which held a hand written landing page, becomes a real documentation home. Every previously published URL keeps working. GitHub Pages has no server side rewrites, so .github/ci/gen-redirects.sh walks the built docs output and leaves a meta refresh plus a canonical link at each old root path. It covers bare .html files too, which is what keeps /gallery.html alive, and it never overwrites a path the marketing site already owns. Website: A second Hugo site under website/ with its own layouts and no external theme, so the marketing side does not have to fight Relearn's home rooted menu and asset pipeline. CI builds both and merges them into one Pages artifact. The design is derived from the project logo rather than invented: the navy of the triangle, the cyan of the llama, the purple of the speed bars. Those offset bars became the motion signature. The background renders a real depth-anything.cpp depth map as contour lines and switches to a locate-anything.cpp style detection overlay over the engines section. Also included: an /engines/ index driven entirely by data/engines.yaml, a /blog/ section with five posts written from the release notes and the engine benchmark suites, install.sh and a Kubernetes manifest since the site advertises both, and a rule in .agents/ that release preparation now includes a blog post and demo clips. Every figure on the site is derived from the repository or the GitHub API, not from memory. Correcting them against their sources found one error in README.md: voxtral-tts.c is text to speech, not speech to text. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: Claude Code:claude-opus-5 [Bash] [Edit] [Write] [Agent] * feat(website): add a star history chart, rewrite the history post in first person The history post read like a changelog written by a committee. It is now in Ettore's voice, first person, with the admissions left in. The numbers paragraph in particular read like a directory listing. It now says what the figures mean rather than which file they came from. Adds an interactive star history chart, built from the GitHub stargazers API rather than embedded from a third party, so the page makes no external request and cannot break when someone else's service is down. The four releases the post is organised around are marked on the curve, and the labels stack into rows because three of them land within two months of each other. The API stops paginating at 40,000 items, so the curve is measured up to December 2025 and the segment from there to today's total is drawn dashed, labelled as an estimate in the caption and in the tooltip. It is a straight line between two known points, and the chart says so rather than implying it is data. Also drops "marketing site" from the README heading and everywhere else it appeared, and calls it the main site instead. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: Claude Code:claude-opus-5 [Bash] [Edit] [Write] --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
2.0 KiB
2.0 KiB
+++ disableToc = false title = "LocalAI documentation" description = "Install LocalAI, run models, and operate it in production." type = "home" +++
LocalAI is the open source AI runtime: a small core that speaks the OpenAI and Anthropic APIs, with each inference backend added only when a model needs it. It runs text, vision, speech, sound, images, video, embeddings, reranking, and autonomous agents on hardware you control, from a CPU laptop to a distributed GPU cluster.
New here? Read the [Overview]({{% relref "overview" %}}) for what LocalAI is and how the pieces fit together, then follow the [Quickstart]({{% relref "getting-started/quickstart" %}}).
docker run -ti --name local-ai -p 8080:8080 localai/localai:latest
Sections
- [Getting started]({{% relref "getting-started" %}}) - install LocalAI, run your first model, call the API, and fix the common startup problems.
- [Features]({{% relref "features" %}}) - every capability, grouped by modality: text, agents, audio, vision, image and video, retrieval, distributed inference, and model management.
- [Advanced]({{% relref "advanced" %}}) - model configuration, VRAM management, reverse proxies and TLS, and the rest of the fine-grained control surface.
- [Operations]({{% relref "operations" %}}) - running and governing an instance: middleware, cloud and MITM proxies, backend monitoring.
- [Reference]({{% relref "reference" %}}) - architecture, CLI flags, the compatibility table, API and runtime errors, system info, and binaries.
- [FAQ]({{% relref "faq" %}}) - short answers to the questions that come up most often.
Also useful
- [Integrations]({{% relref "integrations" %}}) - projects and tools built on top of LocalAI.
- [News]({{% relref "whats-new" %}}) - where release notes live.
- Model gallery - browse the models you can install with one click.
- GitHub and Discord - report an issue or ask a question.