nix-dotfiles/README.md

# Nix Dotfiles

This repository contains the flake required to build critical and personal
infrastructure running NixOS. The setup can be explored as follows.

This repo supports `x86_64-linux` and `aarch64-linux`, and in theory supports
Mac (althought that hasn't been tested).

## Setting Up

Please see [our setup guide](./docs/setting-up.md) for more information on how
to onboard a new user or system.

## For Those Interested

Although we are not actively looking for new members to join in on this repo,
we are not strictly opposed. Please reach out to
[@ahuston-0](https://github.com/ahuston-0) or
[@RichieCahill](https://github.com/RichieCahill)
for further information.

## Repo Structure

- `keys/`: PGP public keys, for those who are using `SOPS` for secrets
- `modules/`: Nix modules created by us for common services or overrides
  (fail2ban, hydra, certain boot params, etc.)
- `systems/`: config for common *server* components, as well as per-server configurations
- `users/`: this directory has two major subdirectories, both are critical
    - `users/<user>`: includes configs for `home-manager`, `SOPS`, and `SSH` keys
       , for those who use them
    - `users/<user>/systems`: functions similarly to `systems/`, although for
  laptops, desktops, and even a Raspberry Pi now

## Contributing

For members of our organization who are looking to either contribute to the
existing infrastructure, or onboard their own hardware, please see
[our contributors guide](./docs/CONTRIBUTING.md)