yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Run formatter

Browse Source
This commit is contained in:
pinpox
2025-08-25 18:40:51 +02:00
parent a9c53b8b1e
commit 41c52197ea
71 changed files with 2118 additions and 1379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/site/reference/glossary.md
View File

@@ -1,38 +1,49 @@
# :material-api: Glossary
## clan
Collection of machines interconnected in a network.
## clan-app
Graphical interface for managing clans. Simpler to use than the `clan-cli`.
## clan-cli
Command-line tool for managing clans.
## clanModule
Module that enables configuration via the inventory.
Legacy `clanModules` also support configuration outside the inventory.
Module that enables configuration via the inventory. Legacy `clanModules` also
support configuration outside the inventory.
## clanService
Service defined and managed through a clan configuration.
## clanURL
Flake URL-like syntax used to link to clans.
Required to connect the `url-open` application to the `clan-app`.
Flake URL-like syntax used to link to clans. Required to connect the `url-open`
application to the `clan-app`.
## facts *(deprecated)*
System for creating secrets and public files in a declarative way.
**Note:** Deprecated, use `vars` instead.
System for creating secrets and public files in a declarative way. **Note:**
Deprecated, use `vars` instead.
## inventory
JSON-like structure used to configure multiple machines.
## machine
A physical computer or virtual machine.
## role
Specific function assigned to a machine within a service.
Allows assignment of sane default configurations in multi-machine services.
Specific function assigned to a machine within a service. Allows assignment of
sane default configurations in multi-machine services.
## vars
System for creating secrets and public files in a declarative way.

23
docs/site/reference/index.md
View File

@@ -1,20 +1,23 @@
# :material-api: Overview
This section of the site provides an overview of available options and commands within the Clan Framework.
This section of the site provides an overview of available options and commands
within the Clan Framework.
---
______________________________________________________________________
- [Clan Configuration Option](/options) - for defining a Clan
- Learn how to use the [Clan CLI](./cli/index.md)
- Explore available [services](./clanServices/index.md)
- [NixOS Configuration Options](./clan.core/index.md) - Additional options avilable on a NixOS machine.
- [NixOS Configuration Options](./clan.core/index.md) - Additional options
avilable on a NixOS machine.
---
______________________________________________________________________
!!! Note
This documentation is always built for the main branch.
If you need documentation for a specific commit you can build it on your own
!!! Note This documentation is always built for the main branch. If you need
documentation for a specific commit you can build it on your own
```bash
nix build 'git+https://git.clan.lol/clan/clan-core?ref=0324f4d4b87d932163f351e53b23b0b17f2b5e15#docs'
```
````
```bash
nix build 'git+https://git.clan.lol/clan/clan-core?ref=0324f4d4b87d932163f351e53b23b0b17f2b5e15#docs'
```
````