Home Cloud Core

This repository contains the core components that make up the Home Cloud platform. For example

• Server: the primary service that manages users, settings, and hosts the web interface
• Operator: a Kubernetes operator responsible for managing user application lifecycle
• Daemon: a system service that manages NixOS configuration and low-level host commands (like reboots)
• Locator: a zero-trust service discovery engine to enable remote access to Home Cloud servers when not at home

Getting Started

To work on the Home Cloud core platform you'll need a couple of things installed:

• Go v1.21 (we suggest using gvm for easier version management)
• Docker

This repository is built on top of the Draft framework for distributed systems. You don't need to be an expert with Draft to work with the Home Cloud core platform, but you'll need at least the dctl CLI tool. Let's install it now:

go install github.com/steady-bytes/draft/tools/dctl@latest

We'll need to import this project as a context into dctl so it can manage things for us. After cloning the repo run the below command from the root of the repo:

dctl context import

Let's do a quick test of building the Home Cloud API protobufs:

dctl api init
dctl api build