Managing YAMS¶
Once setup is done, the YAMS dashboard becomes the control panel for the whole stack (the equivalent of the yams command-line tool):
| YAMS CLI | On Umbrel |
|---|---|
yams check-vpn |
VPN check compares your home address with the one downloads use, and confirms qBittorrent is inside the VPN |
yams logs |
Logs on every app, live-updating, with errors highlighted and a Copy button |
yams restart |
Restart on every app, or Restart all (the VPN is restarted before qBittorrent so it reconnects cleanly) |
yams backup |
Backups: back up on demand or automatically (daily or weekly, keeping the last 3, 5 or 10), and Restore any backup with one click |
yams update |
Update apps checks Docker Hub and updates every app to its newest version with one click, or automatically each week. It backs up your settings first |
Two widgets are available for the Umbrel home screen: a stats card (VPN, downloads, shows, movies) and a live list of active downloads. Right-click the home screen and choose Edit widgets to add them.
Backups work like yams backup: apps pause for a moment so their databases are saved cleanly, then every app's settings and history, your logins and API keys, and your VPN file go into one .tar.gz in Downloads → yams-backups. Caches, logs and cover art are left out (they rebuild themselves), and your media files are never included. Automatic backups run between 3 and 5 AM, Umbrel's clock.
Restoring checks the file first: it must be a YAMS for Umbrel backup that contains nothing but app settings, or it's refused before anything stops. YAMS then saves a safety backup of your current setup, swaps the restored settings in and starts the apps. If anything fails part-way, the previous settings are put back. You can restore on a fresh install too: install YAMS, upload your backup (or copy it into Downloads → yams-backups with the Files app) and choose Restore.
Backups contain your passwords and VPN key, so keep copies somewhere private.
Quick fixes repair the most common problems with one click: connect Prowlarr to Sonarr and Radarr, connect qBittorrent to them, fix library folders, rescan Jellyfin, search for missing episodes and movies, and reconnect the VPN. Fix everything runs the first three. Each fix checks first and only changes what's wrong. YAMS also re-checks the Prowlarr and qBittorrent connections every 10 minutes by itself.
Search through the VPN. If your internet provider blocks indexer sites, switch on Search through the VPN under VPN check. Prowlarr's searches and FlareSolverr then go out through the VPN too, the same idea as YAMS's Prowlarr behind VPN guide but with no compose editing. They use the VPN container's built-in proxy rather than its network, so Prowlarr still reaches Sonarr and Radarr directly. If the VPN drops, searches pause instead of going around it.
Two kinds of updates. App updates (new Sonarr, Jellyfin and so on) happen from the YAMS dashboard whenever you like. The apps use moving tags such as latest, so YAMS can check Docker Hub, download new images and swap each container for a new one with identical settings. It backs up your settings first and rolls back any app that won't start. YAMS updates (new dashboard features and fixes) arrive through Umbrel's own Update button when a new version is published here.
Security. The media apps sit on a private network other Umbrel apps can't reach, and every web page is behind your Umbrel login. The dashboard's controls are only reachable through the router, never the network. Your password is hidden until you press Show, and Change password updates every app at once. See SECURITY.md for details and how to report a problem privately.
Docker access. The dashboard mounts the Docker socket so it can read logs, restart containers and update apps, the same approach Umbrel's Portainer and Dozzle apps use. It only ever acts on containers that belong to the YAMS app (by their Docker Compose project label), and can't restart itself.