docs: document modules
This commit is contained in:
parent
7fd8d426fb
commit
6163ab5f08
23
README.md
23
README.md
|
@ -17,18 +17,25 @@ In short, it's my personal web server.
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
Aether is designed to separate deployment from the logical specification of the
|
Aether is designed to separate deployment from the logical specification of the
|
||||||
system, and thus to support any machine that can run NixOS. Currently, it is
|
system, and thus to support any machine that can run NixOS.
|
||||||
deployed physically to a
|
|
||||||
|
Currently, I deploy it physically to a
|
||||||
[Raspberry Pi 5](https://wiki.nixos.org/wiki/NixOS_on_ARM/Raspberry_Pi_5)
|
[Raspberry Pi 5](https://wiki.nixos.org/wiki/NixOS_on_ARM/Raspberry_Pi_5)
|
||||||
running a [modified UEFI bootloader](https://github.com/worproject/rpi5-uefi)
|
running a [modified UEFI bootloader](https://github.com/worproject/rpi5-uefi)
|
||||||
to provide Linux support.
|
to provide Linux support.
|
||||||
|
|
||||||
## Module Checklist
|
## Modules
|
||||||
|
|
||||||
- [x] `forgejo.nix` - Code forge
|
As with all NixOS configurations, Aether is split into several independent modules that provide different functionality. These are stored in the `modules/` directory.
|
||||||
- [ ] `site.nix` - Personal website
|
|
||||||
- [ ] `mail.nix` - Mail server
|
### Module Checklist
|
||||||
- [ ] `backup.nix` - Automated backup system
|
|
||||||
- [ ] `cachix.nix` - Nix build caching
|
- [x] `forgejo` - Code forge
|
||||||
|
- [x] `acme` - TLS certificates
|
||||||
|
- [x] `fail2ban` - IP moderation
|
||||||
|
- [ ] `site` - Personal website
|
||||||
|
- [ ] `mail` - Mail server
|
||||||
|
- [ ] `backup` - Automated backup system
|
||||||
|
- [ ] `cachix` - Nix build caching
|
||||||
|
|
||||||
[^1]: Adapted from [Book II.1](http://classics.mit.edu/Aristotle/heavens.2.ii.html).
|
[^1]: Adapted from [Book II.1](http://classics.mit.edu/Aristotle/heavens.2.ii.html).
|
||||||
|
|
Loading…
Reference in a new issue