120 lines
7.2 KiB
Markdown
120 lines
7.2 KiB
Markdown
# Welcome to _the Satellite_
|
|
|
|
In case you are not familiar with nix/nixos, this is a collection of configuration files which build all my systems in a declarative manner. The tool used to configure the global system is called [nixos](https://nixos.org/), and the one used to configure the individual users is called [home-manager](https://github.com/nix-community/home-manager).
|
|
|
|
> A [visual history](./docs/history.md) of my setup is in the works!
|
|
|
|
## Features this repository includes:
|
|
|
|
- Consistent base16 theming using [stylix](https://github.com/danth/stylix)
|
|
- [Agenix](https://github.com/ryantm/agenix) & [homeage](https://github.com/jordanisaacs/homeage) based secret management
|
|
- Sets up all the apps I use — including git, neovim, fish, tmux, starship, hyprland, anyrun, discord, zathura, wezterm & much more.
|
|
|
|
The current state of this repo is a refactor of my old, messy nixos config, based on the structure of [this template](https://github.com/Misterio77/nix-starter-configs).
|
|
|
|
## Hosts
|
|
|
|
This repo's structure is based on the concept of hosts - individual machines configured by me. I'm naming each host based on things in space/mythology (_they are the same picture_). The hosts I have right now are:
|
|
|
|
- [tethys](./hosts/nixos/tethys/) - my personal laptop
|
|
- [lapetus](./hosts/nixos/lapetus/) - older laptop running as a server
|
|
- [euporie](./hosts/nixos/euporie/) - barebones host for testing things insdie a VM
|
|
|
|
## File structure
|
|
|
|
| Location | Description |
|
|
| ---------------------------- | --------------------------------------------------- |
|
|
| [common](./common) | Configuration loaded on both nixos and home-manager |
|
|
| [devshells](./devshells) | Nix shells |
|
|
| [docs](./docs) | Additional documentation regarding my setup |
|
|
| [home](./home) | Home manager configurations |
|
|
| [hosts/nixos](./hosts/nixos) | Nixos configurations |
|
|
| [modules](./modules) | Custom generic/nixos/home-manager modules |
|
|
| [overlays](./overlays) | Nix overlays |
|
|
| [pkgs](./pkgs) | Nix packages |
|
|
| [flake.nix](./flake.nix) | Nix flake entrypoint! |
|
|
| [secrets.nix](./secrets.nix) | Agenix entrypoint |
|
|
| [stylua.toml](./stylua.toml) | Lua formatter config for the repo |
|
|
|
|
## Points of interest
|
|
|
|
Here's some things you might want to check out:
|
|
|
|
- My [neovim config](./dotfiles/neovim)
|
|
- The [flake](./flake.nix) entrypoint for this repository
|
|
|
|
## Things I use
|
|
|
|
> This does not include links to every plugin I used for every program here. You can see more details in the respective configurations.
|
|
|
|
### Fundamentals
|
|
|
|
- [Nixos](http://nixos.org/) — nix based operating system
|
|
- [Home-manager](https://github.com/nix-community/home-manager) — manage user configuration using nix
|
|
- [Impernanence](https://github.com/nix-community/impermanence) — see the article about [erasing your darlings](https://grahamc.com/blog/erase-your-darlings)
|
|
- [Agenix](https://github.com/ryantm/agenix) & [homeage](https://github.com/jordanisaacs/homeage) — secret management
|
|
- [Slambda](https://github.com/Mateiadrielrafael/slambda) — custom keyboard chording utility
|
|
- [disko](https://github.com/nix-community/disko) — format disks using nix
|
|
- [zfs](https://openzfs.org/wiki/Main_Page) — filesystem
|
|
|
|
### Graphical
|
|
|
|
- [Stylix](https://github.com/danth/stylix) — base16 module for nix
|
|
- [Base16 templates](https://github.com/chriskempson/base16-templates-source) — list of base16 theme templates
|
|
- [Catpuccin](https://github.com/catppuccin/catppuccin) — base16 theme I use
|
|
- [Rosepine](https://rosepinetheme.com/) — another theme I use
|
|
- [Hyprland](https://hyprland.org/) — wayland compositor
|
|
- [Wlogout](https://github.com/ArtsyMacaw/wlogout) — wayland logout menu
|
|
- [Hyprpicker](https://github.com/hyprwm/hyprpicker) — hyprland color picker
|
|
- [Grimblast](https://github.com/hyprwm/contrib/tree/main/grimblast) — screenshot tool
|
|
- [Dunst](https://dunst-project.org/) — notification daemon
|
|
- [Wlsunset](https://sr.ht/~kennylevinsen/wlsunset/) — day/night screen gamma adjustements
|
|
- [Anyrun](https://github.com/Kirottu/anyrun) — program launcher
|
|
- [Wezterm](https://wezfurlong.org/wezterm/) — terminal emulator
|
|
- [Zathura](https://pwmt.org/projects/zathura/) — pdf viewer
|
|
- [Firefox](https://www.mozilla.org/en-US/firefox/) — web browser
|
|
- [Tesseract](https://github.com/tesseract-ocr/tesseract) — OCR engine
|
|
- [Obsidian](https://obsidian.md/) — note taking software
|
|
|
|
### Terminal
|
|
|
|
> There are many clis I use which I did not include here, for the sake of brevity.
|
|
|
|
- [Neovim](https://neovim.io/) — my editor
|
|
- [Neovide](https://neovide.dev/index.html) — neovim gui client
|
|
- [Vimclip](https://github.com/hrantzsch/vimclip) — vim anywhere!
|
|
- [Firenvim](https://github.com/glacambre/firenvim) — embed neovim in web browsers
|
|
- [Tmux](https://github.com/tmux/tmux/wiki) — terminal multiplexer
|
|
- [Fish](https://fishshell.com/) — user friendly shell
|
|
- [Starship](https://starship.rs/) — shell prompt
|
|
- [Ranger](https://github.com/ranger/ranger) — file manager
|
|
- [GPG](https://gnupg.org/) + [pass](https://www.passwordstore.org/)
|
|
- Self management:
|
|
- [Smos](https://github.com/NorfairKing/smos) — A comprehensive self-management System.
|
|
- [Intray](https://github.com/NorfairKing/intray) — GTD capture tool.
|
|
|
|
### Services
|
|
|
|
- [Syncthing](https://syncthing.net/) — file synchronization
|
|
|
|
## Hall of fame
|
|
|
|
Includes links to stuff which used to be in the previous section but is not used anymore. Only created this section in June 2023, so stuff I used earlier might not be here. Sorted with the most recently dropped things at the top.
|
|
|
|
- [Mind.nvim](https://github.com/phaazon/mind.nvim) — self management tree editor. The project got archived, so I switched to [Smos](https://github.com/NorfairKing/smos).
|
|
- [Null-ls](https://github.com/jose-elias-alvarez/null-ls.nvim) — general purpose neovim LSP. The project got archived, so I switched to [formatter.nvim](https://github.com/mhartington/formatter.nvim).
|
|
- [Wofi](https://sr.ht/~scoopta/wofi/) — program launcher. I switched to [Anyrun](https://github.com/Kirottu/anyrun).
|
|
- [Alacritty](https://github.com/alacritty/alacritty) — terminal emulator. I switched to [Wezterm](https://wezfurlong.org/wezterm/).
|
|
- [Xmonad](https://xmonad.org/) — xorg window manager. I switched to [Hyprland](https://hyprland.org/).
|
|
- [Polybar](https://github.com/polybar/polybar) — desktop bar
|
|
- [Rofi](https://github.com/davatorium/rofi) — program launcher. I switched to [Wofi](https://sr.ht/~scoopta/wofi/).
|
|
- [Spectacle](https://apps.kde.org/spectacle/) — screenshot tool. I switched to [Grimblast](https://github.com/hyprwm/contrib/tree/main/grimblast).
|
|
- [Chrome](https://www.google.com/chrome/) — web browser. I switched to `firefox` because it offers a better HM module.
|
|
|
|
## Future
|
|
|
|
Tooling I might use in the future:
|
|
|
|
- [nix-darwin](https://github.com/LnL7/nix-darwin) - like nixos but for macs
|
|
- [eww](https://github.com/elkowar/eww) - widget framework
|