Skip to content
Docs
Select language:English

Getting started

The short path, one step per line. Each step links to the page with the detail.

  1. Install it. Docker with the Compose plugin; tested on 1 GB of RAM and one CPU core. Download compose.yaml, then docker compose run --rm init (it asks for the address you’ll open Kept at and writes .env) and docker compose up -d. No copy of the repository and no passwords to make. Install with Docker Compose
  2. Claim the server. Open the address, type the setup code init showed, and create the first account: it becomes the instance admin. Claim the server
  3. Keep the keys. Print the recovery kit and keep it off the server. The recovery kit
  4. Create your first home. A name, its kind, its rooms, and a preset for what it tracks. Create your first home
  5. Add a thing. Capture on a phone, or Add here on a room or box on a computer. Add your first thing
  6. Invite someone. A link or a QR code with a role (admin, member or viewer); nobody needs an email address. Invite people
  7. Put it on HTTPS, so phones allow the camera, installing Kept, offline use and push. HTTPS, or Kept on a home network for what works without it
  8. Connect AI, if you want it: Kept works without. AI providers

Then: Everyday use for the tour, the FAQ for common questions, and Common problems when something doesn’t work.