main
Merge pull request 'scripts/update-pins: queue the bump for automerge' (#52) from ke-automerge-pin-bumps into main
clan-community
A community-maintained collection of clan services. While clan-core ships a set of officially supported services, this repository provides additional services contributed and maintained by the community. Anyone is welcome to submit new services or improve existing ones.
To learn how to create your own clan service, refer to the service definition guide.
Usage
Add clan-community as a flake input:
{
inputs = {
clan-core.url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz";
clan-community.url = "https://git.clan.lol/clan/clan-community/archive/main.tar.gz";
clan-community.inputs.clan-core.follows = "clan-core";
};
}
Then use any service in your inventory:
clan.inventory.instances.<module-name> = {
module.input = "clan-community";
roles.<role>.machines = [ "my-machine" ];
};
For creating more instances of the same module:
clan.inventory.instances.<instance-2> = {
module.name = "<module-name>";
module.input = "clan-community";
roles.<role>.machines = [ "my-machine" ];
};
Services
- desktop: Desktop environment/wayland compositor setup (KDE, Sway)
- dm-pull-deploy: Pull-based NixOS deployment via data-mesher
- localsend: Share files to nearby devices on the local network
- mosquitto: MQTT broker
- wireguard-star: WireGuard VPN in a star topology
Contributing
Each service lives in its own directory under services/:
services/<service-name>/
├── default.nix # The clan service definition (_class = "clan.service")
├── flake-module.nix # Registers the service via clan.modules.<name>
└── README.md # Documentation
To add a new service:
- Create a new directory under
services/ - Add a
default.nixwith your service definition - Add a
flake-module.nixthat registers it:{ ... }: let module = ./default.nix; in { clan.modules.<service-name> = module; } - Add a
README.mddocumenting the service, its roles, and usage
The service is auto-discovered — no central registration needed.
Languages
Nix
92.4%
Python
4.6%
Shell
3%