Skip to content

Tailscale

Private access to KumoYami from your devices, with no open ports and Tailscale's HTTPS.

With Tailscale, KumoYami joins your private Tailscale network: your devices with Tailscale reach it from anywhere, over HTTPS and with no open ports. Nobody else sees it. With Funnel you can open it to the internet too.

It's the option for you and your family. To share with people who don't have Tailscale, go for Caddy or the Cloudflare tunnel.

With the installer

Get Tailscale ready

At login.tailscale.com:

  1. DNS: turn on MagicDNS and HTTPS Certificates.
  2. Settings → Keys: create a reusable auth key (KumoYami uses two nodes: Files and the Library).

Run the installer

curl -fsSL https://kumoyami.com/install.sh | sudo bash

Under Access from outside home, pick Tailscale and paste the key. Unattended:

curl -fsSL https://kumoyami.com/install.sh | sudo KUMOYAMI_TS_AUTHKEY='tskey-auth-…' bash -s -- --yes --access tailscale

Set the addresses in the panel

They show up on your network as kumoyami (Files) and kumoyami-app (the Library). In System → Modules, type https://kumoyami-app.<your-tailnet>.ts.net for the Library and https://kumoyami.<your-tailnet>.ts.net for Files. Your tailnet's name is in the Tailscale console, under DNS.

Both nodes send their traffic to 4890, so until you save the addresses, both names show Files (an unsaved domain shows Files): the Library appears on kumoyami-app as soon as you save its address.

If you install Tailscale on the machine itself, instead of in these containers, your devices also reach each module's port, without HTTPS: see Without opening ports.

By hand

In .env, the key:

.env
TS_AUTHKEY=tskey-auth-…

Next to docker-compose.yml, the file tailscale/serve.json:

tailscale/serve.json
{
  "TCP": { "443": { "HTTPS": true } },
  "Web": { "${TS_CERT_DOMAIN}:443": { "Handlers": { "/": { "Proxy": "http://web:4890" } } } },
  "AllowFunnel": { "${TS_CERT_DOMAIN}:443": false }
}

Uncomment the tailscale (Files) and tailscale-app (the Library; drop it if you don't use it) services in docker-compose.yml and start:

docker compose up -d

Without the installer: Tailscale on the machine itself

If Tailscale is already installed on the machine (on a Synology, from Package Center), you need neither the containers nor two nodes. With MagicDNS and HTTPS Certificates on, one name is enough for both modules:

sudo tailscale serve --bg --https=443 http://localhost:4892    # Files
sudo tailscale serve --bg --https=8443 http://localhost:4891   # the Library

Files is at https://machine-name.<your-tailnet>.ts.net and the Library at the same name with :8443. KumoYami knows each module by its port, with nothing saved; save both addresses in System → Modules only so the launcher and the emails link to them. More in Without opening ports.

Home and away

Tailscale addresses (100.64.0.0/10) count as home for the Library: they play at home quality even when you're travelling. If you'd rather they count as away, remove them from the home networks in Library → Playback → Away from home and downloads ("Away from home" tab).

In the server code, these addresses show as "not reachable from the internet". That's expected: only your devices reach them.

Opening it to the internet with Funnel

  1. Set "AllowFunnel" to true in tailscale/serve.json (with the installer: --funnel). With Tailscale on the machine itself, change serve to funnel in the two commands above.
  2. In Tailscale's access policy, allow Funnel for those nodes (nodeAttrs with funnel).
  3. docker compose up -d --force-recreate tailscale tailscale-app.

Funnel has its own bandwidth limit: for lots of video away from home, opening 443 with Caddy is better.

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.