diff --git a/README.md b/README.md index 75d318f..2941cde 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Metanix *Declare your infrastructure!* +**THIS IS STILL IN DESIGN AND EXPERIMENTATION PHASE** + ## Description Metanix is a nix library designed to allow a central, no-nonsense nix file to be written to allow for a Source of Truth leading to deterministic configuration identifiers like IP addresses, UIDs, GIDs, and enable quickly establishing frameworks for NixOS systems existing within an ecosystem. As such, I am trying to design this system to enable a would-be admin to answer very simple one-word questions. Sort of. @@ -23,4 +25,13 @@ I use the term "thing" as an overall blanket classification for the four main ty **Locations** are networks with their own Internet access, or at the very least are networks that are supposedly physically distinct from other networks. It could be your house, your office building, an apartment, whatever. Typically, Metanix considers the fundamental defining aspects of these to be routers and subnets. -**Systems** are devices in any location. It can be any kind of device. PCs, servers, smart phones, game consoles. Depending on how its defined, Metanix will manage the device in some way, either through NixOS/Nix/Home Manager configurations, or through services it configures through Nix like DHCP, DNS, Headscale, etc. \ No newline at end of file +**Systems** are devices in any location. It can be any kind of device. PCs, servers, smart phones, game consoles. Depending on how its defined, Metanix will manage the device in some way, either through NixOS/Nix/Home Manager configurations, or through services it configures through Nix like DHCP, DNS, Headscale, etc. + +**Users** are (usually) the people who are using the systems and participating in your networks. Depending on the context, the user will have an account on the system, perhaps a network share with their data, and specific access controls granted or restricted to them on Headscale. + +**Groups** are, well, collections of things. Useful for providing a common configuration or access control to those things without having to do a bunch of needless extra legwork. This makes access control and security more straightforward, allows one to classify entire systems as being under a particular responsibility, etc. + +More on each of these categories of things later. + +## Example Config +