Skip to content

About

Self-hosted server for HomePrep-users.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

HomePrep Server

Your preparedness. Your server. Your data.

HomePrep Server is the self-hosted data and API layer for the HomePrep ecosystem. It is designed for people who want HomePrep data to remain under their own control while still being able to use multiple clients such as Home Assistant, a web interface and the HomePrep Android app.

HomePrep Server is currently an experimental development prototype and is not yet ready for production use.

A permanent data-ownership commitment

Preparedness data can describe a household's supplies, equipment, storage locations, emergency plans, maintenance status and weak points. HomePrep therefore treats infrastructure ownership as part of the security model itself.

Core private HomePrep data will not require centralized HomePrep-operated storage.

Self-hosted operation is not a temporary phase on the way to a mandatory cloud service. It is a permanent architectural commitment of the project.

Future optional managed services may exist, but they must remain optional and must not remove the user's ability to run the core HomePrep platform on infrastructure they control.

Convenience may be centralized. Ownership must not be.

Read the full commitment in DATA-OWNERSHIP.md.

Why HomePrep Server exists

HomePrep Server provides a common self-hosted source of truth without requiring a central HomePrep account or a HomePrep-operated cloud database.

The goal is to make multi-client use possible while preserving the same control users expect from a local-first Home Assistant installation.

Current prototype

The first vertical slice is now working:

  • FastAPI server
  • SQLite persistence
  • Alembic database migrations
  • persistent Server identity
  • Household storage
  • Inventory CRUD with revisions and soft deletion
  • React + TypeScript + Vite HomePrep Web client
  • one Docker image containing API + Web
  • Docker runtime, migration and Web smoke tests in CI

The current Web client can create/select a Household, list Inventory, add Inventory items and soft-delete Inventory items. Authentication, pairing, synchronization and the remaining HomePrep domains are intentionally not implemented yet.

Experimental quick start

For development/testing on a machine with Docker and Docker Compose:

git clone https://github.com/kakelakel/homeprep-server.git
cd homeprep-server
docker compose up --build

Then open:

http://localhost:8080

Persistent development data is written to the local ./data directory through the Compose volume mapping.

To stop the Server:

docker compose down

Important: this is an early development build. Do not expose it directly to the public internet and do not treat it as the only copy of important preparedness data yet.

Planned clients

HomePrep Server is intended to support:

  • HomePrep for Home Assistant — the existing Home Assistant integration, with an optional Server mode in addition to local-only operation.
  • HomePrep Web — a browser interface served by HomePrep Server.
  • HomePrep Android — a mobile client that connects to the user's own HomePrep Server.

Home Assistant will remain usable without HomePrep Server. The server is an optional expansion path, not a requirement for the existing integration.

Deployment goals

The first deployment targets are:

  1. Docker / Docker Compose — the reference deployment for development and self-hosting.
  2. Home Assistant App/Add-on — a packaged deployment for Home Assistant OS/Supervised users.
  3. Standalone self-hosting — the same server stack on a NAS, mini PC, home server or VPS controlled by the user.

The initial storage target is SQLite for a simple single-household deployment. The architecture should leave room for additional database backends later if there is a real need.

Planned server responsibilities

HomePrep Server will progressively provide:

  • a versioned API for HomePrep clients
  • household-scoped HomePrep data storage
  • authentication and client/device pairing
  • synchronization metadata and conflict handling
  • a web interface
  • backup and restore
  • media storage where explicitly supported
  • import/migration from existing HomePrep Home Assistant data

Security and data ownership principles

HomePrep Server is being designed around these principles:

  • self-hosted by default
  • no HomePrep cloud account required
  • no central HomePrep database required
  • local-network-only operation supported
  • remote access controlled by the server owner
  • database and persistent storage controlled by the user
  • structured HomePrep data rather than general-purpose file storage
  • data portability, backup and restore built into the product
  • documented data/API contracts to reduce lock-in
  • no mandatory telemetry for core operation
  • clients should make the connected server visible rather than hiding where data is stored

Backup and resilience

The server is intended to provide HomePrep-native backup and restore so ownership does not depend on a particular hosting platform.

Planned backup capabilities include scheduled local backups, retention policies, manual export/download, restore verification and optional user-controlled external backup destinations.

A Home Assistant App/Add-on deployment may also participate in Home Assistant's own backup system where appropriate, but HomePrep-native backup should remain available independently.

Planned operating modes

HomePrep is intended to support three broad modes over time:

Home Assistant only

The existing HomePrep integration keeps its local Home Assistant storage and works without HomePrep Server.

Home Assistant + HomePrep Server

Home Assistant becomes one client of the household's self-hosted HomePrep Server. This enables additional clients while preserving Home Assistant integration, Lovelace cards and Home Assistant notifications.

HomePrep Server without Home Assistant

A household can run HomePrep Server together with HomePrep Web and HomePrep Android without requiring Home Assistant.

Relationship to other repositories

Each repository has its own roadmap and release lifecycle while sharing common HomePrep concepts and data contracts.

Current status

The current phase is working prototype / foundation. The first API → SQLite → Web path is functioning and automatically tested. The next major platform proof is a real self-hosted deployment followed by the explicit Home Assistant import/bridge path.

See ROADMAP.md for the current plan, DATA-OWNERSHIP.md for the project's permanent ownership commitment and CHANGELOG.md for project updates.

License

HomePrep Server is released under the license included in this repository. See LICENSE.

About

Self-hosted server for HomePrep-users.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages