Synology (DSM)
Your domain in front of KumoYami on DSM 7.2, with DSM's DDNS, Let's Encrypt certificate and reverse proxy.
DSM comes with everything you need: DDNS, Let's Encrypt certificates and a reverse proxy. You don't need Caddy or Nginx. It works the same for the native package and for Container Manager.
Menus are named as DSM shows them in English. In the example, the Library is on app.yourdomain.com and Files on
drive.yourdomain.com.
If your ISP won't let you open ports
Behind CG-NAT or a locked-down ISP router, this way doesn't work: use a Cloudflare tunnel or Tailscale.
A name for your NAS
In your DNS provider's panel, create two type A records with your home's public IP: app and drive. Your public
IP shows at ifconfig.me or on your router.
If that IP changes, point both records with a CNAME at a DDNS name (Synology's, in the other tab), which keeps itself
up to date.
Forward 443 on the router
On the router, under port forwarding (also called NAT or virtual server, depending on the brand), send TCP port 443 to the NAS's local IP, on 443. With your own domain, forward 80 too: Let's Encrypt uses it to check the domain is yours, when getting the certificate and every time DSM renews it.
- Give the NAS a fixed IP on the router (a DHCP reservation), so the rule doesn't end up pointing at another device.
- If DSM's firewall is on (Control Panel → Security → Firewall), allow 443 and 80.
- Don't forward 4890, 4891 or 4892, nor DSM's own ports (5000 and 5001).
Get the certificate
Control Panel → Security → Certificate → Add:
- Add a new certificate and Get a certificate from Let's Encrypt.
- Domain name:
drive.yourdomain.com. Email: yours. - Subject Alternative Name:
app.yourdomain.com. That way one certificate covers both addresses.
With Synology DDNS, if DSM offers a wildcard certificate (*.yourname.synology.me), it covers every subdomain.
Create the reverse proxy rule
Control Panel → Login Portal → Advanced → Reverse Proxy → Create.
Under General, give it a name you'll recognise, like KumoYami Files, and:
- Source: protocol
HTTPS, hostnamedrive.yourdomain.com, port443. - Destination: protocol
HTTP, hostnamelocalhost, port4890.
Under Custom Header, click Create → WebSocket. DSM adds two headers, Upgrade and Connection: without them,
KumoYami shows connection errors.
Save and create an identical rule for app.yourdomain.com, also to localhost:4890. One rule per address: both go
to the same port, and KumoYami knows which module to serve by the name.
Assign the certificate to each rule
Control Panel → Security → Certificate → Settings. The list shows DSM's services and one line per reverse proxy
rule: for drive.yourdomain.com and app.yourdomain.com, pick the certificate from step 3 and click OK.
Save the addresses in KumoYami
Open the panel, http://NAS-IP:4890/admin. In System → Modules, type each module's address:
https://app.yourdomain.com for the Library and https://drive.yourdomain.com for Files. Save both.
On your phone's mobile data, open https://drive.yourdomain.com: it should show Files, with the padlock.
At home, without a domain
On your network, each part has its own port, with no proxy in between:
http://NAS-IP:4890: the launcher and the panel (/admin).http://NAS-IP:4891: the Library.http://NAS-IP:4892: Files.
With the native package, all three are already open. With Container Manager, publish all three in the project's
docker-compose.yml: stop the project, change the ports line in its YAML configuration and start it again (or, over
SSH, sudo docker compose up -d in its folder):
ports:
- "4890-4892:4890-4892"If DSM's firewall is on, allow 4890, 4891 and 4892 from your local network. The native package already declares all three to DSM: when you create the rule, choose Select from a list of built-in applications and tick KumoYami Server. With Container Manager, type the ports in by hand.
If something goes wrong
502 Bad Gateway
DSM can't reach KumoYami. Check it's running (Package Center → KumoYami Server, or the project in Container
Manager) and that the rule's destination is HTTP, localhost, 4890. With Container Manager, docker-compose.yml
has to publish 4890.
WebSocket errors or "connection lost"
The rule is missing the WebSocket header. Reverse Proxy → the rule → Edit → Custom Header → Create → WebSocket, on each of the two rules.
Certificate error
- The browser warns that the connection isn't private: the certificate isn't assigned to the rule (DSM serves the default one) or doesn't include that name. Check Security → Certificate → Settings.
- Let's Encrypt won't issue the certificate: DNS doesn't point at your IP yet or port 80 doesn't reach the NAS. Check the router rule and DSM's firewall, and give DNS a few minutes to propagate.
The launcher, the other module or "nothing published" shows up
- Files on the Library's address: an unsaved address shows Files. Save the Library's in System → Modules,
exactly as in the browser (with
https://, no straywwwand no trailing slash). - The launcher: you're coming in by the NAS's IP, by its name on your network or by an address with a port
(
:4890) that isn't saved. - "Nothing published": that module is turned off in System → Modules.
Every case, in How KumoYami picks the module.
Works from outside, not from home
Many routers won't let you reach your own domain from inside your network (NAT loopback). At home, use
http://NAS-IP:4891 and :4892, or set up a local DNS on your network that gives the NAS's IP for your two names.
Next steps
- Your own domain: the three ports and how KumoYami picks the module.
- The server code: your accounts get there with a short code.
- Synology: installing, updating and moving between the package and Container Manager.
All trademarks and logos belong to their respective owners. Their use only indicates compatibility, not sponsorship or affiliation. The Synology logo is a trademark of Synology Inc.; Google Drive, Google Cast and Android are trademarks of Google LLC, and the Android robot is reproduced from work created and shared by Google, used under the Creative Commons Attribution 3.0 license. Microsoft, Windows and OneDrive are trademarks of the Microsoft group of companies; Amazon S3 is a trademark of Amazon.com, Inc. or its affiliates; Apple, AirPlay, macOS and iPhone are trademarks of Apple Inc.; Raspberry Pi is a trademark of Raspberry Pi Ltd; Ubuntu is a trademark of Canonical Ltd.; Debian is a trademark of Software in the Public Interest, Inc.; Linux is a trademark of Linus Torvalds. This product uses the TMDB API but is not endorsed or certified by TMDB.