LocalAI/docs/content/installation/_index.en.md

44 lines
1.3 KiB
Markdown
Raw Normal View History

---
weight: 2
title: "Installation"
description: "How to install LocalAI"
type: chapter
icon: download
---
LocalAI can be installed in multiple ways depending on your platform and preferences.
## Video Walkthrough
[![Installation Video](https://img.youtube.com/vi/cMVNnlqwfw4/maxresdefault.jpg)](https://www.youtube.com/watch?v=cMVNnlqwfw4)
## Installation Methods
Choose the installation method that best suits your needs:
docs: add Podman installation documentation (#8646) * docs: add Podman installation documentation - Add new podman.md with comprehensive installation and usage guide - Cover installation on multiple platforms (Ubuntu, Fedora, Arch, macOS, Windows) - Document GPU support (NVIDIA CUDA, AMD ROCm, Intel, Vulkan) - Include rootless container configuration - Document Docker Compose with podman-compose - Add troubleshooting section for common issues - Link to Podman documentation in installation index - Update image references to use Docker Hub and link to docker docs - Change YAML heredoc to EOF in compose.yaml example - Add curly brackets to notice shortcode and fix link Closes #8645 Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: merge Docker and Podman docs into unified Containers guide Following the review comment, we have merged the Docker and Podman documentation into a single 'Containers' page that covers both container engines. The Docker and Podman pages now redirect to this unified guide. Changes: - Added new docs/content/installation/containers.md with combined Docker/Podman guide - Updated docs/content/installation/docker.md to redirect to containers - Updated docs/content/installation/podman.md to redirect to containers - Updated docs/content/installation/_index.en.md to link to containers Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: remove podman.md as docs are merged into containers.md Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> --------- Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Co-authored-by: localai-bot <localai-bot@users.noreply.github.com>
2026-02-25 07:13:55 +00:00
1. **[Containers](containers/)** ⭐ **Recommended** - Works on all platforms, supports Docker and Podman
2. **[macOS](macos/)** - Download and install the DMG application
3. **[Linux](linux/)** - Install on Linux using binaries
4. **[Kubernetes](kubernetes/)** - Deploy LocalAI on Kubernetes clusters
5. **[Build from Source](build/)** - Build LocalAI from source code
## Quick Start
docs: add Podman installation documentation (#8646) * docs: add Podman installation documentation - Add new podman.md with comprehensive installation and usage guide - Cover installation on multiple platforms (Ubuntu, Fedora, Arch, macOS, Windows) - Document GPU support (NVIDIA CUDA, AMD ROCm, Intel, Vulkan) - Include rootless container configuration - Document Docker Compose with podman-compose - Add troubleshooting section for common issues - Link to Podman documentation in installation index - Update image references to use Docker Hub and link to docker docs - Change YAML heredoc to EOF in compose.yaml example - Add curly brackets to notice shortcode and fix link Closes #8645 Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: merge Docker and Podman docs into unified Containers guide Following the review comment, we have merged the Docker and Podman documentation into a single 'Containers' page that covers both container engines. The Docker and Podman pages now redirect to this unified guide. Changes: - Added new docs/content/installation/containers.md with combined Docker/Podman guide - Updated docs/content/installation/docker.md to redirect to containers - Updated docs/content/installation/podman.md to redirect to containers - Updated docs/content/installation/_index.en.md to link to containers Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: remove podman.md as docs are merged into containers.md Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> --------- Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Co-authored-by: localai-bot <localai-bot@users.noreply.github.com>
2026-02-25 07:13:55 +00:00
**Recommended: Containers (Docker or Podman)**
```bash
docs: add Podman installation documentation (#8646) * docs: add Podman installation documentation - Add new podman.md with comprehensive installation and usage guide - Cover installation on multiple platforms (Ubuntu, Fedora, Arch, macOS, Windows) - Document GPU support (NVIDIA CUDA, AMD ROCm, Intel, Vulkan) - Include rootless container configuration - Document Docker Compose with podman-compose - Add troubleshooting section for common issues - Link to Podman documentation in installation index - Update image references to use Docker Hub and link to docker docs - Change YAML heredoc to EOF in compose.yaml example - Add curly brackets to notice shortcode and fix link Closes #8645 Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: merge Docker and Podman docs into unified Containers guide Following the review comment, we have merged the Docker and Podman documentation into a single 'Containers' page that covers both container engines. The Docker and Podman pages now redirect to this unified guide. Changes: - Added new docs/content/installation/containers.md with combined Docker/Podman guide - Updated docs/content/installation/docker.md to redirect to containers - Updated docs/content/installation/podman.md to redirect to containers - Updated docs/content/installation/_index.en.md to link to containers Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: remove podman.md as docs are merged into containers.md Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> --------- Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Co-authored-by: localai-bot <localai-bot@users.noreply.github.com>
2026-02-25 07:13:55 +00:00
# With Docker
docker run -p 8080:8080 --name local-ai -ti localai/localai:latest
docs: add Podman installation documentation (#8646) * docs: add Podman installation documentation - Add new podman.md with comprehensive installation and usage guide - Cover installation on multiple platforms (Ubuntu, Fedora, Arch, macOS, Windows) - Document GPU support (NVIDIA CUDA, AMD ROCm, Intel, Vulkan) - Include rootless container configuration - Document Docker Compose with podman-compose - Add troubleshooting section for common issues - Link to Podman documentation in installation index - Update image references to use Docker Hub and link to docker docs - Change YAML heredoc to EOF in compose.yaml example - Add curly brackets to notice shortcode and fix link Closes #8645 Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: merge Docker and Podman docs into unified Containers guide Following the review comment, we have merged the Docker and Podman documentation into a single 'Containers' page that covers both container engines. The Docker and Podman pages now redirect to this unified guide. Changes: - Added new docs/content/installation/containers.md with combined Docker/Podman guide - Updated docs/content/installation/docker.md to redirect to containers - Updated docs/content/installation/podman.md to redirect to containers - Updated docs/content/installation/_index.en.md to link to containers Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: remove podman.md as docs are merged into containers.md Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> --------- Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Co-authored-by: localai-bot <localai-bot@users.noreply.github.com>
2026-02-25 07:13:55 +00:00
# Or with Podman
podman run -p 8080:8080 --name local-ai -ti localai/localai:latest
```
This will start LocalAI. The API will be available at `http://localhost:8080`.
For other platforms:
- **macOS**: Download the [DMG](macos/)
- **Linux**: See the [Linux installation guide](linux/) for binary installation.
docs: add Podman installation documentation (#8646) * docs: add Podman installation documentation - Add new podman.md with comprehensive installation and usage guide - Cover installation on multiple platforms (Ubuntu, Fedora, Arch, macOS, Windows) - Document GPU support (NVIDIA CUDA, AMD ROCm, Intel, Vulkan) - Include rootless container configuration - Document Docker Compose with podman-compose - Add troubleshooting section for common issues - Link to Podman documentation in installation index - Update image references to use Docker Hub and link to docker docs - Change YAML heredoc to EOF in compose.yaml example - Add curly brackets to notice shortcode and fix link Closes #8645 Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: merge Docker and Podman docs into unified Containers guide Following the review comment, we have merged the Docker and Podman documentation into a single 'Containers' page that covers both container engines. The Docker and Podman pages now redirect to this unified guide. Changes: - Added new docs/content/installation/containers.md with combined Docker/Podman guide - Updated docs/content/installation/docker.md to redirect to containers - Updated docs/content/installation/podman.md to redirect to containers - Updated docs/content/installation/_index.en.md to link to containers Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> * docs: remove podman.md as docs are merged into containers.md Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> --------- Signed-off-by: localai-bot <localai-bot@users.noreply.github.com> Signed-off-by: LocalAI [bot] <localai-bot@users.noreply.github.com> Co-authored-by: localai-bot <localai-bot@users.noreply.github.com>
2026-02-25 07:13:55 +00:00
For detailed instructions, see the [Containers installation guide](containers/).