QNAP
KumoYami on a QNAP NAS with Container Station.
On a QNAP, KumoYami runs in Container Station, the container app for QTS and QuTS hero, which accepts Docker Compose files.
Which models work
You need a model that supports Container Station. Check your model's processor on its spec sheet: Intel and AMD (x86_64) models work today.
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.
QNAP models with an ARM processor will have to wait for that release.
Install
Prepare the folders
In File Station, create a folder for KumoYami, for example Container/kumoyami, with another one called datos
inside it. Note its full path on the NAS: it usually looks like /share/Container/kumoyami.
Log in to the private registry
Enable SSH in the Control Panel (Network Services → Telnet/SSH), connect as an administrator and run once:
docker login registry.kumoyami.com -u lic_xxxxxxxxxxxx # password: the whole KY1.… key
chown 1000:1000 /share/Container/kumoyami/datosThe second command makes the datos folder writable for the container's user (uid 1000). If Container Station has a
section for private registries in its settings, you can also add registry.kumoyami.com there with the same username
and password.
Create the application
In Container Station, look for the option to create an application from a Docker Compose YAML file (depending
on the version: Applications → Create, or Create → Create Application). Name it kumoyami and paste:
services:
web:
image: registry.kumoyami.com/kumoyami:latest
restart: unless-stopped
environment:
DATA_DIR: /app/datos
volumes:
- /share/Container/kumoyami/datos:/app/datos
# Shared folders you want to publish (:ro = read-only):
# - /share/Multimedia:/data/multimedia:ro
ports:
- "4890:3000"Create the application: Container Station will pull the image and start it.
Open the panel
Go to http://NAS-IP:4890/admin. The setup code the wizard asks for is in the container's logs (in Container
Station, open the container and its logs tab, and look for «Código») or over SSH:
docker logs kumoyami-web-1 2>&1 | grep -i códigoThe exact container name can differ; docker ps lists it. Carry on with
the setup wizard.
HTTPS
For a domain with HTTPS, the simplest option on a home NAS is Cloudflare Tunnel, which doesn't need any ports opened on your router. If you'd rather open ports 80 and 443, you can run Nginx Proxy Manager in another container. Some QTS versions also include their own reverse proxy (look for it in the Control Panel, under network or application settings).
Updating
Over SSH, pull the new image and recreate the container from Container Station (or, if your version keeps the YAML in
the application's folder, run docker compose pull && docker compose up -d there). More in
Updating.