swarsel/.dotfiles
1
0
Fork 0
mirror of https://github.com/Swarsel/.dotfiles.git synced 2025-12-06 17:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: reflect renamed installer commands

Browse source
This commit is contained in:
Leon Schwarzäugl 2024-12-29 02:20:08 +01:00
parent 16a6aec702
commit 530d6c4f7e
Signed by: swarsel
GPG key ID: 26A54C31F2A4FD84
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.github/README.md vendored
View file

@ -73,7 +73,7 @@ Otherwise, the files that are possibly of biggest interest are found here:
If you just want to see if this configuration is for you, run this command on any system that has `nix` installed: If you just want to see if this configuration is for you, run this command on any system that has `nix` installed:
``` shell ``` shell
nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#rebuild -- -u <YOUR_USERNAME> nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#swarsel-rebuild -- -u <YOUR_USERNAME>
``` ```
This will activate the `chaostheatre` configuration on your system, which is a de-facto mirror of my main configuration with secret-based settings removed. This will activate the `chaostheatre` configuration on your system, which is a de-facto mirror of my main configuration with secret-based settings removed.
@ -88,7 +88,7 @@ The deployment process for this configuration is mostly automated, there are onl
0) Fork this repo, and write your own host config at `hosts/nixos/<YOUR_CONFIG_NAME>/default.nix` (you can use one of the other configurations as a template. Also see https://github.com/Swarsel/.dotfiles/tree/main/modules for a list of all additional options). At the very least, you should replace the `secrets/` directory with your own secrets and replace the SSH public keys with your own ones (otherwise I will come visit you!🔓❤️). I personally recommend to use the literate configuration and `org-babel-tangle-file` in Emacs, but you can also simply edit the separate `.nix` files. 0) Fork this repo, and write your own host config at `hosts/nixos/<YOUR_CONFIG_NAME>/default.nix` (you can use one of the other configurations as a template. Also see https://github.com/Swarsel/.dotfiles/tree/main/modules for a list of all additional options). At the very least, you should replace the `secrets/` directory with your own secrets and replace the SSH public keys with your own ones (otherwise I will come visit you!🔓❤️). I personally recommend to use the literate configuration and `org-babel-tangle-file` in Emacs, but you can also simply edit the separate `.nix` files.
1) Have a system with `nix` available booted (this does not need to be installed, i.e. you can use a NixOS installer image; a custom minimal installer ISO can be built by running `just iso` in the root of this repo) 1) Have a system with `nix` available booted (this does not need to be installed, i.e. you can use a NixOS installer image; a custom minimal installer ISO can be built by running `just iso` in the root of this repo)
2) Make sure that your Yubikey is plugged in or that you have your SSH key available (and configured) 2) Make sure that your Yubikey is plugged in or that you have your SSH key available (and configured)
3) Run `bootstrap -n <CONFIGURATION_NAME> -d <TARGET_IP>` on your existing system. 3) Run `swarsel-bootstrap -n <CONFIGURATION_NAME> -d <TARGET_IP>` on your existing system.
- Alternatively (if you run this on a system that is not yet running this configuration), you can also run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles -- -n <CONFIGURATION_NAME> -d <TARGET_IP>` (this runs the same program as the command above). - Alternatively (if you run this on a system that is not yet running this configuration), you can also run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles -- -n <CONFIGURATION_NAME> -d <TARGET_IP>` (this runs the same program as the command above).
4) Follow the installers instructions: 4) Follow the installers instructions:
- you will have to choose a disk encryption password (if you want that feature) - you will have to choose a disk encryption password (if you want that feature)
@ -99,10 +99,10 @@ The deployment process for this configuration is mostly automated, there are onl
### Local deployment (recommended for setting up the first system) ### Local deployment (recommended for setting up the first system)
1) Boot the latest install ISO from this repository on an UEFI system. 1) Boot the latest install ISO from this repository on an UEFI system.
2) Run `swarsel-install -d <TARGET_DISK> -f <FLAKE>` 2) Run `swarsel-install -n <CONFIGURATION_NAME>`
3) Reboot 3) Reboot
Alternatively, to install this from any NixOS live ISO, run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#install -- -d <TARGET_DISK> -f <FLAKE>` at step 2. Alternatively, to install this from any NixOS live ISO, run `nix run --experimental-features 'nix-command flakes' github:Swarsel/.dotfiles#install -- -n <CONFIGURATION_NAME>` at step 2.
## General Nix tips & useful links ## General Nix tips & useful links
- Below is a small list of tips that should be helpful if you are new to the nix ecosystem: - Below is a small list of tips that should be helpful if you are new to the nix ecosystem: