Menno van Leeuwen
d3caf87696
Some checks failed
Nix Format Check / check-format (push) Failing after 38s
77 lines
2.8 KiB
Markdown
Executable File
77 lines
2.8 KiB
Markdown
Executable File
# Setup
|
|
|
|
This dotfiles is intended to be used with either Fedora 40>, Ubuntu 20.04> or Arch Linux.
|
|
Please install a clean version of either distro with GNOME and then follow the steps below.
|
|
|
|
## Installation
|
|
|
|
### 0. Install distro
|
|
|
|
Download the latest ISO from your desired distro and write it to a USB stick.
|
|
I'd recommend getting the GNOME version as it's easier to setup unless you're planning on setting up a server, in that case I recommend getting the server ISO for the specific distro.
|
|
|
|
#### Note: If you intend on using a desktop environment you should select the GNOME version as this dotfiles repository expects the GNOME desktop environment for various configurations
|
|
|
|
### 1. Clone dotfiles to home directory
|
|
|
|
Open a shell and begin the setup process. This setup requires you to provide a hostname as a parameter. You can use an existing hostname to restore an old system or choose a new name.
|
|
|
|
If you are running this in a VM be sure to answer yes if it prompts you.
|
|
|
|
```bash
|
|
curl -L https://df.mvl.sh | bash -s your-hostname
|
|
```
|
|
|
|
Replace `your-hostname` with your desired hostname for this machine.
|
|
|
|
### 2. Reboot
|
|
|
|
It's probably a good idea that you either reboot or log out and log back in to make sure all the changes are applied.
|
|
|
|
```bash
|
|
# sudo reboot
|
|
```
|
|
|
|
### 3. Run `dotf update`
|
|
|
|
Run the `dotf update` command, although the setup script did most of the work some symlinks still need to be set which at the moment is done using shell scripts.
|
|
|
|
```bash
|
|
dotf update
|
|
```
|
|
|
|
### 4. Setup 1Password (Optional)
|
|
|
|
1Password is installed but you need to login and enable the SSH agent and CLI components under the settings before continuing.
|
|
|
|
### 5. Decrypt secrets
|
|
|
|
Either using 1Password or by manualling providing the decryption key you should decrypt the secrets.
|
|
Various configurations depend on the secrets to be decrypted such as the SSH keys, yubikey pam configuration and more.
|
|
|
|
```bash
|
|
dotf secrets decrypt
|
|
```
|
|
|
|
### 6. Profit
|
|
|
|
You should now have a fully setup system with all the configurations applied.
|
|
|
|
## Adding a new system
|
|
|
|
### Paths in the repository
|
|
|
|
Here are some paths that contain files named after the hostname of the system.
|
|
If you add a new system you should add the relevant files to these paths.
|
|
|
|
- `config/ssh/authorized_keys`: Contains the public keys per hostname that will be symlinked to the `~/.ssh/authorized_keys` file.
|
|
- `config/home-manager/flake.nix`: Contains an array `homeConfigurations` where you should be adding the new system hostname and relevant configuration.
|
|
|
|
### Adding a new system
|
|
|
|
To add a new system you should follow these steps:
|
|
|
|
1. Add the relevant files shown in the section above.
|
|
2. Ensure you've either updated or added the `$HOME/.hostname` file with the hostname of the system.
|
|
3. Run `dotf update` to ensure the symlinks are properly updated/created.
|