85 lines
1.5 KiB
Markdown
85 lines
1.5 KiB
Markdown
---
|
|
hide:
|
|
- navigation
|
|
- toc
|
|
---
|
|
|
|
# :material-home: Welcome to **Clan**'s documentation
|
|
|
|
[Getting Started](./guides/getting-started/index.md){ .md-button }
|
|
|
|
## :material-book: Guides
|
|
|
|
**How-to Guides for achieving a certain goal or solving a specific issue.**
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- [Autoincludes](./guides/adding-machines.md)
|
|
|
|
---
|
|
|
|
Learn how Clan automatically includes machines and Nix files.
|
|
|
|
- [Vars Backend](./guides/vars-backend.md)
|
|
|
|
---
|
|
|
|
Learn how to manage secrets with facts.
|
|
|
|
- [Inventory](./guides/inventory.md)
|
|
|
|
---
|
|
|
|
Clan's declaration format for running **services** on one or multiple **machines**.
|
|
|
|
- [Flake-parts](./guides/flake-parts.md)
|
|
|
|
---
|
|
|
|
Use clan with [https://flake.parts/]()
|
|
|
|
- [Contribute](./guides/contributing/CONTRIBUTING.md)
|
|
|
|
---
|
|
|
|
Discover how to set up a development environment to contribute to Clan!
|
|
|
|
</div>
|
|
|
|
## API Reference
|
|
|
|
**Reference API Documentation**
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- [Cli Reference](./reference/cli/index.md)
|
|
|
|
---
|
|
|
|
The `clan` cli command
|
|
|
|
- [Service Modules](./reference/clanServices/index.md)
|
|
|
|
---
|
|
|
|
An overview of available service modules
|
|
|
|
- [Core](./reference/clan-core/index.md)
|
|
|
|
---
|
|
|
|
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](./reference/clanModules/index.md)
|
|
|
|
---
|
|
|
|
An overview of available clanModules
|
|
|
|
!!! Example "Those will get deprecated soon"
|
|
|
|
|
|
</div>
|