clan-core/docs/site/index.md

hide

hide
navigation toc

:material-home: What is Clan?

Clan is a peer-to-peer computer management framework that empowers you to reclaim control over your digital computing experience. Built on NixOS, Clan provides a unified interface for managing networks of machines with automated secret management, secure mesh VPN connectivity, and customizable installation images. Whether you're running a homelab or building decentralized computing infrastructure, Clan simplifies configuration management while restoring your independence from closed computing ecosystems.

At the heart of Clan are Clan Services - the core concept that enables you to add functionality across multiple machines in your network. While Clan ships with essential core services, you can create custom services tailored to your specific needs.

Getting Started{ .md-button }

:material-book: Guides

How-to Guides for achieving a certain goal or solving a specific issue.

• Create a Machine

  ---

  How to create your first machine

• macOS

  ---

  How to manage macOS machines with nix-darwin

• Contribute

  ---

  How to set up a development environment

Concepts

Explore the foundational ideas.

• Generators

  ---

  Learn about Generators

• Inventory

  ---

  Learn about Inventory

API Reference

Technical reference for Clan's CLI and Nix modules

• CLI Reference

  ---

  Command-line interface.

  Full reference for the clan CLI tool.

• Service Modules

  ---

  Overview of built-in service modules that provide composable functionality across machines.

• Core NixOS-module

  ---

  The foundation of Clan's functionality

  Reference for the clan-core NixOS module — automatically part of any machine to enable Clan's core features.