Synology

Prepare the foldersCopy Anchor Link

In File Station, create a folder for KumoYami inside the docker shared folder (Container Manager creates it when it's installed), for example docker/kumoyami, and inside that another one called datos.

Log in to the registry and download the imageCopy Anchor Link

KumoYami's image lives in a private registry. On a Synology, that login has to be done by root:

• Container Manager's Registry tab doesn't work with private token-based registries like this one: it says it can't connect, and the project then fails with unauthorized. Don't use it.
• docker login stores the session in the home folder of whoever runs it. A login over SSH as your user without sudo is no use to root; with sudo, or in a task run as root, it lands in /root/.docker/config.json, which is the one that counts.

Without SSH, with a root task: Control Panel → Task Scheduler → Create → Scheduled Task → User-defined script. Under General, user root; under Task Settings, this script with your license ID and key:

echo 'KY1.YOUR-WHOLE-KEY' | /usr/local/bin/docker login registry.kumoyami.com -u lic_xxxxxxxxxxxx --password-stdin
/usr/local/bin/docker pull registry.kumoyami.com/kumoyami:latest
chown 1000:1000 /volume1/docker/kumoyami/datos

Save it, select it and click Run. When it finishes (the download takes a few minutes), delete the task: your key is written in it.

With SSH (enable it in Control Panel → Terminal & SNMP and connect as an administrator), the same with sudo:

sudo docker login registry.kumoyami.com -u lic_xxxxxxxxxxxx    # password: the whole KY1.… key
sudo docker pull registry.kumoyami.com/kumoyami:latest
sudo chown 1000:1000 /volume1/docker/kumoyami/datos

The chown makes the datos folder writable for the container's user (uid 1000). Change volume1 if your docker folder lives on another volume.

Create the projectCopy Anchor Link

In Container Manager → Project → Create:

• Project name: kumoyami.
• Path: the docker/kumoyami folder.
• Source: create a docker-compose.yml and paste this in (the self-contained version, with the NAS's paths):

services:
  web:
    image: registry.kumoyami.com/kumoyami:latest
    restart: unless-stopped
    environment:
      DATA_DIR: /app/datos
    volumes:
      - /volume1/docker/kumoyami/datos:/app/datos
      # Shared folders you want to publish (:ro = read-only):
      # - /volume1/photo:/data/photos:ro
    ports:
      - "4890:3000"

If the wizard offers to set up a web portal (Web Station), you can skip it. Since the image is already downloaded, the project starts with it without having to log in to the registry.

Over SSH works too, always with sudo and from the project folder (it still shows up in Container Manager afterwards, to see the logs, stop and start it):

cd /volume1/docker/kumoyami
sudo docker compose up -d

Open the panelCopy Anchor Link

Go to http://NAS-IP:4890/admin. The wizard asks for the setup code: you'll find it in the container's logs (Container Manager → Container → kumoyami-web-1 → Log, look for «Código») or over SSH:

sudo docker logs kumoyami-web-1 2>&1 | grep -i código

Carry on with the setup wizard.