diff --git a/README.md b/README.md index fb8e64e..75e974b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # dotnix -## Prerequisites +## Installation + +### Prerequisites You need to prepare a couple things before installation due to the way secrets are managed. -### Prepare secrets repo +#### Prepare secrets repo 1. Ensure all required dependencies are present. ```sh @@ -60,9 +62,41 @@ git commit -m "batman" git push --set-upstream origin master ``` -8. Update the submodule to use your secrets repository. +8. Back up your keys.txt +This step is very important as you'll need to copy this file to your new installation. +Make sure you'll be able to securely copy it to another machine, you should handle this +file with much care as anyone who has it will be able to decrypt your secrets if the have +the files. + +### Selecting a livecd for the installation + +The installation should work on all the NixOS livecd images, other livecds are not supported. +Just make sure you have a way to get both your ssh key for cloning your secrets repository and +keys.txt for decrypting your sops files. + +### Installation + +1. Clone this repository +```sh +git clone https://github.com/c4em/dotnix.git +cd dotnix +``` + +2. Enter a nix-shell with all required dependencies for the installation +```sh +nix-shell # This will automatically install all dependencies from `shell.nix` +``` + +3. Update the submodule to use your secrets repository. ```sh -cd git submodule set-url -- secrets ``` +3. Adjust the configuration to your needs +Information about how the configuation is structured is available in the WIP section. + +4. Run the installation script +```sh +./install.sh --host --device +``` +