dotfiles

dotfiles copied to clipboard

Note: These may be outdated

Hyprland

GNOME Desktop

XFCE Desktop

Pantheon Desktop

Older...

GNOME 44

GNOME 41

$ nix flake show
github:maydayv7/dotfiles
├───apps
│   └───x86_64-linux
│       ├───default: app
│       ├───install: app
│       └───nixos: app
├───checks
│   └───x86_64-linux
│       ├───Device-gnome: derivation 'nixos-rebuild'
│       ├───Device-xfce: derivation 'nixos-rebuild'
│       └───treefmt: derivation 'treefmt-check'
├───devShells
│   └───x86_64-linux
│       ├───cc: development environment 'C'
│       ├───default: development environment 'devShell'
│       ├───format: development environment 'Formatter'
│       ├───java: development environment 'Java'
│       ├───lua: development environment 'Lua'
│       ├───python: development environment 'Python'
│       ├───rust: development environment 'Rust'
│       ├───sql: development environment 'SQL'
│       ├───video: development environment 'Video'
│       └───website: development environment 'Website'
├───files: 'dotfiles' and program configuration
├───formatter
│   └───x86_64-linux: package 'treefmt'
├───installMedia: device install media
├───legacyPackages
│   └───x86_64-linux: omitted (use '--legacy' to show)
├───lib: utility library functions
├───nixosConfigurations
│   ├───futura: NixOS configuration
│   └───vortex: NixOS configuration
├───overlays
├───packages
│   └───x86_64-linux
│       ├───install: package 'install'
│       └───nixos: package 'nixos'
├───templates
│   └───default: template: My NixOS Configuration
└───vmConfigurations
    └───Windows: Virtual Machine

In case you want to use my configuration as-is for a fresh NixOS install, you can try the following steps:

Note: You can run nix develop in the repository to install all required dependencies

1. Prepare /etc/nixos:

   sudo mkdir /etc/nixos
   sudo chown $USER /etc/nixos && sudo chmod ugo+rw /etc/nixos
   cd /etc/nixos
   

2. Clone this repository (and preferably initialize it using git):

   nix flake init -t github:maydayv7/dotfiles
   git init
   

3. Install gnupg and generate a GPG Key for yourself (if you don't already have one), and include it in the secrets.yaml file (using gpg --list-keys). You can use the following commands to generate the GPG key (Ultimate trust and w/o passphrase is preferred):
   Replace USER , EMAIL and COMMENT

   gpg --full-generate-key
   1
   4096
   0
   y
   USER
   EMAIL
   COMMENT
   O
   gpg --output public.pgp --armor --export USER@EMAIL
   gpg --output private.pgp --armor --export-secret-key USER@EMAIL
   

   Save the keys public.gpg and private.gpg in a secure location

4. Import all required GPG Keys into a convenient location (like /etc/gpg) using gpg --homedir DIR import and specify it at config.sops.gnupg.home (Required for decryption of secrets on boot, can also be on an external drive)

5. Make new secrets and passwords in the desired directories by appending the paths to secrets.yaml and then using the following command (The nixos script can be used to simplify the process):
   Replace PATH with the path to the secret

   sops --config /path/to/secrets.yaml -i PATH

6. Add device-specific configuration by creating a new file in devices (bear in mind that the name of the file must be same as the HOSTNAME of your device), and if required, hardware configuration using the hardware.modules option. Do keep in mind that the filesystems must be appropriately created and labeled as defined here.

7. Finally, run nixos-rebuild switch --flake /etc/nixos#HOSTNAME (as root) to switch to the configuration!

The lib.build.device function can be used to generate the full configuration minimally
Read this for definition information

Example flake.nix:

{
  description = "Minimal NixOS Configuration";

  ## System Repositories ##
  inputs = {
    ## Package Repositories ##
    # NixOS Package Repository
    nixpkgs.follows = "dotfiles/nixpkgs";

    ## Configuration Modules ##
    # My PC Dotfiles
    dotfiles.url = "github:maydayv7/dotfiles";
  };

  ## System Configuration ##
  outputs = inputs: let
    lib = with inputs; nixpkgs.lib // dotfiles.lib;
  in {
    nixosConfigurations.host = lib.build.device {
      name = "HOST_NAME";
      system = "x86_64-linux";

      imports = [
        # Generate using 'nixos-generate-config'
        ./hardware-configuration.nix

        # Passwords
        {
          users.extraUsers = {
            root.hashedPassword = "HASHED_PASSWORD";
            recovery.initialHashedPassword = "HASHED_PASSWORD";
          };
        }
      ];

      timezone = "Continent/City";
      locale = "US";

      kernel = "zen";
      kernelModules = ["nvme"];

      gui = {};
      hardware = {
        boot = "efi";
        cores = 4;
        filesystem = "simple";
        modules = [ /* Imported from 'nixos-hardware' */];
      };

      # Default User
      user = {
        name = "nixos";
        description = "Default User";
        minimal = true;
        password = "HASHED_PASSWORD"; # Generate using 'mkpasswd -m sha-512'
      };
    };
  };
}

Download the latest NixOS .iso from the Releases page and burn it to a USB using a flashing utility such as Etcher

[!IMPORTANT] These instructions are mainly intended for personal use. In order to directly use the configuration, you must first create a clone of this repository and follow steps 2 to 6 from the first section, and preferably create your own install media

nix build github:maydayv7/dotfiles#installMedia.VARIANT.config.system.build.isoImage

nix build github:maydayv7/dotfiles#install
sudo ./result/bin/os-install

nix build github:maydayv7/dotfiles#nixosConfigurations.DEVICE.config.formats.iso

Partition Scheme

Note that the install script automatically creates and labels all the required partitions, so it is recommended that only the partition table on the disk be created and have enough free space

[!NOTE] For the advanced filesystem scheme only

Procedure

To install the OS, just boot the Live USB and run sudo os-install
If the image doesn't boot, try disabling the secure boot and RAID options from BIOS
After the reboot, run nixos setup to finish the install
In case you are using the advanced filesystem scheme, you may need to set the boot flag zfs_force=1 on first boot

If you really want to get dirty with Nix and decide to invest oodles of your time into building your own configuration, this repository can be used as inspiration. You can check out the list of links below to resourceful Nix documentation/tutorials/projects that may be helpful in your endeavour

Welcome to the Nix Community! ;)

v17

• Re-expose lib.build.device
• Add Hyprland Configuration
• Refactor GNOME dconf
• Overhaul XFCE Configuration
  • Use ULauncher
  • Use the Picom Compositor
• Add Pantheon Desktop Configuration
• Add VS Code Extensions Repository
• Fix Android Virtualisation
• Support running AppImages
• Add multiple gui Modules
• Refactor and add hardware.cpu
• Add sql Shell
• Actually persist ~/.local/share/Trash

v15

• Use the flake-parts Flakes framework
• Improve Syntax Formatting with treefmt-nix and drop pre-commit-hooks
• Support declarative Flatpak application install
• Update Nix to version 2.19
• Enable Security & Hardening settings by default
• Add Boot Recovery Settings
• Support Secure Boot using lanzaboote
• Allow patching Default Package Channel
• Show package delta using nvd
• Upgrade to GNOME 45
  • Update Extensions
• Fix Emoji Support
• Drop .templates
• Multiple Refactors
  • Separate games and laptop module
  • Separate install Script
  • Stop exposing nixosModules
  • Fix user.homeConfig

v13

• Follow NixOS Unstable
• Improve nix-index
• Move out proprietary files
• Refactor Secrets
• Drop deploy-rs Support
• Remove inputs patching Support
• Fix first boot installation
• Add conditional to lib.map.files
• Add gui.{wallpaper,wayland}

23.05 (v12)

• Upgrade to NixOS v23.05 (Stoat)!
• Drop cod, nix-linter, gedit, touchegg, vscode-server and mutter-rounded
• Support Android Virtualisation using Waydroid
• Drop compat Libraries
• Refactor GNOME Experience
  • Use blackbox as default terminal
  • Use forge for tiling
  • Add keyboard shortcuts window using shortcuts
• Improve XFCE Configuration and Handling
• Improve Automatic Package Update Script
• Enable ZFS encryption
• Support Network Printing

22.11 (v11)

• Upgrade to NixOS v22.05 (Quokka)!
• Add lib.map.array
• Improve nixos Script
• Add gui.fonts.usershare
• General Maintenance Updates
• Use treefmt for Formatting Code

22.04 (v10)

• Deprecate git-crypt Usage
• Improve Installation Experience
• Begin Work on Blog
• Stabilize with multiple Bug-Fixes

• It is a hard requirement to clone the repository to /etc/nixos in order to use it as intended
• Home Configuration can't be decoupled from System
• Lack of automatic script checking
• Currently using a workaround for CI due to NixOS/nix#3978
• Wine Applications have to be manually updated