dotfiles/README.md

# Table of Contents

1.  [magic<sub>rb</sub>'s dotfiles](#org15340a2)
    1.  [License](#orga7bf945)
        1.  [Exceptions](#orgd199743)
    2.  [NixOS](#org316f612)
        1.  [Modules](#org9ef0afa)


<a id="org15340a2"></a>

# magic<sub>rb</sub>'s dotfiles


<a id="orga7bf945"></a>

## License

All files unless otherwise stated are licensed under the LGPL-v3.0 license. Please refer to [COPYING](COPYING) and [COPYING.LESSER](COPYING.LESSER) for more information.


<a id="orgd199743"></a>

### Exceptions

The LGPL-v3.0 does not apply to you copying out a insignificant part of the source code, general rule of thumb is "If it's less than 32 lines and/or doesn't constitute a big self contained part, it's licensed under the MIT license." If you need clarification please contact `@magic_rb:matrix.redalder.org` on matrix.


<a id="org316f612"></a>

## NixOS


<a id="org9ef0afa"></a>

### Modules

1.  `acme-sh`

    -   source code: <nixos/modules/acme-sh.nix>
    
    Modified version of module originally from [Serokell](https://github.com/serokell/serokell.nix/blob/master/modules/acme-sh.nix). It allows to easy fetch and access certificates, facilitated by \`acme-sh\`. Can be used in tandem with any program which can load certificates from files.

2.  `grafana`

    -   source code: <nixos/modules/grafana.nix>
    
    Very simplified version of module originally from [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-24.05/nixos/modules/services/monitoring/grafana.nix).
    
    This module is currently **unused**, **untested**, and may be removed or completely reworked soon.

3.  `hashicorp-envoy`

    -   source code: <nixos/modules/hashicorp-envoy.nix>
    
    Allows deploying Envoy proxies that can integrate with the Consul Connect service mesh. Used to hook klipper into the rest of my infrastructure.
    
    This module is **deprecated** and **will** be removed soon. I'm switching away from Hashicorp Nomad+Consul and towards k3s+Istio and therefore won't have a need for this module.

4.  `hashicorp`

    -   source code: <nixos/modules/hashicorp.nix>
    
    Runs Hashicorp Vault, Consul and Nomad. Would probably work with OpenBao too, but this has not yet been tested.

5.  `influx-provisioning`

    -   source code: <nixos/modules/influx-provisioning.nix>
    
    Crudely provisions InfluxDB.
    
    This module is **deprecated** and **will** be removed soon. It was originally created when I thought I would be switching away from Terraform completely. Now I know I will be switching to OpenTofu.

6.  `netboot-xyz`

    -   source code: <nixos/modules/netboot-xyz.nix>
    
    Adds `netboot.xyz` to GRUB, supports both EFI and BIOS. Used on my server in case of catastrophic root pool failure.

7.  `notify-login`

    -   source code: <nixos/modules/notify-login.nix>
    
    Send notifications over Matrix, when an SSH session is opened/closed.

8.  `notnft`

    -   source code: <nixos/modules/notnft.nix>
    
    Alternative implementation of upstream [notnft](https://github.com/chayleaf/notnft) module, which is part of the much larger [nixos-router](https://github.com/chayleaf/nixos-router) repository.

9.  `notnft-ns`

    -   source code: <nixos/modules/notnft-ns.nix>
    
    Newer implementation of the [notnft](#orgdda3bc4) module, this one supports network namespaces.

10. `telegraf`

    -   source code: <nixos/modules/telegraf.nix>
    
    Very simplified version of module originally from [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-24.05/nixos/modules/services/monitoring/telegraf.nix).
    
    This module is currently **unused**, **untested**, and may be removed or completely reworked soon.