Files
clan-core/docs/site/index.md
Johannes Kirschbauer caaf9dc4f3 docs: unify documentation
Strictly enforce diataxis
Use resource driven approach
Can extend later to add 'developer' link index page
2025-07-24 16:51:57 +02:00

2.2 KiB

hide
hide
navigation
toc

:material-home: What is Clan?

Clan - Peer-to-Peer Computer Management Framework

Clan is a secure, peer-to-peer framework for managing personal or distributed computing networks

  • Automated Secret Management:

    Effortlessly manage secrets across machines in your network using our automated tools

  • Secure mesh VPN connectivity:

    Establish encrypted, peer-to-peer communication between machines — without centralized servers.

  • Composable Clan Services:

    Define and deploy reusable service modules that work seamlessly across machines.

  • Custom Community services:

    Everyone can contribute to a growing ecosystem of open-source services.

Getting Started{ .md-button }

:material-book: Guides

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

Concepts

Explore the foundational ideas.

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.