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.

• Adding more machines

  ---

  Learn how Clan automatically includes machines and Nix files.

• Vars Backend

  ---

  Learn how to manage secrets with vars.

• Inventory

  ---

  Clan's declaration format for running services on one or multiple machines.

• Flake-parts

  ---

  Use Clan with https://flake.parts/

• Contribute

  ---

  Discover how to set up a development environment to contribute to Clan!

• macOS machines

  ---

  Manage macOS machines with nix-darwin

API Reference

Reference API Documentation

• CLI Reference

  ---

  The clan CLI command

• Service Modules

  ---

  An overview of available service modules

• Core

  ---

  The clan core nix module. This is imported when using clan and is the basis of the extra functionality that can be provided.

• (Legacy) Modules

  ---

  An overview of available clanModules

  !!! Example "These will be deprecated soon"