Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.51 KB

README.md

File metadata and controls

306 lines (205 loc) · 9.51 KB
Raw

My dotfiles. The current iteration utilizes GNU Stow via make. This setup is inspired by this post.

This README is designed to be almost a lights-out installation and setup guide for new machines, too.

Machine Setup

Installation

Base installation process follows this article for Arch (btw).

Prerequisites

  1. Create a user
  2. Add user to sudoers
  3. Install package manager

Packager manager

paru (Arch Linux)

sudo pacman -Syu
sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/paru.git
cd paru
makepkg -si
cd ~
rm -rf paru

macports

MacPorts is assumed for macOS. Use sudo port selfupdate to update the local ports tree.

Dotfiles setup

# Generate a new SSH key
ssh-keygen -t ed25519
# add ~/.ssh/id_ed25519.pub to Github

mkdir ~/git/
git clone [email protected]:sarumont/dotfiles.git ~/git/dotfiles
cd ~/git/dotfiles
paru -S stow
make # installs all links

add user to useful groups (linux)

sudo gpasswd -a $(whoami) disk
sudo gpasswd -a $(whoami) storage
sudo gpasswd -a $(whoami) users
sudo gpasswd -a $(whoami) input
sudo gpasswd -a $(whoami) audio
sudo gpasswd -a $(whoami) video

Local git configuration

This repo stores global git configuration in ~/.config/git/config. This leaves ~/.gitconfig for local overrides. You can set your name and email:

git config --global user.name Zaphod Beeblebrox
git config --global user.email [email protected]

Signing git commits with your SSH key

We need to configure git to use your SSH key as the signing key. There should only be one key in your keyring if you've followed these instructions. If you have multiple keys, copy-paste the one you want to use rather than using the ssh-add -L command below.

git config --global user.signingkey "$(ssh-add -L)"
git config --global gpg.ssh.allowedSignersFile ~/.ssh/allowed_signers
echo EMAIL $(ssh-add -L) > ~/.ssh/allowed_signers

Note that these commands need to be run after installing keychain

Local overrides

Local overrides are managed via stow using the make host command. This looks for a dir called .hosts-$(hostname) and applies that as a vault. This applies side-by-side, so it does not support overwriting.

shell

The following local zsh overrides are supported:

  • .aliases.zsh -> .local/sh/aliases.zsh
  • .functions.zsh -> .local/sh/functions.zsh
  • .zlogin -> .local/sh/zlogin
  • .zshenv -> .local/sh/zshenv && .local/sh/*.zshenv
  • .zshrc -> .local/sh/zshrc

obsidian.nvim

You can set OBSIDIAN_VAULT_DIR in your ~/.local/sh/zshenv to point to an Obsidian Vault. This allows obsidian.nvim to utilize it. It defaults to ~/notes

Privfiles

I have a private repository that is an overlay on top of this one called privfiles. I now manage it the same way (with stow) and use it to store e.g. secrets and configurations which I do not want to be public knowledge.

Additional Software

basic utilities

Arch

paru -S zsh starship neovim openssh go-yq exa eva bat hexyl zip unzip fzf ripgrep fd \
        whois gotop jq tmux direnv at keychain zoxide usbutils stow smartmontools

macOS

sudo port install starship neovim tmux tmux-pasteboard exa bat hexyl ripgrep fd gotop \
                  direnv yq pinentry-mac keychain zoxide stow

zsh

# oh my zsh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

# zsh-syntax-highlighting
git clone https://github.com/zsh-users/zsh-syntax-highlighting.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-syntax-highlighting

# zsh-nvm
git clone https://github.com/lukechilds/zsh-nvm ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-nvm

# change shell to zsh (Arch: /usr/bin/zsh, macOS: /bin/zsh)
chsh

tmux

# install tmux plugin manager (tpm)
git clone https://github.com/tmux-plugins/tpm ~/.config/tmux/plugins/tpm
# start tmux and run <prefix>I to install all plugins

GUI

paru -S sway waybar swaylock swaybg wob \
        alacritty firefox man-db gammastep adw-gtk-theme \
        polkit playerctl grimshot xorg-xwayland \
        yubioath-desktop yubikey-manager \
        imv mpv nautilus udevil devmon cifs-utils evince neofetch \
        wl-clipboard xdg-desktop-portal-wlr darkman
systemctl --user enable --now playerctld
systemctl --user enable --now devmon
systemctl --user enable --now darkman

alacritty

mkdir -p ~/.config/alacritty/themes
git clone https://github.com/alacritty/alacritty-theme ~/.config/alacritty/themes

Fonts

paru -S noto-fonts-cjk noto-fonts-emoji noto-fonts \
        otf-firamono-nerd otf-fira-mono-italic-git \
        ttf-dejavu \
        ttf-ubuntu-nerd ttf-ubuntu-mono-nerd ttf-roboto \
        ttf-roboto-mono ttf-ms-fonts

Misc

paru -S syncthing 
systemctl --user enable --now syncthing

paru -S tailscale
sudo systemctl enable --now tailscaled
sudo tailscale login
sudo tailscale up --operator=$(whoami) --accept-routes

Laptop

paru -S battop wluma light tlp

Configure power management via the Arch Wiki article. Also this Framework thread is useful, especially for GPU rendering config.

Thinkpad

Arch Wiki - X1C 9th gen

# TODO: still WIP userspace battery charge threshold
paru -S threshy
systemctl enable --now threshy

printing

paru -S cups
sudo gpasswd -a $(whoami) cups

🎧

paru -S pipewire pipewire-pulse easyeffects easyeffects-presets spotify \
        pavucontrol lsp-plugins plexamp-appimage
systemctl --user enable --now pipewire

# configure easyeffects

# bluetooth
paru -S bluez bluez-utils bluetuith
sudo systemctl enable --now bluetooth.service

mpd

paru -S mpc ncmpcpp mpd mpdevil

beets

python -m venv ~/.beets-venv
paru -S imagemagick
pip install beets pylast pyxdg httpx flask requests # TODO: not working under Python 3.12: beets-xtractor

Now, configure and mount your music dir. Drop the following into ~/.local/beets/config.yaml:

directory: /media/chocobo/music
library: /home/sarumont/.local/beets/library.blb
import:
  log: /home/sarumont/.local/beets/import.log

And begin the import!

Dev

Development tools. Season these to taste based on your needs.

Arch

paru -S kcat-cli rubygems jwt-cli httpie aws-cli-v2-bin docker vault

DB

gem install schema-evolution-manager

Golang

Arch

paru -S go delve

macOS

sudo port install go delve

Java

curl -s "https://get.sdkman.io" | zsh
source "$HOME/.sdkman/bin/sdkman-init.sh"
sdk i maven
sdk i gradle
sdk ls java
sdk i java <whatever version you want/need>

Kubernetes

paru -S kubectl terragrunt helm telepresence2

Local cluster

paru -S rancher-k3d-bin

Thinkpad X1C 9th Gen

Most of this is from the Arch Wiki

paru -S sof-firmware intel-media-driver fprintd gnome-polkit

Trackpoint Sensitivity

Edit /sys/devices/platform/i8042/serio1/sensitivity as necessary. I like 110 as the value (default is 128)

Misc configuration

  • Enable color output in pacman/yay/paru - uncomment Color in /etc/pacman.conf
  • add vers=3.0 to cifs mount options in /etc/udevil/udevil.conf (both allowed and default)
  • enable/start devmon: systemctl --user enable --now devmon
  • edit /etc/makepkg.conf and set MAKEFLAGS="-j$(nproc)" to parallelize compilation
  • enable/start avahi: sudo systemctl enable --now avahi-daemon.service

Symlink gallery

I ripped this idea from Waylon Walker. Basically, this creates a directory that is a "gallery" of projects, tying into tmux keybindings (see C-w). You can add multiple galleries (work, oss, etc.) and corresponding keybindings in your tmux.conf.

I keep this as a zsh function inside of ~/.local/sh/functions.zsh and run it periodically to keep the galleries up to date:

update_link_galleries() {
  rm -rf ~/work
  mkdir ~/work
  ln -sf ~/github.com/myorganization/* ~/work

  rm -rf ~/work
  mkdir ~/work
  ln -sf ~/work/* ~/git
}

TODO

  • GDM
  • wluma (need autostart)
  • gammastep (need autostart)
  • fprintd
  • alacritty config
  • missing devicons..?
  • GDM fprint
  • dark mode/light mode
  • geoclue?
  • local overrides
  • privfiles (same as local overrides)
  • power management
  • printing
  • darkman (see if it works, add config gotchas to README)
  • plex (downloads)
  • trackpad tap (better)
  • privfiles / locals conflicting (.local/sh)
  • bluetooth
  • Tailscale statusbar
  • clipman / parcellite / clipboard manager via Wofi
  • screen auto locking (w/ fprint?) swaywm/swaylock#61 (comment)

Shout-out to @notlesh for dropping me this awesome link, which has influenced some of my configuration now.