teutat3s/os
2
0
Fork 0
forked from pub-solar/os
Code Pull requests Activity

README.md: expand on aim, and explain secrets

Browse source
This commit is contained in:
Timothy DeHerrera 2020-01-03 17:05:26 -07:00
parent c13b241b6c
commit a125cc3396
No known key found for this signature in database
GPG key ID: 8985725DB5B0C122
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,7 +1,11 @@
# Introduction
This project is under construction as a rewrite of my [legacy][old]
NixOS configuration, using the experimental [flakes][rfc] mechanism.
NixOS configuration, using the experimental [flakes][rfc] mechanism. Its aim is
to provide a generic template repository, to neatly separate concerns and allow
one to get up and running with NixOS faster. Flakes are still an experimental
feature, but once they finally get merged, even more will become possible,
including nixops support.
#### [Flake Talk][video]
@ -64,6 +68,15 @@ User declaration belongs in the [users](users) directory. Everything related to
your user should be declared here. For convenience, [home-manager][home-manager]
is available automatically for home directory setup.
## Secrets
Anything you wish to keep encrypted goes in the [secrets](secrets) directory.
Be sure to run `git-crypt init`, before committing anything to this repo.
Be sure to check out the [documentation](https://github.com/AGWA/git-crypt) if
your not familiar.
To keep [profiles](profiles) resuable across configurations, secrets should
only be imported from the [users](users) directory.
## Modules and Packages
All [modules](modules/default.nix) and [pkgs](pkgs/default.nix) are available
for every configuration automatically. Simply add a `*.nix` file to one of