From 278884d6b81376904f4dc62f27b146e53c42c4ae Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Thu, 26 Feb 2026 21:15:42 -0800 Subject: [PATCH] docs: add install notes for /opt ownership, Podman rootless, Docker group --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index ced4283..8a5ec77 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,24 @@ make start PROFILE=single-gpu > **macOS:** Docker Desktop must be running before starting. > **Windows:** Not supported — use WSL2 with Ubuntu. +### Installing to `/opt` or other system directories + +If you clone into a root-owned directory, fix ownership first so preflight can write `.env` and `compose.override.yml`: + +```bash +sudo chown -R $USER:$USER /opt/peregrine +``` + +Then run without `sudo` — Peregrine doesn't need it. + +### Podman + +Podman is rootless by default — **no `sudo` needed.** `./manage.sh setup` will configure `podman-compose` if it isn't already present. + +### Docker + +After `./manage.sh setup`, log out and back in for docker group membership to take effect. Until then, prefix commands with `sudo`. After re-login, `sudo` is no longer required. + --- ## Inference Profiles