Hydenix Template

Welcome to the Hydenix template!

This template is designed to help you get started with Hydenix. It includes a basic configuration for Hydenix and some common modules.

If you just templated this flake, you can follow these steps to get started:

1. edit configuration.nix with your preferences for hydenix
   • options needing to be changed are marked with ! EDIT
   • (optional) in your template flake folder, review both ./configuration.nix and ./modules/hm/default.nix for more options
2. run sudo nixos-generate-config --show-hardware-config > hardware-configuration.nix
3. git init && git add . (flakes have to be managed via git)
4. run any of the packages in your new flake.nix
   • for rebuild, use sudo nixos-rebuild switch --flake .
5. DON'T FORGET: change your password for all users with passwd from initialPassword set in configuration.nix

NOTE: After launching hydenix, you can run hyde-shell reload to generate cache for remaining themes if you want.

All module options are documented here.

Other than that, this is your own nixos configuration. You can do whatever you want with it. Add modules, change packages, add flakes, even disable hydenix and try something else!

If you have any questions, please refer to the FAQ or Hydenix README.

You can also reach out to me on the Hyde Discord or Hydenix GitHub Discussions.

Upgrading

Hydenix can be upgraded, downgraded, or version locked easy. in your template flake folder, update hydenix to main using

nix flake update hydenix

or define a specific version in your flake.nix template

inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    hydenix = {
      # Available inputs:
      # Main: github:richen604/hydenix
      # Dev: github:richen604/hydenix/dev 
      # Commit: github:richen604/hydenix/<commit-hash>
      # Version: github:richen604/hydenix/v1.0.0
      url = "github:richen604/hydenix";
    };
  };

run nix flake update hydenix again to load the update, then rebuild your system to apply the changes

When to Upgrade

graph TD
    A[v2.3.1] --> B[MAJOR]
    A --> C[MINOR]
    A --> D[PATCH]
    B --> E[Breaking Changes<br>Review Release Notes for API Changes]
    C --> F[New Features<br>Safe to Update]
    D --> G[Bug Fixes<br>Safe to Update]

    style A fill:#c79bf0,stroke:#ebbcba,stroke-width:2px,color:#000
    style B fill:#ebbcba,stroke:#c79bf0,stroke-width:2px,color:#000
    style C fill:#ebbcba,stroke:#c79bf0,stroke-width:2px,color:#000
    style D fill:#ebbcba,stroke:#c79bf0,stroke-width:2px,color:#000
    style E fill:#f6f6f6,stroke:#c79bf0,stroke-width:2px,color:#000
    style F fill:#f6f6f6,stroke:#c79bf0,stroke-width:2px,color:#000
    style G fill:#f6f6f6,stroke:#c79bf0,stroke-width:2px,color:#000

Loading

• Always review release notes for major updates (API changes)
• Keep up with patches for stability
• Update to minor versions for new features