Hardware Setup
Install Docker
Before you can use Yantr, you need Docker installed on your host system. It handles all the low-level process isolation so your homelab apps never conflict.
Perfect Isolation
Every app runs in a walled "container". They cannot break each other or mess up your host OS.
No Dependency Hell
Need Python 2 for one app and Python 3 for another? Containers bundle their own dependencies effortlessly.
Clean Removal
Stop an app and delete its container. Zero leftover files, libraries, or background services.
Requirements
Windows 11 with WSL 2 enabled (recommended) or Hyper-V. 64-bit; at least 4 GB RAM.
Enable WSL 2 in Windows
Open a PowerShell terminal as Administrator and install the Windows Subsystem for Linux.
wsl --install
Restart your computer when this finishes.
Install Docker Desktop
Download the official graphical installer from Docker for your architecture.
Download Docker for WindowsVerify Installation
Open your Terminal or command prompt, and run the hello-world test.
docker run hello-world
Requirements
macOS 12 (Monterey) or newer. Compatible with Intel or Apple Silicon (M1/M2/M3).
Install via Homebrew (Recommended)
The fastest way to install Docker on a Mac is through the Homebrew package manager in your terminal.
brew install --cask docker
Install via Graphical Installer
Download the .dmg installer for your chip from Docker's official website.
Download Docker for MacVerify Installation
Open your Terminal, and run the testing container.
docker run hello-world
Requirements
Any 64-bit Linux server or desktop (Ubuntu, Debian, Fedora, Arch). This script works on all major distros.
Run the install script
This official script adds the correct package repos and installs the Engine natively.
curl -fsSL https://get.docker.com | sudo sh
Run without Sudo
Add your standard user to the Docker group so you do not need root privileges for every command.
sudo usermod -aG docker $USER && newgrp docker
Verify & Launch
Confirm Docker wakes up correctly.
docker run hello-world
Requirements
Raspberry Pi 3/4/5 running Raspberry Pi OS (64-bit recommended) or Ubuntu ARM64.
ARM Architecture Notice
The commands are identical to normal Linux, but you must ensure the apps you later run offer an ARM64 image build. Nearly all popular ones on Yantr do.
Install via Script
Run the official install script directly from Docker.
curl -fsSL https://get.docker.com | sudo sh
Add Pi User Group
To use docker commands without typing sudo every time.
sudo usermod -aG docker $USER && newgrp docker
You're all set.
Now you can deploy Yantr instantly using a single run command.
Launch Yantr Now