Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/budimanjojo/nix-config
My infrastructure managed by Nix Flakes and Chezmoi are here
https://github.com/budimanjojo/nix-config
chezmoi dotfiles fish fluxcd hyprland kubectl neovim nixos nixos-config nvim nvim-lua rofi vim vimrc waybar zellij
Last synced: 26 days ago
JSON representation
My infrastructure managed by Nix Flakes and Chezmoi are here
- Host: GitHub
- URL: https://github.com/budimanjojo/nix-config
- Owner: budimanjojo
- License: unlicense
- Created: 2016-07-28T05:35:02.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T05:27:59.000Z (2 months ago)
- Last Synced: 2024-08-24T06:31:52.570Z (2 months ago)
- Topics: chezmoi, dotfiles, fish, fluxcd, hyprland, kubectl, neovim, nixos, nixos-config, nvim, nvim-lua, rofi, vim, vimrc, waybar, zellij
- Language: Nix
- Homepage:
- Size: 2.99 MB
- Stars: 210
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
### My Infrastructure IaC
...Managed with NixOS :snowflake: and chezmoi :robot:
## :book: Overview
This repository contains my machine configurations in Infrastructure as Code style.
This is possible thanks to combination of [NixOS modules](https://nixos.wiki/NixOS_modules), [home-manager](https://github.com/nix-community/home-manager/), and [chezmoi](https://www.chezmoi.io/).
This repo is a [Nix Flake](https://nixos.wiki/wiki/Flakes) that you can import and use yourself but I don't recommend doing that.
You should take it as an inspiration for your infrastructure instead.
Please note that this is a Work In Progress, so stuffs may change without further notice and this README can get outdated.
My goal is to have everything as reproducible as possible.
For NixOS machines, everything is managed by NixOS modules and `home-manager`.
As for non NixOS machines, I use combination of `home-manager` and `chezmoi`.
I use `chezmoi` mainly to configure the system using [chezmoi scripts](https://www.chezmoi.io/user-guide/use-scripts-to-perform-actions/) while `home-manager` to configure applications in the userspace.
## :camera: Screenshots
**Sway**
**Tmux**
**Fish prompt**
**Neovim**
## :package: Modules
- [Flake Parts](https://github.com/hercules-ci/flake-parts) to manage `flakes` outputs.
- [home-manager](https://github.com/nix-community/home-manager) to manage my home directory.
- [sops-nix](https://github.com/Mic92/sops-nix) is used to encrypt/decrypt my secrets safely.
- [Disko](https://github.com/nix-community/disko) to declaratively manage disks.
- [NUR](https://github.com/nix-community/NUR) for packages not available in the official NixOS repository.
- [nixvim](https://github.com/nix-community/nixvim) to create reproducible Neovim package.
## :open_file_folder: Directory structure
The structure of this repository is highly opinionated.
I shamelessly took the pieces I believe is the best from people and modified it.
- [./flake.nix](./flake.nix) is the entrypoint for `nixos-rebuild` and `home-manager` commands.
- [./flake.lock](./flake.lock) is the lock file for this flake, updated daily by [budimanjojo-bot](https://github.com/apps/budimanjojo-bot) powered by [Renovate](https://github.com/renovatebot/renovate).
- [./flakeLib.nix](./flakeLib.nix) is where I put helper functions used in `flake.nix` file, this is where the magic happens.
- [./lib](./lib) is where I put helper functions used in NixOS and `home-manager` modules.
- [./packages](./packages) is where I put my own packages, updated daily by [budimanjojo-bot](https://github.com/apps/budimanjojo-bot) powered by [nvfetcher](https://github.com/berberman/nvfetcher).
- [./overlays](./overlays) contains overlays for packages used in NixOS and `home-manager` modules.
- [./shell.nix](./shell.nix) accessible via `nix develop` to have tools needed available in current shell.
- [./system](./system) contains my own NixOS modules and per machine system configurations.
- [./home](./home) contains my own `home-manager` modules and per user configurations.
- [./chezmoi](./chezmoi) contains files used by `chezmoi`.
## :inbox_tray: How do I bootstrap a new machine
### NixOS
- Clone this repository in a directory inside the machine.
- Edit `./flake.nix` file and add the new machine specs inside `outputs.flake.nixosConfigurations` schema.
- Create `./system/hosts//default.nix` for the new machine and configure it.
- Create `./home/budiman/hosts/.nix` for the new machine and configure it.
- Run `git add .` then `sudo nixos-rebuild switch --flake .#` and I'm done.
### Non NixOS
- Install Nix and enable Flake.
- Edit `./flake.nix` file and add the new machine specs inside `outputs.flake.homeConfigurations` schema.
- Create `./home/budiman/hosts/.nix` for the new machine and configure it.
- Run `git add .` then `nix run nixpkgs.home-manager -c home-manager switch --flake .#budiman@` and I'm done.
## :pencil: Neovim
My `neovim` setup is packaged with [nixvim](https://github.com/nix-community/nixvim) and exposed at `legacyPackages.neovim` from this flake.
You can run it directly if you have `nix` installed and `flakes` enabled with: `nix run github:budimanjojo/nix-config#neovim`.
## :fish: Fish
Fish is enabled using the `home-manager` module.
On my non NixOS machines, `fish` is patched to work without system intervention and I have a `chezmoi` script that will switch the default shell for the user to `~/.nix-profile/bin/fish`.
These are the plugins I'm using:
- [Starship](https://starship.rs/)
- [FZF Fish](https://github.com/patrickF1/fzf.fish)
- [Puffer Fish](https://github.com/nickeb96/puffer-fish)
- [autopair.fish](https://github.com/jorgebucaran/autopair.fish)
- [fish-abbreviation-tips](https://github.com/gazorby/fish-abbreviation-tips)
## :abcd: Fonts
Starship requires powerline fonts to work.
I suggest [Nerd-fonts](https://github.com/ryanoasis/nerd-fonts).
The font in the screenshot above is using UbuntuMono Nerd Font Regular.
Unifont is also for some glyphs to work.
On non NixOS machines, `home-manager` will install these fonts automatically.
## :scroll: Cheatsheet
### Sway/i3/Hyprland keybindings
I use `Super` key for Sway/i3.
`hjkl` keys are mapped to `left`, `down`, `up`, `right` arrow keys.
`S` means Super key, [0-9] means number key 0 to 9.
| Keypress | Description |
| :-------------: | :----------------------------------------- |
| `S+t` | Open terminal app |
| `S+w` | Open browser |
| `S+f` | Open file manager |
| `S+grave` | Open rofi apps menu |
| `S+Esc` | Open rofi apps menu |
| `S+F4` | Close window |
| `S+k` | Change focus to window above |
| `S+j` | Change focus to window below |
| `S+h` | Change focus to left side window |
| `S+l` | Change focus to right side window |
| `S+Shift+k` | Move focused window up |
| `S+Shift+j` | Move focused window down |
| `S+Shift+h` | Move focused window left |
| `S+Shift+l` | Move focused window right |
| `S+Ctrl+h` | Split opened windows horizontally |
| `S+Ctrl+v` | Split opened windows vertically |
| `S+Ctrl+q` | Toggle opened windows split |
| `S+Tab` | Go to next workspace |
| `S+Shift+Tab` | Go to previous workspace |
| `S+Ctrl+t` | Toggle window border on/off |
| `S+Ctrl+g` | Toggle gaps on/off |
| `S+Ctrl+f` | Toggle fullscreen mode on/off |
| `S+Ctrl+s` | Change container layout to stacking |
| `S+Ctrl+w` | Change container layout to tabbed |
| `S+Ctrl+e` | Toggle split layout to horizontal/vertical |
| `S+Shift+Space` | Toggle window floating on/off |
| `S+Space` | Swap focus between tiling/floating window |
| `S+Shift+p` | Move current focused window to scratchpad |
| `S+p` | Show/hide scratchpad window |
| `S+[0-9]` | Go to workspace #[0-9] |
| `S+Shift+[0-9]` | Move focused window to workspace #[0-9] |
| `S+Shift+r` | Go to resize container mode |
| `S+Shift+g` | Go to resize gaps mode |
| `S+Ctrl+Del` | Go to logout mode |
| `Printscreen` | Go to screenshot mode |
| `S+Shift+c` | Reload configuration |
| `S+Shift+e` | Exit |
### Neovim keybindings
The prefix key is `Space`.
You can override this using your custom `.vimrc.local` file.
`` means you need to press prefix key first.
If they are not in the table, that means it's using the default Vim keybindings.
| Mode | Keypress | Description |
| :-------------: | :----------: | :-------------------------------------- |
| `Normal` | `w` | Save file |
| `Normal` | `x` | Save file and quit |
| `Normal` | `qq` | Quit |
| `Normal` | `qa` | Force quit without saving |
| `Normal` | `wq` | Save file and quit |
| `Normal` | `Y` | Yank from cursor to end of file |
| `Normal` | `Control+k` | Move to the split window above |
| `Normal` | `Control+j` | Move to the split window below |
| `Normal` | `Control+h` | Move to the left split window |
| `Normal` | `Control+l` | Move to the right split window |
| `Normal` | `s` | Open new horizontal split window |
| `Normal` | `v` | Open new vertical split window |
| `Insert` | `Control+k` | Move cursor Up |
| `Insert` | `Control+j` | Move cursor Down |
| `Insert` | `Control+h` | Move cursor Left |
| `Insert` | `Control+l` | Move cursor Right |
| `Normal` | `tn` | Open new tab |
| `Normal` | `td` | Close tab |
| `Normal` | `th` | Go to previous tab |
| `Normal` | `tl` | Go to next tab |
| `Normal` | `te` | Open new tab with current buffer's path |
| `Normal` | `hh` | Jump back to older cursor position |
| `Normal` | `ll` | Jump forward to newer cursor position |
| `Normal/Visual` | `Tab` | Indent current line or selection |
| `Normal/Visual` | `Shift+Tab` | De-indent current line or selection |
| `Normal` | `lr` | Restart LSP client |
| `Normal` | `fz` | Open FzfLua |
| `Normal` | `ff` | Open FzfLua to find files |
| `Normal` | `fg` | Open FzfLua to live grep |
| `Normal` | `fc` | Open FzfLua to see git commits |
| `Normal` | `fb` | Open FzfLua to see opened buffers |
| `Normal` | `fh` | Open FzfLua to find help |
| `Normal` | `fk` | Open FzfLua to see keymappings |
| `Normal` | `fe` | Open FzfLua to find lsp diagnostics |
| `Normal` | `fr` | Open FzfLua to find lsp references |
| `Normal` | `fd` | Open FzfLua to find lsp typedefs |
| `Normal` | `xx` | Toggle Trouble |
| `Normal` | `xr` | Toggle Trouble to find lsp references |
| `Normal` | `Control+f` | Toggle oil.nvim file manager |
| `Normal/Term` | `Control+t` | Toggle floating terminal |
| `Normal` | `pp` | Format buffer with null-ls |
| `Visual` | `pp` | Range format buffer with null-ls |
| `Normal` | `rn` | Do LSP buffer rename |
| `Normal` | `gd` | Do LSP buffer get definition |
| `Normal` | `gD` | Do LSP buffer get declaration |
| `Normal` | `gh` | Do LSP buffer get hover |
| `Normal` | `gr` | Do LSP buffer get references |
| `Normal` | `gi` | Do LSP buffer get implementation |
### Tmux keybindings
I override the default keybindings for Tmux to be more reasonable.
Prefix key is `Alt+a` for local session and `Alt+z` for nested session.
You can of course override this.
`` means you need to press prefix key first, `` means you don't need to press prefix key again after triggering it within `repeat-time` set (default set to 1 second), `` means you must be in copy-mode first.
The table below lists all the keybindings set.
If they are not in the table, that means it's using the default Tmux keybindings.
| Keypress | Description |
| :---------------------: | :-------------------------------------------------------------- |
| `Alt+r` | Reload tmux configuration |
| `f` | Find session, window, pane from list |
| `Alt+s` | Create new horizontal split window |
| `Alt+v` | Create new vertical split window |
| `r` | Rename current window |
| `R` | Rename current session |
| `k` | Move selection to pane above |
| `j` | Move selection to pane below |
| `h` | Move selection to left pane |
| `l` | Move selection to right pane |
| `>` | Swap to next pane |
| `<` | Swap to previous pane |
| `K` | Resize current pane upwards |
| `J` | Resize current pane downwards |
| `H` | Resize current pane to the left |
| `L` | Resize current pane to the right |
| `Alt+n` | Move selection to next window |
| `Alt+p` | Move selection to previous window |
| `Tab` | Move selection to next window |
| `S` | Join current pane to selected window in horizontal split |
| `V` | Join current pane to selected window in vertical split |
| `x` | Close current pane |
| `X` | Close current window |
| `Alt+x` | Close all other windows |
| `a` | Get into copy mode |
| `p` | Paste copied text from last buffer |
| `P` | Paste copied text from list |
| `y` | Copy selected text |
| `Y` | Copy the whole line of selected text |
| `D` | Copy till the end of line from selected text |
### Zellij keybindings
I'm migrating my tmux to [Zellij](https://zellij.dev/).
I mimicked my tmux configuration to work in zellij but not everything works the same.
Prefix key is `Alt+a`, I use the "switch to normal mode" in zellij to achieve this.
`` means you need to be in normal mode, `` means pane mode, and so on.
The table below lists all the keybindings set.
| Keypress | Description |
| :--------------------: | :--------------------------------------------------------- |
| `Alt+a` | Swith to normal mode (act like prefix key in tmux) |
| `Alt+s` | Create new horizontal split window and back to locked mode |
| `Alt+v` | Create new vertical split window and back to locked mode |
| `r` | Switch to renametab mode |
| `h` | Move selection to left pane |
| `j` | Move selection to pane below |
| `k` | Move selection to pane above |
| `l` | Move selection to right pane |
| `>` | Move pane around |
| `H` | Resize current pane upwards |
| `J` | Resize current pane downwards |
| `H` | Resize current pane to the left |
| `L` | Resize current pane to the right |
| `Alt+n` | Go to next window |
| `Alt+p` | Go to previous window |
| `c` | Open new tab and back to locked mode |
| `x` | Close current pane and back to locked mode |
| `a` | Open pane with $EDITOR and back to locked mode |
| `Esc/' '/"\n"` | Switch back to locked mode |
| `Alt+a` | Switch to normal mode |
| `"\n"` | Switch to locked mode |
| `Esc` | Confirm tab name and back to locked mode |
## :coffee: Acknowledgements
I wrote most of the codes by myself, but there are a lot of stuffs inspired by these repositories.
- [MatthiasBenaets/nixos-config](https://github.com/MatthiasBenaets/nixos-config) for the awesome YouTube video introducing NixOS to me.
- [viperML/dotfiles](https://github.com/viperML/dotfiles) for answering stupid questions on Discord.
- [bjw-s/nix-config](https://github.com/bjw-s/nix-config) for being inspiration for my repo structure.
- [truxnell/nix-config](https://github.com/truxnell/nix-config) for being inspiration for my flakeLib functions.