hyprland-wiki/pages/Nix/Hyprland on Home Manager.md

234 lines
5.7 KiB
Markdown
Raw Normal View History

---
title: Hyprland on Home Manager
---
2022-12-18 14:20:19 +01:00
For a list of available options, check the
[Home Manager options](https://nix-community.github.io/home-manager/options.xhtml#opt-wayland.windowManager.hyprland.enable).
2022-12-18 14:20:19 +01:00
{{< callout >}}
- _**(Required)** NixOS Module_: enables critical components needed to run
Hyprland properly.
- _Without this, you may have issues with XDG Portals, or missing session
files in your Display Manager._
- _(Optional) Home Manager module_: lets you configure Hyprland declaratively
through Home Manager.
- _This module configures Hyprland and adds it to your user's `$PATH`, but
does not make certain system-level changes such as adding a desktop session
file for your display manager. This is handled by the NixOS module once you
enable it._
{{< /callout >}}
2023-12-14 19:02:45 +01:00
## Installation
2024-05-05 14:56:59 +02:00
{{< tabs items="Home Manager,Flakes,Nix stable (with flake-compat)" >}}
2023-12-14 19:02:45 +01:00
{{< tab "Home Manager" >}}
```nix
{
2024-08-31 11:28:06 +02:00
programs.kitty.enable = true; # required for the default Hyprland config
wayland.windowManager.hyprland.enable = true; # enable Hyprland
# Optional, hint Electron apps to use Wayland:
# home.sessionVariables.NIXOS_OZONE_WL = "1";
2023-12-14 19:02:45 +01:00
}
```
{{< /tab >}}
{{< tab "Flakes" >}}
2023-12-14 19:02:45 +01:00
The following snippet of code tries to show how to bring the Hyprland flake from
2024-09-01 19:42:51 +02:00
the flake input and use its packages with Home Manager. Feel free to make any
2023-12-14 19:02:45 +01:00
adjustment for your setup.
Don't forget to replace `user@hostname` with your username and hostname!
2022-12-18 14:20:19 +01:00
```nix
# flake.nix
2023-02-14 14:30:40 +01:00
2022-12-18 14:20:19 +01:00
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
home-manager = {
url = "github:nix-community/home-manager";
inputs.nixpkgs.follows = "nixpkgs";
};
2024-05-05 14:56:59 +02:00
hyprland.url = "git+https://github.com/hyprwm/Hyprland?submodules=1";
2022-12-18 14:20:19 +01:00
};
outputs = {nixpkgs, home-manager, hyprland, ...}: {
homeConfigurations."user@hostname" = home-manager.lib.homeManagerConfiguration {
pkgs = nixpkgs.legacyPackages.x86_64-linux;
modules = [
{
2024-09-01 19:42:51 +02:00
wayland.windowManager.hyprland = {
enable = true;
# set the flake package
package = inputs.hyprland.packages.${pkgs.stdenv.hostPlatform.system}.hyprland;
};
}
2022-12-18 14:20:19 +01:00
# ...
];
};
};
2022-12-28 16:31:43 +01:00
}
2022-12-18 14:20:19 +01:00
```
2023-12-14 19:02:45 +01:00
{{< /tab >}}
2022-12-18 14:20:19 +01:00
2024-09-01 19:42:51 +02:00
{{< tab "Nix stable (with flake-compat)" >}}
2023-12-14 19:02:45 +01:00
{{< callout >}}
2023-12-14 19:02:45 +01:00
The flake module is merely an extension to the Home Manager downstream module.
It is mainly used as a staging area for new options, so unless you're a tester
you should use the downstream Home Manager module.
{{< /callout >}}
2023-12-14 19:02:45 +01:00
The following snippet of code tries to show how to bring the Hyprland flake from
2024-05-05 14:56:59 +02:00
the flake input and use the package in the Home Manager option. Feel free to
make any adjustment for your setup.
2023-12-14 19:02:45 +01:00
2022-12-18 14:20:19 +01:00
```nix
# home config
2023-02-14 14:30:40 +01:00
{pkgs, ...}: let
2022-12-18 14:20:19 +01:00
flake-compat = builtins.fetchTarball "https://github.com/edolstra/flake-compat/archive/master.tar.gz";
2024-09-01 19:42:51 +02:00
hyprland = (import flake-compat {
2024-05-05 14:56:59 +02:00
# we're not using pkgs.fetchgit as that requires a hash to be provided
src = builtins.fetchGit {
url = "https://github.com/hyprwm/Hyprland.git";
submodules = true;
};
2022-12-18 14:20:19 +01:00
}).defaultNix;
in {
2024-05-05 14:56:59 +02:00
wayland.windowManager.hyprland = {
enable = true;
2024-09-01 19:42:51 +02:00
# set the flake package
package = hyprland.packages.${pkgs.stdenv.hostPlatform.system}.hyprland;
2024-05-05 14:56:59 +02:00
}
2022-12-18 14:20:19 +01:00
}
```
2023-12-14 19:02:45 +01:00
{{< /tab >}}
{{< /tabs >}}
## Usage
2023-12-14 19:02:45 +01:00
Once the module is enabled, you can use it to declaratively configure Hyprland.
Here is an example config:
```nix
# home.nix
2023-12-14 19:02:45 +01:00
{
wayland.windowManager.hyprland.settings = {
"$mod" = "SUPER";
bind =
[
"$mod, F, exec, firefox"
", Print, exec, grimblast copy area"
]
++ (
# workspaces
# binds $mod + [shift +] {1..9} to [move to] workspace {1..9}
builtins.concatLists (builtins.genList (i:
let ws = i + 1;
2023-12-14 19:02:45 +01:00
in [
"$mod, code:1${toString i}, workspace, ${toString ws}"
"$mod SHIFT, code:1${toString i}, movetoworkspace, ${toString ws}"
2023-12-14 19:02:45 +01:00
]
)
9)
2023-12-14 19:02:45 +01:00
);
};
}
```
## Plugins
2023-12-14 19:02:45 +01:00
Hyprland plugins can be added through the `plugins` option:
```nix
{
wayland.windowManager.hyprland.plugins = [
inputs.hyprland-plugins.packages.${pkgs.stdenv.hostPlatform.system}.hyprbars
"/absolute/path/to/plugin.so"
];
}
```
For examples on how to build Hyprland plugins using Nix, see the
[Nix/Plugins](../Plugins) page.
## FAQ
### Fixing problems with themes
If your themes for mouse cursors, icons or windows don't load correctly, try
2023-12-14 19:02:45 +01:00
setting them with `home.pointerCursor` and `gtk.theme`, which enable a bunch of
compatibility options that should make the themes load in all situations.
Example configuration:
2023-12-14 19:02:45 +01:00
```nix
{
home.pointerCursor = {
gtk.enable = true;
# x11.enable = true;
package = pkgs.bibata-cursors;
name = "Bibata-Modern-Classic";
size = 16;
2023-12-14 19:02:45 +01:00
};
gtk = {
enable = true;
theme = {
package = pkgs.flat-remix-gtk;
name = "Flat-Remix-GTK-Grey-Darkest";
};
2023-12-14 19:02:45 +01:00
iconTheme = {
package = pkgs.gnome.adwaita-icon-theme;
name = "Adwaita";
};
font = {
name = "Sans";
size = 11;
};
};
}
```
2024-04-04 09:29:00 +02:00
### Programs don't work in systemd services, but do on the terminal
2024-04-04 09:29:00 +02:00
This problem is related to systemd not importing the environment by default. It
2024-04-04 09:29:00 +02:00
will not have knowledge of `PATH`, so it cannot run the commands in the
services. This is the most common with user-configured services such as
`hypridle` or `swayidle`.
To fix it, add to your config:
```nix
wayland.windowManager.hyprland.systemd.variables = ["--all"];
```
This setting will produce the following entry in the Hyprland config:
```ini
exec-once = dbus-update-activation-environment --systemd --all
```
Make sure to use the above command if you do not use the Home Manager module.