Skip to content

Self-hosting

Loomkeep is open source (AGPL-3.0): you can run your own instance, for yourself, your family or anyone, with your data in your own database. It is the same code as loomkeep.app.

  • A machine running Docker with Docker Compose v2, x86-64 or 64-bit ARM: a home server, a NAS, a Raspberry Pi or a small VPS.
  • A TMDB API token, free, for films and series. The other catalogues are optional or need no key: see Catalogue keys.
  • For phones: a domain name and HTTPS. Installing the app on a phone and push notifications don’t work over plain HTTP. See Domain & HTTPS.

Email (password resets, alerts) and push notifications are optional: everything else works without them. Memory, disk and supported machines are in Requirements.

Two images, built for every release and pulled from the GitHub Container Registry: ghcr.io/logan2234/loomkeep-api and loomkeep-web. A docker/docker-compose.yml file runs them with PostgreSQL; optional compose overrides add a reverse proxy with HTTPS, monitoring, analytics and more, each switched on by adding one file to a list.

Opening your instance to other people makes you responsible for their data: under the GDPR, you are its data controller. Before giving anyone an account, read Opening it to others.

  1. Install Loomkeep and create your account.
  2. Add your catalogue keys, then email and push.
  3. Put it on a domain with HTTPS if others, or your phone, will use it.
  4. Choose what’s open in instance settings, and set up backups.