TrueNAS SCALE
KumoYami as a custom app on TrueNAS SCALE (Community Edition).
Recent TrueNAS SCALE versions (24.10 "Electric Eel" and later, now TrueNAS Community Edition) run apps on Docker and let you install a custom app from a Docker Compose YAML. Older versions used Kubernetes and don't support this.
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
Prepare a dataset
Create a dataset for KumoYami, for example tank/apps/kumoyami, with a datos folder inside. From the TrueNAS
Shell (System → Shell), hand the folder over to the container's user (uid 1000):
mkdir -p /mnt/tank/apps/kumoyami/datos
chown 1000:1000 /mnt/tank/apps/kumoyami/datosReplace tank with the name of your pool.
Give it access to the private registry
The image lives at registry.kumoyami.com and needs your license. In the Apps settings, look for the Docker
registries section (or registry credentials) and add one with:
- URI / server:
registry.kumoyami.com - Username: your license ID,
lic_… - Password: the whole
KY1.…key
Install the app from YAML
In Apps → Discover Apps, open the options menu and choose Install via YAML (or your version's equivalent).
Name: kumoyami. Paste:
services:
web:
image: registry.kumoyami.com/kumoyami:latest
restart: unless-stopped
environment:
DATA_DIR: /app/datos
volumes:
- /mnt/tank/apps/kumoyami/datos:/app/datos
# Datasets you want to publish (:ro = read-only):
# - /mnt/tank/photos:/data/photos:ro
ports:
- "4890:3000"Save: TrueNAS will pull the image and start the app.
Open the panel
Go to http://TRUENAS-IP:4890/admin. The wizard's setup code is in the app's logs (in Apps, open kumoyami and
check its logs; look for «Código»). Carry on with the setup wizard.
Can't find where the credentials go?
The TrueNAS interface changes between versions. What's needed is always the same: Docker must be able to log in to
registry.kumoyami.com with the lic_… username and the key as the password. If your version doesn't offer
registry credentials for apps, check its documentation or get in touch with us.
Permissions
KumoYami accesses mounted datasets as uid 1000. With :ro it only needs to be able to read them; to upload, rename or
delete, uid 1000 needs write access. Check the dataset's permissions (ACL).
HTTPS and updating
For a domain with HTTPS, use Cloudflare Tunnel or a reverse proxy such as
Nginx Proxy Manager, pointing at TRUENAS-IP:4890. To update, TrueNAS lets you
pull the app's image again from its Apps screen; see Updating.