clan-core/docs/site/index.md

hide

hide
navigation toc

:material-home: Welcome to Clan's documentation

Getting Started{ .md-button }

Tutorials

Learning-oriented adventures with a hands-on experience.

• :material-clock-fast:{ .lg .middle } Set up in 15 minutes

  ---

  Create your own clan and get everything running in minutes

  :octicons-arrow-right-24: Getting started

• :fontawesome-solid-user-group:{ .lg .middle } Authoring Modules

  ---

  Create ressources that can be reused by the community.

  :octicons-arrow-right-24: Authoring guides

:material-book: Guides

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

• Autoincludes

  ---

  Learn how Clan automatically includes machines and Nix files.

• Vars Backend

  ---

  Learn how to manage secrets with facts.

• 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!

API Reference

Reference API Documentation

• Reference Overview

  ---

  Learn how to interface with Clan programmatically

• Cli Reference

  ---

  The clan cli command

• Modules

  ---

  An overview of available clan 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.