Download¶
Iris is distributed from iris.monmyip.io; the public install repo (scripts, Compose, terms) is github.com/yakden/iris-vms.
Download for Windows iris-vms on GitHub
Which build do I need?¶
| Platform | Artifact | Notes |
|---|---|---|
| Linux | iris-install.sh (one command) |
Installs Docker, auto-detects an NVIDIA GPU, loads the image, starts the stack. |
| Windows 10/11 | iris-setup-*.exe |
Bootstraps WSL2 + Docker + NVIDIA, then the stack. Mandatory EULA acceptance at install. |
| macOS 12+ | iris-install.sh (one command) |
Needs Docker Desktop. CPU-only (evaluation). |
| Offline / air-gap | iris-offline-update-*.tar |
Image tar + signed manifest + checksums for a disconnected site. |
| Source / eval | clone the repo | CPU fallback for evaluation; see Install & run. |
Disk footprint & requirements¶
Iris downloads a self-contained application image plus the AI models. The full footprint is fixed regardless of which features you enable — turning a subsystem off (face, audio, …) saves GPU/CPU at runtime, not disk, because the models still ship.
| Item | Size | Notes |
|---|---|---|
| Application image (loaded into Docker) | ~7.5 GB | one image, all subsystems |
| AI models (downloaded on first run) | ~0.9 GB | detector, appearance, face, age/gender, vehicle, audio |
| Image download (temporary) | ~3 GB | freed after it is loaded |
| WSL2 + Docker engine (Windows only) | ~2 GB | set up automatically |
| Recordings / data | grows | bounded by your retention policy |
Plan for ≈15 GB free on Windows (≈12 GB on Linux/macOS) to install and start, plus room for recordings. 64-bit only; an NVIDIA GPU is used automatically when present (Linux/Windows) — macOS is CPU-only (evaluation).
Install (quick paths)¶
curl -fsSL https://iris.monmyip.io/downloads/iris-install.sh | sudo bash
# with a licence key:
curl -fsSL https://iris.monmyip.io/downloads/iris-install.sh | sudo IRIS_TOKEN=xxxx bash
Installs Docker (if missing), auto-detects an NVIDIA GPU, loads the image, downloads the models,
starts the stack and opens http://127.0.0.1:8120. Leave IRIS_TOKEN unset for the 7-day trial.
Install and start Docker Desktop, then:
macOS runs CPU-only (evaluation) — no NVIDIA GPU.
- Download iris-setup-1.60.0.exe (SHA-256).
- Run it (admin). Accept the licence agreement when prompted — the free trial is 7 days, full-feature, online-only.
- It sets up WSL2 + Docker + NVIDIA and opens
http://127.0.0.1:8120.
A local build is unsigned (Authenticode signing happens in CI) — SmartScreen may warn.
See Appliance deployment and Deployment config.
Licence & trial¶
Installing Iris means accepting the EULA. The optional free trial is a 7-day, online-only, one-per-machine evaluation with the full feature set — see the trial terms in EULA §1a and Deployment config.