341f444fa0
revert Merge pull request 'Remove clanModules/*' (#4202) from remove-modules into main Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4202 See: https://git.clan.lol/clan/clan-core/issues/4365 Not all modules are migrated. If they are not migrated, we need to write migration docs and please display the link to the migration docs
91 lines
1.6 KiB
Markdown
91 lines
1.6 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>
|
|
|
|
- [Adding more machines](./guides/more-machines.md)
|
|
|
|
---
|
|
|
|
Learn how Clan automatically includes machines and Nix files.
|
|
|
|
- [Vars Backend](./guides/vars-backend.md)
|
|
|
|
---
|
|
|
|
Learn how to manage secrets with vars.
|
|
|
|
- [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!
|
|
|
|
- [macOS machines](./guides/macos.md)
|
|
|
|
---
|
|
|
|
Manage macOS machines with nix-darwin
|
|
|
|
</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 "These will be deprecated soon"
|
|
|
|
|
|
</div>
|