Valet

Name: valet
Author: askvalet

Talk to your homelab.

A self-hosted, open-source, AI-native homepage.

Live demo · Docs · Quick start · Changelog

_{▶ Watch the film · or try the demo, right in your browser}

Why Valet

Valet is a homepage for your homelab that can also do things.

The front door to your homelab

Instead of opening five different tabs to work out what's going on, just open Valet.
It shows what's happening across all your services, and you can act on it right there. Instead of just being a page with
links and a status dot, Valet is meant to be powerful and actionable.

Valet's main screen: the greeting at the top left with a one-line summary of what's wrong and what's playing, an ask box, every service's status, then the 3D house, the PC and a week of the calendar side by side

AI-native, if you want it

Ask Valet anything about your homelab. Use a local model or a hosted one. Valet knows
its own documentation, so you can use it to build itself! Anything it changes waits for your approval, and Valet
works just fine with the AI switched off.

Asking who's watching shows the now-playing card, asking what to watch shows the most-watched list with posters, and pausing Pi-hole waits for approval, then shows its chart

_{"Who's watching?" "What should we watch tonight?" Then "Pause Pi-hole", which waits for your approval.}

Asking for an internet speed card: Valet asks first, then the card appears on the page

_{"Add an internet speed card." Valet edits its own config, after asking first.}

Asking Valet to say when Oppenheimer finishes downloading: it asks first, then a notice arrives on the page when the download is done
_{"Tell me when Oppenheimer finishes downloading." Set once in plain words, and the notice comes when it's done.}

Updates in real time

Everything on the page is live. Progress bars move, numbers tick over, and new things appear as they happen, with no refreshing. Hover anything in the top bar for its details: what's playing, a download, the CPU or the weather.

The top bar: hovering a meeting, what's playing, a download, the CPU, memory, the network, the weather and the calendar opens each one's live details

Wall display mode

Open /wall on a tablet or a spare monitor for a page made to be read from across the room. The wall is its own page: you
pick exactly which cards it shows, several pages can take turns, and it dims at night. Nothing on it can be pressed, and
chat never shows.

The wall display: a large clock, the date and the weather, with every service's status below
The wall display's House page: the cameras, the thermostat, who's home, the doors, the energy and the weather
_{Two wall pages taking turns: the services, then the house.}

Made to be enjoyed

Live cards, real artwork, smooth animations and 3D models. It's a page
you'll want to look at and use.

The 3D floor plan: picking the living room, turning its lights blue, and sending the vacuum, which drives through the house
_{Pick a room, change its lights, and send the vacuum, which drives through the house.}

The year in review, full screen: the race of what was watched most, the house the vacuum cleaned, the ads blocked and the uptime, one screen at a time
_{Your year in review, told from your services' own numbers.}

Flexible, and light

One YAML file controls everything, with 185 integrations and a simple way to add your own. It
runs as one Node process, uses about 45 MB of RAM on a fresh install, and the image is 165 MB.
Add it to your phone's Home Screen and it's an app, with its own notifications.

Editing config.yaml while Valet runs, ten times over: the greeting, the wallpaper, liquid glass, light mode, the greeting's place, a labelled dock at the bottom, two columns, the full services list, no ask box and a serif font, each on the page as soon as the line is saved

Security first

Valet is read-only until you turn on sign-in or tell it your network is private. Your API keys stay on the server, so
neither the browser nor the AI ever sees them, and the assistant only gets the access you give it, one integration at a
time. Anything the assistant changes asks first. It runs on your own hardware, with no account and no telemetry. The
security docs cover the rest.

Quick start

mkdir valet && cd valet && touch .env   # secrets go in .env, as ${NAME} in the config
docker run -d --name valet -p 127.0.0.1:7575:7575 \
  -v ./config:/config -v ./data:/app/data --env-file .env \
  ghcr.io/askvalet/valet:latest

Open http://localhost:7575 and the page walks you through the rest. The install guide covers Docker Compose and running from source.

Documentation

Everything else lives at askvalet.dev:

Contributing

Contributions are welcome, and new integrations are the easiest place to start. See CONTRIBUTING.md.

Licence

MIT. Product names and logos belong to their owners, and Valet isn't affiliated with any of them.