sfos/README.md
2026-07-19 09:32:34 -06:00

1.4 KiB

NOTICE: This repository has been moved to https://code.adriano.fyi/me/sfos. Microsoft has shown little interest in stewarding what was once the best and largest open source community. This small act of migration is my way showing that we don't all support Microsoft's disinterest.

SFOS

Self-host OS.

The goal of this project is a fully-declarative self-hosting platform based on NixOS.

This is not an actual operating system, but a collection of tools and Nix modules, built on top of NixOS, for bootstrapping and maintaining self-hosted software.

Everything here is currently a work-in-progress.

Overview

This repository is organized as follows

You are here

./README.md

The two most important directories here are

# Bootrap your cluster's resources like compute nodes
./bootstrap

# Deploy workloads to your cluster
./operate 

Each contain README files explaining how to use the modules.

Quick start

  1. cd ./bootstrap
  2. cat README.md
  3. Follow the documentation
  4. cd ./operate
  5. cat README.md
  6. Follow the documentation

Secrets

There are two types of SFOS secrets.

  1. Base system secrets which use agenix. These are used to bootstrap and manage the underlying infrastructure running SFOS.
  2. Workload secrets, which use setec