[docs] added install, upkeep and usage sections
This commit is contained in:
parent
027b39eeba
commit
ab284c7f62
85
docs/install/readme.md
Normal file
85
docs/install/readme.md
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
base: [NixOS 23.11](https://channels.nixos.org/nixos-23.11/latest-nixos-minimal-x86_64-linux.iso)
|
||||||
|
|
||||||
|
This will install nix using the following disk layout.
|
||||||
|
| mountpoint | filesystem | partition | size |
|
||||||
|
|------------| ---------- | --------- | -------- |
|
||||||
|
| /boot | fat32 | /dev/sda1 | 500MB |
|
||||||
|
| / | ext4 | /dev/sda2 | the rest |
|
||||||
|
|
||||||
|
Make sure to use the correct disk. 😊
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
```
|
||||||
|
nix-shell -p git
|
||||||
|
```
|
||||||
|
|
||||||
|
Partitions
|
||||||
|
```
|
||||||
|
g (gpt disk label)
|
||||||
|
n
|
||||||
|
1 (partition number [1/128])
|
||||||
|
2048 first sector
|
||||||
|
+500M last sector (boot sector size)
|
||||||
|
t
|
||||||
|
1 (EFI System)
|
||||||
|
n
|
||||||
|
2
|
||||||
|
default (fill up partition)
|
||||||
|
default (fill up partition)
|
||||||
|
w (write)
|
||||||
|
```
|
||||||
|
|
||||||
|
Filesystems
|
||||||
|
```
|
||||||
|
sudo mkfs.fat -F 32 /dev/sda1
|
||||||
|
sudo mkfs.ext4 /dev/sda2 -L root
|
||||||
|
sudo fatlabel /dev/sda1 boot
|
||||||
|
sudo mount /dev/disk/by-label/root /mnt
|
||||||
|
sudo mkdir -p /mnt/boot
|
||||||
|
sudo mount /dev/disk/by-label/boot /mnt/boot
|
||||||
|
```
|
||||||
|
|
||||||
|
Clone this repo
|
||||||
|
```
|
||||||
|
git clone https://git.simoncor.net/siempie/dotfiles-nix.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Start Installation
|
||||||
|
```
|
||||||
|
cd dotfiles
|
||||||
|
sudo nixos-install --flake ./dotfiles-nix#<phaedra|talathiel>
|
||||||
|
```
|
||||||
|
|
||||||
|
Reboot
|
||||||
|
```
|
||||||
|
sudo reboot
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Finalize
|
||||||
|
Clone dotfiles
|
||||||
|
```
|
||||||
|
git clone https://git.simoncor.net/siempie/dotfiles-nix.git ~/.dotfiles
|
||||||
|
```
|
||||||
|
|
||||||
|
Hyprland
|
||||||
|
```
|
||||||
|
mkdir -p ~/.config/hypr
|
||||||
|
rm -rf ~/.config/hypr/hyprland
|
||||||
|
ln -s ~/.dotfiles/hyprland/hyprland.conf ~/.config/hypr/hyprland.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
Login to all apps
|
||||||
|
```
|
||||||
|
bitwarden
|
||||||
|
firefox + bitwarden plugin
|
||||||
|
google-chrome + bitwarden -plugin
|
||||||
|
nextcloud
|
||||||
|
vscode
|
||||||
|
spotify
|
||||||
|
```
|
||||||
|
|
||||||
|
Headscale
|
||||||
|
```
|
||||||
|
sudo tailscale up --login-server=https://vpn.mirahsimon.us:443 --accept-routes --operator=$USER
|
||||||
|
```
|
||||||
10
docs/upkeep/readme.md
Normal file
10
docs/upkeep/readme.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
## maintenance
|
||||||
|
system rebuild
|
||||||
|
```
|
||||||
|
sudo nixos-rebuild switch --upgrade --flake ~/.dotfiles#<system_name>
|
||||||
|
```
|
||||||
|
|
||||||
|
firmware updates
|
||||||
|
```
|
||||||
|
sudo fwupdmgr update
|
||||||
|
```
|
||||||
89
docs/usage/readme.md
Normal file
89
docs/usage/readme.md
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
# Usage
|
||||||
|
|
||||||
|
## Applications
|
||||||
|
| | |
|
||||||
|
|--------------------------| -------------------------------------- |
|
||||||
|
| **Application Launcher** | Wofi |
|
||||||
|
| **Bar** | Waybar |
|
||||||
|
| **Browsers** | Firefox, Google Chrome, Microsoft Edge |
|
||||||
|
| **Clipboard Manager** | clipse |
|
||||||
|
| **Desktop Environment** | Gnome, Hyprland (primary) |
|
||||||
|
| **Display Server** | Wayland |
|
||||||
|
| **File Manager** | Nautilus |
|
||||||
|
| **Image Viewer** | Loupe |
|
||||||
|
| **Image Editor** | GIMP |
|
||||||
|
| **Music Player** | Spotify |
|
||||||
|
| **Shell** | zsh |
|
||||||
|
| **Password Manager** | Bitwarden |
|
||||||
|
| **Terminal Emulator** | Alacritty |
|
||||||
|
| **Text Editors** | vim, Visual Studio Code |
|
||||||
|
| **Video Player** | mpv |
|
||||||
|
| **VPN Client** | Tailscale |
|
||||||
|
|
||||||
|
Other usefull utilities:
|
||||||
|
- git
|
||||||
|
- imagemagick
|
||||||
|
- meld
|
||||||
|
- nextcloud-client
|
||||||
|
- solaar
|
||||||
|
- sshfs
|
||||||
|
|
||||||
|
## Hyprland
|
||||||
|
#### Keyboard bindings
|
||||||
|
|
||||||
|
`mainMod = SUPER`
|
||||||
|
|
||||||
|
| applications | |
|
||||||
|
| -------------| -------------------- |
|
||||||
|
| mM + enter | terminal |
|
||||||
|
| mM + C | clipboard manager |
|
||||||
|
| mM + D | application launcher |
|
||||||
|
| mM + E | file manager |
|
||||||
|
| mM + L | lock screen |
|
||||||
|
| mM + S | take screenshot |
|
||||||
|
|
||||||
|
|
||||||
|
| focus | |
|
||||||
|
| ---------- | ---------------- |
|
||||||
|
| mM + up | move focus up |
|
||||||
|
| mM + down | move focus down |
|
||||||
|
| mM + left | move focus left |
|
||||||
|
| mM + right | move focus right |
|
||||||
|
|
||||||
|
|
||||||
|
| window control | |
|
||||||
|
| ----------------- | ----------------- |
|
||||||
|
| mM + F | window fullscreen |
|
||||||
|
| mM + J | toggle split |
|
||||||
|
| mM + P | toggle pseudo |
|
||||||
|
| mM + Q | window close |
|
||||||
|
| mM + V | toggle float |
|
||||||
|
| mM + mouse_right | move window |
|
||||||
|
| mM + mouse_left | resize window |
|
||||||
|
| ALT SHIFT + up | move window up |
|
||||||
|
| ALT SHIFT + down | move window down |
|
||||||
|
| ALT SHIFT + left | move window left |
|
||||||
|
| ALT SHIFT + right | move window right |
|
||||||
|
|
||||||
|
|
||||||
|
| workspace | |
|
||||||
|
| --------------------- | ------------------------------- |
|
||||||
|
| mM + 0-9 | move focus to workspace 0-9 |
|
||||||
|
| mM + SHIFT + 0-9 | move window to workspace 0-9 |
|
||||||
|
| mM + mouse_wheel_up | move focus to previous workspace |
|
||||||
|
| mM + mouse_wheel_down | move focus to next workspace |
|
||||||
|
|
||||||
|
|
||||||
|
#### Autostart (in order)
|
||||||
|
- waybar
|
||||||
|
- tailscale
|
||||||
|
- clipse
|
||||||
|
- blueman-tray
|
||||||
|
- solaar
|
||||||
|
- nextcloud-desktop
|
||||||
|
- bitwarden (workspace 1)
|
||||||
|
- firefox (workspace 2)
|
||||||
|
- alacritty (workspace 3)
|
||||||
|
|
||||||
|
## Theme
|
||||||
|
TODO
|
||||||
101
readme.md
101
readme.md
@ -1,99 +1,8 @@
|
|||||||
# NixOS configuration for siempie
|
# NixOS configuration for siempie
|
||||||
base: NixOS 23.11
|
|
||||||
|
|
||||||
## Phase 1: Installation (minimal ISO)
|
# Documentation
|
||||||
```
|
[Install](https://git.simoncor.net/dotfiles-nix/docs/install)
|
||||||
nix-shell -p git
|
[Upkeep](https://git.simoncor.net/dotfiles-nix/docs/upkeep)
|
||||||
```
|
[Usage](https://git.simoncor.net/dotfiles-nix/docs/usage)
|
||||||
|
|
||||||
Create partitions
|
Enjoy!
|
||||||
```
|
|
||||||
g (gpt disk label)
|
|
||||||
n
|
|
||||||
1 (partition number [1/128])
|
|
||||||
2048 first sector
|
|
||||||
+500M last sector (boot sector size)
|
|
||||||
t
|
|
||||||
1 (EFI System)
|
|
||||||
n
|
|
||||||
2
|
|
||||||
default (fill up partition)
|
|
||||||
default (fill up partition)
|
|
||||||
w (write)
|
|
||||||
```
|
|
||||||
|
|
||||||
Labels and filesystems
|
|
||||||
```
|
|
||||||
sudo mkfs.fat -F 32 /dev/sda1
|
|
||||||
sudo mkfs.ext4 /dev/sda2 -L root
|
|
||||||
sudo fatlabel /dev/sda1 boot
|
|
||||||
sudo mount /dev/disk/by-label/root /mnt
|
|
||||||
sudo mkdir -p /mnt/boot
|
|
||||||
sudo mount /dev/disk/by-label/boot /mnt/boot
|
|
||||||
```
|
|
||||||
|
|
||||||
Clone dotfiles repo
|
|
||||||
```
|
|
||||||
git clone https://git.simoncor.net/siempie/dotfiles-nix.git
|
|
||||||
```
|
|
||||||
|
|
||||||
Nix installation
|
|
||||||
```
|
|
||||||
cd dotfiles
|
|
||||||
sudo nixos-install --flake .#<phaedra|talathiel>
|
|
||||||
```
|
|
||||||
|
|
||||||
Reboot
|
|
||||||
```
|
|
||||||
sudo reboot
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Phase 2: Finalize
|
|
||||||
Clone dotfiles
|
|
||||||
```
|
|
||||||
git clone https://git.simoncor.net/siempie/dotfiles-nix.git ~/.dotfiles
|
|
||||||
```
|
|
||||||
|
|
||||||
Link Hyprland
|
|
||||||
```
|
|
||||||
rm -rf ~/.config/hypr/hyprland
|
|
||||||
ln -s ~/.dotfiles/hyprland/hyprland.conf ~/.config/hypr/hyprland.conf
|
|
||||||
```
|
|
||||||
|
|
||||||
Login to apps
|
|
||||||
```
|
|
||||||
bitwarden
|
|
||||||
firefox + bitwarden plugin
|
|
||||||
google-chrome + bitwarden -plugin
|
|
||||||
nextcloud
|
|
||||||
vscode
|
|
||||||
spotify
|
|
||||||
```
|
|
||||||
|
|
||||||
Set avatar for GDM
|
|
||||||
```
|
|
||||||
! dont forget !
|
|
||||||
```
|
|
||||||
|
|
||||||
Tailscale
|
|
||||||
```
|
|
||||||
sudo tailscale up --login-server=https://vpn.mirahsimon.us:443 --accept-routes --operator=$USER
|
|
||||||
```
|
|
||||||
|
|
||||||
SSH keys
|
|
||||||
```
|
|
||||||
! dont forget !
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Phase 3: Maintenance
|
|
||||||
Rebuild after changes
|
|
||||||
```
|
|
||||||
sudo nixos-rebuild switch --upgrade --flake ~/.dotfiles#<system_name>
|
|
||||||
```
|
|
||||||
|
|
||||||
Regularly update firmware
|
|
||||||
```
|
|
||||||
sudo fwupdmgr update
|
|
||||||
```
|
|
||||||
|
|||||||
Reference in New Issue
Block a user