Home Lab

Appearance

First steps ​

A fresh install starts empty. This walkthrough takes you from a blank dashboard to a service card with a live widget.

1. Add a page ​

Pages are the tabs in the left sidebar. Click Add page at the bottom of the sidebar, give it a name (e.g. Apps), pick an icon, and save.

Icons accept any of:

  • a built-in name like grid, server, film, cloud
  • sh-<name> for a selfh.st icon (e.g. sh-jellyfin)
  • si-<name> for a Simple Icons icon, optionally with a colour: si-traefikproxy-#24A1C1
  • a full image URL

See Pages & groups for everything pages can do.

2. Add a service ​

Click Add service in the top bar. Fill in:

  • Name and Description
  • URL - where the card links to
  • Icon - same icon rules as pages
  • Page → Group - where the card lands
  • (Optional) Container / Server - link the card to a Docker container so it shows live status

The card drops onto the page. You can drag it to reorder or move it between groups. Hover a card to reveal the star (pin to Dashboard) and pencil (edit) buttons.

3. Attach a widget ​

Still in the service dialog, choose a Widget type. A credentials box appears with exactly the fields that widget needs - a URL, API key, refresh interval and so on. Fill them in and save.

The card now shows live data. For example a qbittorrent widget shows download speed and active torrents; a proxmox widget shows CPU/RAM gauges.

Pick the type explicitly

The widget type you select is what decides which integration runs. Always choose it from the dropdown rather than relying on the service name.

Want more than one? A service card can hold up to three widgets, stacked. See Multiple widgets per service.

4. Pin favourites to the Dashboard ​

The built-in Dashboard page shows a Favourites row plus a live health section. Hover any card and tap the star to pin it. Drag favourites to reorder them. See The Dashboard.

5. Make it yours ​

What's next ​

Add monitoring

Wire up a health source (Beszel, Glances or the local host) to power the Dashboard's live gauges.

Install it as an app

Add Home Lab to your home screen or desktop - see Install as an app.

Back it up

Automatic daily backups are on by default. You can also export/restore manually - see Backups.