Unraid
KumoYami on Unraid, with the Compose Manager plugin or from the terminal.
Unraid ships with Docker. Since KumoYami comes as a Docker Compose project, the most comfortable route is the Docker Compose Manager plugin from Community Applications, which adds Compose and lets you manage it from the Docker tab.
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.
Install
Install Compose Manager
In Apps (Community Applications), search for Docker Compose Manager and install it.
Prepare the folders and log in to the registry
Open the Unraid terminal (the >_ icon in the top bar) and run:
mkdir -p /mnt/user/appdata/kumoyami/datos
chown 1000:1000 /mnt/user/appdata/kumoyami/datos
docker login registry.kumoyami.com -u lic_xxxxxxxxxxxx # password: the whole KY1.… keyKumoYami's container runs as uid 1000 (not as nobody:users like many Unraid apps), which is why the datos folder
has to belong to it.
Create the stack
In the Docker tab, in the Compose section, add a new stack called kumoyami, edit its Compose file and paste:
services:
web:
image: registry.kumoyami.com/kumoyami:latest
restart: unless-stopped
environment:
DATA_DIR: /app/datos
volumes:
- /mnt/user/appdata/kumoyami/datos:/app/datos
# Shares you want to publish (:ro = read-only):
# - /mnt/user/Photos:/data/photos:ro
ports:
- "4890:3000"Save and click Compose Up.
Open the panel
Go to http://UNRAID-IP:4890/admin. To see the setup code, in the terminal:
docker logs kumoyami-web-1 2>&1 | grep -i códigoCarry on with the setup wizard.
Share permissions
KumoYami reads your shares as uid 1000. Unraid shares are usually readable by every user, so with :ro it just works.
If you want KumoYami to upload, rename or delete in a share, mount the volume without :ro and make sure uid 1000 can
write to that folder.
HTTPS
If you already run a reverse proxy on Unraid (Nginx Proxy Manager, SWAG, Traefik…), add an entry pointing at
UNRAID-IP:4890. If not, Cloudflare Tunnel saves you opening ports on your
router. More options in Domain and HTTPS.
Updating
In the Compose section of the Docker tab, use Update Stack (or Compose Pull followed by Compose Up), or in
the terminal, in the stack's folder, docker compose pull && docker compose up -d. More in
Updating.