Downloads
Download KumoYami. Run it anywhere.
KumoYami Server runs on your own hardware: your PC or Mac, a Linux server, your NAS or a Raspberry Pi. Pick where and we'll give you the download and the steps.
- Windows
- macOS
- Linux
- Ubuntu
- Debian
- Docker
- Synology
- QNAP
- Unraid
- TrueNAS
- Raspberry Pi
01Pick where you install it
02Your Windows
64-bit (x64)One download for Windows 10 (1809 or later) and Windows 11.
03Download and install
Windows 10 and 11 · 64-bit
KumoYami for Windows.
It installs like any program, without Docker or admin rights. Its icon sits next to the clock and KumoYami starts when you sign in.
KumoYami-Server-0.1.14-windows-x64.exe
Check the download (SHA-256)
84bf056ac3b5c720e3362057455fb5f4f2e4eb5d2576f4c51cf3aeb6b7d53dea- 01Open the installerIt isn't signed yet: the first time, Windows warns «Windows protected your PC». Click «More info», then «Run anyway».
- 02Install itFor your user, without asking for admin rights. When it's done, KumoYami opens in your browser at http://localhost:4890.
- 03Open the panelThe wizard asks for a code: you'll find it under «Registros» (logs), in the menu of KumoYami's icon next to the clock.
- 04Link it to your accountWith the code the panel gives you, at kumoyami.com/activate, or by pasting your key.
Rather use Docker? It runs on Docker Desktop too: the Windows and macOS guide.
02Your Mac's processor
Not sure? Apple menu → About This Mac: «Chip Apple M…» is Apple silicon; «Processor Intel…», Intel.
03Download and install
macOS 13.5 or later · Apple silicon
KumoYami for Mac.
An app you drag into Applications. It runs in the background, with no Dock icon, and starts on its own when you log in.
KumoYami-Server-0.1.13-macos-arm64.dmgor the app in a .zip (135.5 MB)
Check the download (SHA-256)
28466078ee3a4cc54461e8d65a8bd0653f62630cbce9e31c71a09dccb81d97df- 01Open it and drag itOpen the .dmg and drag KumoYami Server into the Applications folder. Always open it from there.
- 02The first timeThe app isn't signed by Apple yet: right-click (or Control-click) KumoYami Server → Open, then Open again. If that option isn't there, go to System Settings → Privacy & Security and click «Open Anyway».
- 03Open the panelKumoYami opens in your browser at http://localhost:4890. The wizard asks for a code and tells you where to find it.
- 04Link it to your accountWith the code the panel gives you, at kumoyami.com/activate, or by pasting your key.
Rather use Docker? It runs on Docker Desktop too: the Windows and macOS guide.
macOS 13.5 or later · Intel
KumoYami for Mac.
An app you drag into Applications. It runs in the background, with no Dock icon, and starts on its own when you log in.
KumoYami-Server-0.1.13-macos-x64.dmgor the app in a .zip (141.6 MB)
Check the download (SHA-256)
080cee43c9f2f24b70cef57dbdce6acc8af9c78e7a5a51d69bab57f4bb167eeb- 01Open it and drag itOpen the .dmg and drag KumoYami Server into the Applications folder. Always open it from there.
- 02The first timeThe app isn't signed by Apple yet: right-click (or Control-click) KumoYami Server → Open, then Open again. If that option isn't there, go to System Settings → Privacy & Security and click «Open Anyway».
- 03Open the panelKumoYami opens in your browser at http://localhost:4890. The wizard asks for a code and tells you where to find it.
- 04Link it to your accountWith the code the panel gives you, at kumoyami.com/activate, or by pasting your key.
Rather use Docker? It runs on Docker Desktop too: the Windows and macOS guide.
02How you install it
The .deb and the .tar.gz are for 64-bit Intel or AMD processors (x86_64) and don't use Docker: they carry everything KumoYami needs, ffmpeg and the GPU drivers too.
03Install it
Linux · x86_64 and arm64
One command on your server.
On a VPS or a Linux server, as root. The installer sets everything up and only asks for what it needs.
Run on your server
$ curl -fsSL https://kumoyami.com/install.sh | sudo bash- 01Checks the system and installs Docker if needed.
- 02Sets up HTTPS with Caddy if you give it a domain.
- 03Starts KumoYami and shows you the code to get into /admin.
Linux · .deb · x86_64
The package for Debian and Ubuntu.
KumoYami installed straight into the system, without Docker, as a systemd service that starts with the machine.
kumoyami_0.1.13_amd64.deb
Check the download (SHA-256)
59540f259042222f209bb72f58914fb6cce0fa74ec26cdc558bbe443b467d7cb- 01Install itFrom the folder you downloaded it to:
$ sudo apt install ./kumoyami_0.1.13_amd64.deb - 02It's runningThe package creates the kumoyami user and the kumoyami service, which starts now and at every boot. It listens on 4890 (the launcher and the panel), 4891 (the Library) and 4892 (Files).
- 03Open the panelAt http://MACHINE-IP:4890/admin. The code the wizard asks for is in the service's log:
$ sudo journalctl -u kumoyami | grep -i código
The settings (port, address) are in /etc/default/kumoyami and the data in /var/lib/kumoyami. To update, install the newer .deb the same way. The kumoyami user needs read access to the folders you share.
Full guide: LinuxLinux · .tar.gz · x86_64
The archive for other distributions.
The same as the .deb, in an archive: for distributions without apt, or to try it without installing anything.
kumoyami-0.1.13-linux-x64.tar.gz
Check the download (SHA-256)
5228a41fecf936fc2e0a91c70457f3de47ee9077da76c0561e9fba56ecedaea2- 01Unpack it to /optIt creates /opt/kumoyami with everything inside:
$ sudo tar -xzf kumoyami-0.1.13-linux-x64.tar.gz -C /opt - 02Start itIn the foreground: Ctrl+C stops it, and the data goes to ~/.local/share/kumoyami. Open http://MACHINE-IP:4890/admin; the wizard's code shows in the terminal.
$ /opt/kumoyami/kumoyami-server - 03Keep it as a serviceThe archive carries kumoyami.service and kumoyami.default for systemd. The steps are in /opt/kumoyami/README.md.
Linux · Docker Compose
Docker Compose, step by step.
What the script does, by hand: for whoever already has Docker and their own reverse proxy.
- 01Download the filesInto a folder for KumoYami, such as /opt/kumoyami:
$ sudo mkdir -p /opt/kumoyami && cd /opt/kumoyami sudo curl -fsSL https://kumoyami.com/install/docker-compose.yml -o docker-compose.yml sudo curl -fsSL https://kumoyami.com/install/env.example -o .env - 02Start itFrom that folder. The image is public: it downloads without logging in.
$ sudo docker compose up -d - 03Follow the guideKumoYami only listens on 127.0.0.1, on 4890 (the launcher and the panel), 4891 (the Library) and 4892 (Files): the guide explains how to put it on your domain, the folders and the updates.
02Brand
Pick your NAS's brand and we'll tell you how to install it.
03
Synology · Package Center · Native package · x86_64
The native package for DSM.
KumoYami Server, installed straight into DSM, without Container Manager. It converts video with the Intel GPU (VA-API) on the models that have one. A wizard asks for the data folder, the folders to share and the port.
kumoyami-0.1.14-x86_64.spkNeeds DSM 7.2 or later
Check the download (SHA-256)
5e2652b723ba91584bf3b8bdf26805116465547b95827708e17ade8a93c7fab8- 01Install it manuallyIn DSM, open Package Center → Manual Install and pick the .spk file. DSM warns that the package isn't from Synology: accept to go on.
- 02Follow the wizardPick the folder for the data, the shared folders KumoYami will share and the port.
- 03Open itFrom DSM's main menu, or with «Open» in Package Center. KumoYami's wizard asks for a code and tells you where to find it.
- 04Link it to your accountWith the code the panel gives you, at kumoyami.com/activate, or by pasting your key.
Get the updates in Package Center
Add KumoYami's package source: Package Center will list KumoYami Server and each new version, ready to update.
- 01Add the sourcePackage Center → Settings → Package Sources → Add.
- 02Name and locationName: KumoYami. Location:
https://kumoyami.com/synology - 03Trust levelIn Settings → General, under «Trust Level», allow «Synology Inc. and trusted publishers» or «Any publisher». Unsigned third-party packages need «Any publisher».
Synology · Package Center · Native package · armv8
The native package for DSM, in beta.
KumoYami Server, installed straight into DSM, without Container Manager. On ARM it converts video with the processor only; at least 1 GB of RAM is recommended. It's a beta: we haven't tried it on a real ARM NAS yet.
kumoyami-0.1.14-armv8.spkNeeds DSM 7.2 or later
Check the download (SHA-256)
01268e277157191c8f45323aefd28b0257daa6e27f93f3f1249906e73df83d77- 01Install it manuallyIn DSM, open Package Center → Manual Install and pick the .spk file. DSM warns that the package isn't from Synology: accept to go on.
- 02Follow the wizardPick the folder for the data, the shared folders KumoYami will share and the port.
- 03Open itFrom DSM's main menu, or with «Open» in Package Center. KumoYami's wizard asks for a code and tells you where to find it.
- 04Link it to your accountWith the code the panel gives you, at kumoyami.com/activate, or by pasting your key.
Get the updates in Package Center
Add KumoYami's package source: Package Center will list KumoYami Server and each new version, ready to update.
- 01Add the sourcePackage Center → Settings → Package Sources → Add.
- 02Name and locationName: KumoYami. Location:
https://kumoyami.com/synology - 03Trust levelIn Settings → General, under «Trust Level», allow «Synology Inc. and trusted publishers» or «Any publisher». Unsigned third-party packages need «Any publisher».
Synology · Container Manager
In Container Manager, with Docker Compose
Container Manager pulls the image, starts it and keeps it running. Four steps from DSM.
- 01Prepare the foldersIn File Station, inside the docker shared folder, create kumoyami and, inside it, another one called datos.
- 02Give datos its permissionsJust once, as root: with a Task Scheduler task (user root, no SSH) or over SSH with sudo.
$ sudo chown 1000:1000 /volume1/docker/kumoyami/datos - 03Create the projectContainer Manager → Project → Create: name kumoyami, path docker/kumoyami and this docker-compose.yml. The image is public: it downloads without logging in.
services: web: image: registry.kumoyami.com/kumoyami:latest restart: unless-stopped environment: DATA_DIR: /app/datos PORT: "4890" volumes: - /volume1/docker/kumoyami/datos:/app/datos # Shared folders you want to publish (:ro = read-only): # - /volume1/fotos:/data/fotos:ro ports: # 4890: the launcher and the panel; 4891: the Library; 4892: Files - "4890-4892:4890-4892" - 04Open the panelAt http://NAS-IP:4890/admin. The code the wizard asks for is in the container's log (look for «Código»). That's where you link the server to your account.
Synology · Container Manager
In Container Manager, with Docker Compose
Container Manager pulls the image, starts it and keeps it running. Four steps from DSM.
- 01Prepare the foldersIn File Station, inside the docker shared folder, create kumoyami and, inside it, another one called datos.
- 02Give datos its permissionsJust once, as root: with a Task Scheduler task (user root, no SSH) or over SSH with sudo.
$ sudo chown 1000:1000 /volume1/docker/kumoyami/datos - 03Create the projectContainer Manager → Project → Create: name kumoyami, path docker/kumoyami and this docker-compose.yml. The image is public: it downloads without logging in.
services: web: image: registry.kumoyami.com/kumoyami:latest restart: unless-stopped environment: DATA_DIR: /app/datos PORT: "4890" volumes: - /volume1/docker/kumoyami/datos:/app/datos # Shared folders you want to publish (:ro = read-only): # - /volume1/fotos:/data/fotos:ro ports: # 4890: the launcher and the panel; 4891: the Library; 4892: Files - "4890-4892:4890-4892" - 04Open the panelAt http://NAS-IP:4890/admin. The code the wizard asks for is in the container's log (look for «Código»). That's where you link the server to your account.
On DSM 7.1 or earlier, update first
KumoYami installs in Container Manager, which came with DSM 7.2. Update DSM in Control Panel → Update & Restore, if your model allows it, and pick again. If your model can't get DSM 7.2, install KumoYami on another machine.
QNAP · Container Station
In Container Station, with Docker Compose
Container Station creates an application from KumoYami's docker-compose.yml and keeps it running.
- 01Prepare the foldersIn File Station, create Container/kumoyami and, inside it, another one called datos.
- 02Give datos its permissionsTurn on SSH (Control Panel → Telnet/SSH), log in as an admin and run once:
$ chown 1000:1000 /share/Container/kumoyami/datos - 03Create the applicationIn Container Station, create an application with this YAML and call it kumoyami. The image is public: it downloads without logging in.
services: web: image: registry.kumoyami.com/kumoyami:latest restart: unless-stopped environment: DATA_DIR: /app/datos PORT: "4890" volumes: - /share/Container/kumoyami/datos:/app/datos # Shared folders you want to publish (:ro = read-only): # - /share/Multimedia:/data/multimedia:ro ports: # 4890: the launcher and the panel; 4891: the Library; 4892: Files - "4890-4892:4890-4892" - 04Open the panelAt http://NAS-IP:4890/admin. The code the wizard asks for is in the container's log (look for «Código»). That's where you link the server to your account.
On QTS 4 or earlier, update first
KumoYami needs the Container Station of QTS 5 or QuTS hero h5. Update the firmware in Control Panel → System → Firmware Update, if your model allows it, and pick again. If it doesn't, install KumoYami on another machine.
Unraid · Template
The Unraid template
KumoYami installs like any container in the Docker tab, with its form for port, data, folders and GPU. First, two commands in Unraid's terminal.
my-KumoYami.xml
Check the download (SHA-256)
780f65081e785d29813d7238d82fd817ac87d975dab18169b89a71134dccbdda- 01Prepare the data folderIn Unraid's terminal (the >_ icon at the top), just once. The image is public: no need to log in.
$ mkdir -p /mnt/user/appdata/kumoyami && chown 99:100 /mnt/user/appdata/kumoyami - 02Copy the templateWith this command in the same terminal, or download it and copy it to that folder on the USB drive.
$ wget -O /boot/config/plugins/dockerMan/templates-user/my-KumoYami.xml https://kumoyami.com/unraid/kumoyami.xml - 03Create the containerDocker → Add Container → Template: KumoYami. Check the port, the data and your content folders, and press Apply.
- 04Open itWith WebUI on KumoYami's icon, or at http://UNRAID-IP:4890/admin.
On Unraid 6.11 or earlier, update first
KumoYami's template is for Unraid 6.12 and later. Update in Tools → Update OS and pick again.
TrueNAS SCALE · Custom app
As a TrueNAS app, from its YAML
TrueNAS SCALE 24.10 and later install apps from a Docker Compose YAML, with a dataset for the data.
- 01Prepare a datasetCreate one for KumoYami (for example tank/apps/kumoyami) and, from System → Shell, its datos folder:
$ mkdir -p /mnt/tank/apps/kumoyami/datos && chown 1000:1000 /mnt/tank/apps/kumoyami/datos - 02Install the appApps → Discover Apps → menu → Install via YAML. Name: kumoyami. Paste this YAML, changing tank to your pool.
services: web: image: registry.kumoyami.com/kumoyami:latest restart: unless-stopped environment: DATA_DIR: /app/datos PORT: "4890" volumes: - /mnt/tank/apps/kumoyami/datos:/app/datos # Shared folders you want to publish (:ro = read-only): # - /mnt/tank/fotos:/data/fotos:ro ports: # 4890: the launcher and the panel; 4891: the Library; 4892: Files - "4890-4892:4890-4892" - 03Open the panelAt http://TRUENAS-IP:4890/admin. The code the wizard asks for is in the app's logs (look for «Código»). That's where you link the server to your account.
On SCALE 24.04 or earlier, update first
Up to 24.04, TrueNAS SCALE used Kubernetes for apps and takes no Docker Compose YAML. Update to 24.10 «Electric Eel» or later in System → Update and pick again.
TrueNAS CORE can't run KumoYami
CORE is based on FreeBSD and has no Docker. You can move to TrueNAS SCALE (Community Edition) keeping your pools, or install KumoYami in a Linux virtual machine or on another machine.
Asustor · Docker Engine and Portainer
With Docker Compose, from Portainer
On ADM, KumoYami runs in Docker Engine; Portainer lets you paste its docker-compose.yml without typing commands.
- 01Install DockerFrom App Central, install Docker Engine and Portainer CE.
- 02Prepare the folderCreate kumoyami/datos, for example in the Docker shared folder, and give it its permissions over SSH, as root:
$ mkdir -p /volume1/Docker/kumoyami/datos && chown 1000:1000 /volume1/Docker/kumoyami/datos - 03Create the stackIn Portainer → Stacks → Add stack: name kumoyami, paste this docker-compose.yml with your paths and press Deploy.
services: web: image: registry.kumoyami.com/kumoyami:latest restart: unless-stopped environment: DATA_DIR: /app/datos PORT: "4890" volumes: - /volume1/Docker/kumoyami/datos:/app/datos # Shared folders you want to publish (:ro = read-only): # - /volume1/Media:/data/media:ro ports: # 4890: the launcher and the panel; 4891: the Library; 4892: Files - "4890-4892:4890-4892" - 04Open the panelAt http://NAS-IP:4890/admin. The code the wizard asks for is in the container's logs (look for «Código»). That's where you link the server to your account.
On ADM 3 or earlier, update first
KumoYami needs ADM 4's Docker Engine. Update ADM from its settings (ADM Update), if your model allows it, and pick again. If it doesn't, install KumoYami on another machine.
Any NAS with Docker
With Docker Compose
If your NAS has Docker with Docker Compose, or a container app that takes its YAML, KumoYami installs as on any server.
- 01Download the filesSave them in a new folder on the NAS, rename env.example to .env and create a datos folder next to them, writable for uid 1000.docker-compose.ymlenv.example
- 02Start itFrom that folder, over SSH. Or paste the docker-compose.yml into your NAS's container app. The image is public: it downloads without logging in.
$ docker compose up -d - 03Open the panelAt http://NAS-IP:4890/admin. The code the wizard asks for is in the container's logs. That's where you link the server to your account.
NAS with a 32-bit ARM processor can't run KumoYami
KumoYami needs a 64-bit processor: Intel or AMD (x86_64) or 64-bit ARM (arm64). There's no 32-bit ARM build. You can install it on a Raspberry Pi 4 or 5 with a 64-bit system, or on any Linux server.
02Your system
64-bit (arm64)A Raspberry Pi 4 or 5, or an ARM server, with a 64-bit system.
03Install it
arm64 · Raspberry Pi 4 and 5 · ARM servers and NAS
On a Raspberry Pi or an ARM server.
The image is multi-platform: Docker pulls the arm64 build on its own. On a Raspberry Pi or an ARM VPS, the installer is the same as on any Linux.
Run on your server
$ curl -fsSL https://kumoyami.com/install.sh | sudo bashRun uname -m to check the system is 64-bit: it should say aarch64. 32-bit ARM systems won't work.
The other steps are the same as on any Linux: Quick install.
KumoYami Library
Your KumoYami films, series and photos, with their covers and details, on your phone, tablet and TV. It connects to your own server.
- Android
- iPhone and iPad
- Android TV
It isn't in the stores yet. When it's out, it'll show up here and in the changelog.
In the meantime, your KumoYami site already works in your phone browser, and reaches the TV with Chromecast or AirPlay.
Install KumoYami ServerKumoYami Files
Your KumoYami folders on your phone: browse, open and share your files from your own server.
- Android
- iPhone and iPad
It isn't in the stores yet. When it's out, it'll show up here and in the changelog.
In the meantime, your KumoYami site already works in your phone browser, and reaches the TV with Chromecast or AirPlay.
Install KumoYami ServerAll trademarks and logos belong to their respective owners. Their use only indicates compatibility, not sponsorship or affiliation.