Windows and macOS
KumoYami on your computer with Docker Desktop, to try it out or use it at home.
With Docker Desktop, KumoYami runs on Windows and macOS just as it does on a server. It's ideal for trying it out, sharing your computer's folders at home, or getting your settings ready before moving to a server. For a public site that's always on and has a domain, a Linux server is the better fit.
The installer won't work here
install.sh is Linux only. On Windows and macOS, follow these steps instead: they're the
Docker Compose install, adapted.
Requirements
- 64-bit Windows 10 or 11 with WSL 2 (Docker Desktop turns it on during setup), or a recent version of macOS.
- Docker Desktop installed and running.
- A PC with Intel or AMD, or a Mac. For Apple Silicon Macs (M1, M2, M3…), see the note below.
ARM: coming soon
KumoYami's image is x86_64 only for now (Intel and AMD processors). The ARM build (arm64: Raspberry Pi, Apple Silicon Macs, ARM servers and NAS) is coming in an upcoming release, and this guide will be updated when it lands.
On an Apple Silicon Mac, Docker Desktop can run the x86_64 image under emulation, but it's slower and not supported: wait for the ARM release.
Install
Create a folder and download the files
Open PowerShell (Windows) or Terminal (macOS):
mkdir $HOME\kumoyami; cd $HOME\kumoyami
curl.exe -fsSL https://kumoyami.com/install/docker-compose.yml -o docker-compose.yml
curl.exe -fsSL https://kumoyami.com/install/env.example -o .env
mkdir datosLog in to the private registry
Username: the lic_… ID. Password: the whole KY1.… key.
docker login registry.kumoyami.com -u lic_xxxxxxxxxxxxStart it
docker compose up -d
docker compose logs web # look for the «Código de configuración inicial» line (the setup code)Open http://localhost:4890/admin and follow the setup wizard.
Publishing folders from your computer
Add the volumes to the web service in docker-compose.yml and run docker compose up -d again. In the panel, use
the path on the right (/data/…):
volumes:
- ./datos:/app/datos
- C:/Users/your-user/Pictures:/data/photos:ro # Windows
# - /Users/your-user/Pictures:/data/photos:ro # macOSOn macOS, if Docker Desktop can't read the folder, check in its settings (Resources → File sharing) that the path is shared.
Opening it from other devices at home
docker-compose.yml only publishes KumoYami on 127.0.0.1, which means your own computer. To open it from your phone
or another machine on the network, change the ports line to "4890:3000" and run docker compose up -d; then go to
http://YOUR-COMPUTER-IP:4890. The Windows or macOS firewall may ask for permission the first time.
While your computer is off…
…so is KumoYami. Docker Desktop can start when you log in (it's in its settings) and the container comes back on its
own thanks to restart: unless-stopped, but the computer has to be on and awake.
One-click updates
Watchtower, the one-click updater, can't read the docker login session when Docker keeps it in the system's
credential store, as Docker Desktop does. Here, update with docker compose pull && docker compose up -d.