Installation Guide

Detailed installation instructions for each platform. See README for getting started.

Ubuntu/Debian

# Install Git
sudo apt update
sudo apt install git

# Install Docker (recommended)
sudo apt install docker.io docker-compose-v2
sudo usermod -aG docker $USER
# Log out and back in for group changes to take effect

# Or install Podman instead
sudo apt install podman podman-compose

Fedora/RHEL

# Install Git
sudo dnf install git

# Install Podman
sudo dnf install podman podman-compose

macOS

Git is included with Xcode Command Line Tools (xcode-select --install) or install via Homebrew:

brew install git
brew install docker docker-compose

Or install Docker Desktop.

Windows

Download and install Git for Windows
Install Docker Desktop which includes Docker Compose

Windows WSL

For environments where Docker Desktop is not available, you can use Podman in WSL.

# In PowerShell: Install WSL and Ubuntu
wsl --install -d Ubuntu
# Restart your computer to complete the installation

After restart, launch “Ubuntu” from the Start menu and run:

sudo apt update
sudo apt install git podman podman-compose

NixOS / Nix

This repository includes a Nix flake with all dependencies:

nix develop

Or with direnv, create a .envrc file containing use flake and run direnv allow.

Alternatively, install manually:

# In configuration.nix or home.nix
environment.systemPackages = with pkgs; [
  git
  podman
  podman-compose
];