Skip to main content

Install Olympus

Two questions, then one Docker command:

  1. What OS are you on? — pick the OS tab inside each code block. Your choice is remembered across the page.
  2. Do you have an NVIDIA GPU? — pick Without GPU if you're unsure or plan to use cloud AI providers (OpenAI / Anthropic / Gemini). Pick With NVIDIA GPU only if you want local AI models (Ollama, Stable Diffusion) running on your own hardware.

1. Pre-flight check — 30 seconds​

Run the snippet for your OS and look for three ✅ marks. Each ❌ tells you exactly what to fix before installing.

docker info >/dev/null 2>&1 \
  && echo "✅ Docker is running" \
  || echo "❌ Docker is not running — start Docker / Docker Desktop and re-run this check"

df -BG / | awk 'NR==2 { gsub("G","",$4); if ($4+0 >= 30) print "✅ "$4" GB free on /"; else print "❌ Only "$4" GB free on / — need 30 GB+" }'

(lsof -i :8888 >/dev/null 2>&1 \
  && echo "❌ Port 8888 is in use — see Troubleshooting" \
  || echo "✅ Port 8888 is free")

Got a ❌? Fix it here​

  • Docker is not running → start Docker Desktop, or sudo systemctl start docker on Linux, then re-run the check.
  • Not enough disk space → see System Requirements for what the install actually needs.
  • Port 8888 is in use → how to clear port 8888. Most often this is your own previous Olympus installer still running, not another application. That page shows you how to tell which, then covers reopening the wizard you already have, restarting everything without reinstalling, or wiping for a clean fresh install.

2. Pick your install path​

:::info You picked the no-GPU path The platform works fully without a GPU — use cloud AI providers (OpenAI, Anthropic, Gemini) for chat/embeddings/vision. You can always switch to a GPU later by re-running with the With NVIDIA GPU path. :::

Run the installer​

Pick your OS and run the command. It pulls the setup image (~few hundred MB) and starts the browser wizard at http://localhost:8888.

mkdir -p "$HOME/olympus/app" "$HOME/olympus/data" && \
docker rm -f olympus-setup >/dev/null 2>&1 || true && \
docker pull olympusmobile/olympus-master-setup:latest && \
docker run -d \
  --name olympus-setup \
  -p 8888:8888 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v "$HOME/olympus/app":"$HOME/olympus/app" \
  -v "$HOME/olympus/data":"$HOME/olympus/data" \
  -e HOST_PROJECT_ROOT="$HOME/olympus/app" \
  -e DOCKER_USERNAME="olympussupport" \
  -e DOCKER_TOKEN="dckr_pat_nnZK2QRyooOHm944bKzRTKo12-w" \
  olympusmobile/olympus-master-setup:latest >/dev/null && \
docker logs -f olympus-setup

What you'll see while it runs​

After running the command, the terminal will:

  1. Download the setup image (a few hundred MB — fast).

  2. Start the setup container in the background, then stream its log output to your terminal.

  3. Eventually print a line that says the wizard is ready, something like:

    ✅ Setup wizard ready at http://localhost:8888

When you see that line, open http://localhost:8888 in your browser (or http://<your-server-ip>:8888 if you're installing on a remote machine). Leave the terminal open — it'll keep showing logs you can refer to if something goes wrong.

:::tip Stuck on download? First image pulls can be slow on metered or international connections — the setup image is small, but the full platform downloads later total ~6 GB across 30+ images. :::

Once the wizard opens, head to Setup Wizard → for the 9-step walkthrough.