← Back to Yantr

Get Started

Install Yantr

Pick your platform. Each tab walks you through installing Docker and Yantr in one place, with compatibility notes so you know exactly what to expect.

Perfect isolation

Every app runs in a walled container — they can't break each other or your host OS.

No dependency hell

Every app bundles its own runtime — Python, Node, CUDA — no version conflicts.

Clean removal

Stop and delete a container. Zero leftover files, libraries, or background services.

Compatibility

✓ Full supportAll features work — recommended platform. Ubuntu, Debian, Fedora, Arch, any 64-bit distro.
✓ Native socket/var/run/docker.sock is available directly — no VM layer.
Step 1 — Install Docker
1

Run the official install script

Works on Ubuntu, Debian, Fedora, Arch, and most other distros.

curl -fsSL https://get.docker.com | sudo sh
2

Run Docker without sudo

Add your user to the docker group.

sudo usermod -aG docker $USER && newgrp docker
3

Verify Docker is working

docker run hello-world
Step 2 — Install Yantr
1

Run Yantr

bash / zsh
docker run -d \
  --name yantr \
  --network host \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /var/lib/docker/volumes:/var/lib/docker/volumes \
  --restart unless-stopped \
  ghcr.io/besoeasy/yantr
2

Open Yantr

Visit http://localhost:5252 and create your operator account on first visit.

Compatibility

✓ WorksDocker Desktop symlinks the socket to /var/run/docker.sock automatically.
✓ WorksPort binding -p 5252:5252 works correctly on Intel and Apple Silicon.
✗ Unavailable--network host — Docker runs inside a Linux VM on macOS, so host networking is not available. Use -p instead (already the default here).
⚠ Colima / OrbStackSocket path may differ. Pass -e DOCKER_SOCKET=/path/to/docker.sock and mount that path instead.
Step 1 — Install Docker
1

Install via Homebrew recommended

Works on Intel and Apple Silicon (M1/M2/M3).

brew install --cask docker

— or — download the Docker Desktop .dmg installer →

2

Launch Docker Desktop from Applications, then verify

docker run hello-world
Step 2 — Install Yantr
1

Run Yantr (Docker Desktop must be open)

Terminal
docker run -d \
  --name yantr \
  -p 5252:5252 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --restart unless-stopped \
  ghcr.io/besoeasy/yantr
2

Open Yantr

Visit http://localhost:5252 in your browser.

Using Colima or OrbStack?

Find your socket path (e.g. ~/.colima/default/docker.sock) and add -e DOCKER_SOCKET=<path> to the command above, replacing the -v mount accordingly.

Compatibility

✓ WorksDocker Desktop for Windows (WSL2 backend) — socket accessible at /var/run/docker.sock inside WSL2.
✓ WorksPort binding -p 5252:5252 works in PowerShell and WSL2 terminal.
✗ Unavailable--network host — not available on Windows. Use -p instead (already the default here).
ℹ RecommendedRun commands from PowerShell or the WSL2 terminal, not Command Prompt.
Step 1 — Install Docker
1

Enable WSL 2

Open PowerShell as Administrator and run:

wsl --install

Restart your computer when this finishes.

2

Install Docker Desktop

Download and run the official installer. Make sure "Use WSL 2" is checked.

Download Docker for Windows
3

Verify Docker is working

docker run hello-world
Step 2 — Install Yantr
1

Run Yantr from PowerShell

PowerShell
docker run -d `
  --name yantr `
  -p 5252:5252 `
  -v /var/run/docker.sock:/var/run/docker.sock `
  --restart unless-stopped `
  ghcr.io/besoeasy/yantr

PowerShell uses backtick ` for line continuation instead of \

2

Open Yantr

Visit http://localhost:5252 in your browser.

Compatibility

✓ Full supportRaspberry Pi 4 & 5 (arm64) — all features work.
⚠ PartialRaspberry Pi 3 (armv7) — Yantr runs, but some app images may not have arm/v7 builds.
ℹ TipUse Raspberry Pi OS 64-bit (Bookworm) for best compatibility.

ARM Architecture Notice

Commands are identical to Linux, but check that the apps you want to run offer an ARM64 image build. Nearly all popular Yantr catalog apps do.

Step 1 — Install Docker
1

Run the official install script

curl -fsSL https://get.docker.com | sudo sh
2

Add Pi user to docker group

sudo usermod -aG docker $USER && newgrp docker
Step 2 — Install Yantr
1

Run Yantr

bash
docker run -d \
  --name yantr \
  --network host \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /var/lib/docker/volumes:/var/lib/docker/volumes \
  --restart unless-stopped \
  ghcr.io/besoeasy/yantr
2

Open Yantr

Access from any device on your network: http://<pi-ip>:5252, or on the Pi itself: http://localhost:5252

Common Commands

Update Yantr

Pull the latest image and restart

docker pull ghcr.io/besoeasy/yantr
docker stop yantr && docker rm yantr
# then re-run the install command above

Remove Yantr

Stop and delete the container

docker stop yantr
docker rm yantr
# App data stays in Docker volumes
← Back to Yantr Report an issue