Official NixOS Wiki

Niri: Difference between revisions

← Older edit
LuckShiba (talk | contribs)
1 edit
VisualWikitext
RhenCloud (talk | contribs)
46 edits
mNo edit summary
m Update niri casing to lowercase "niri"
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:niri}}
{{infobox application
{{infobox application
| name = Niri
| name = niri
| type = Wayland compositor
| type = Wayland compositor
| initialRelease = 2023-11-26
| initialRelease = 2023-11-26
Line 7: Line 8:
| os = Linux, FreeBSD
| os = Linux, FreeBSD
| programmingLanguage = Rust, GLSL
| programmingLanguage = Rust, GLSL
| github = YaLTeR/niri
| github = niri-wm/niri
| documentation = [https://yalter.github.io/niri/ Official wiki], [https://github.com/sodiboo/niri-flake/blob/main/docs.md niri-flake]
| documentation = [https://yalter.github.io/niri/ Official wiki], [https://github.com/sodiboo/niri-flake/blob/main/docs.md niri-flake]
| image = Niri-icon.svg
| image = Niri-icon.svg
| bugTracker = https://github.com/YaLTeR/niri/issues
| bugTracker = https://github.com/niri-wm/niri/issues
| latestRelease = 25.11; 29 Nov 2025
| latestRelease = 25.11; 29 Nov 2025
}}
}}
Line 20: Line 21:


Simply enable {{nixos:option|programs.niri}}:
Simply enable {{nixos:option|programs.niri}}:
</translate>


{{file|/etc/nixos/configuration.nix|nix|3=
{{file|/etc/nixos/configuration.nix|nix|3=
Line 25: Line 27:
}}
}}


{{Note|Niri can be enabled <strong>without installing a custom flake</strong> such as [https://github.com/sodiboo/niri-flake niri-flake]. {{ic|niri-flake}} is only necessary if you want to use a very recent version of Niri or if you want to write configurations in the Nix language, although as of 2025 this repository is listed near the top in search engines.}}
{{Note|<translate>Niri can be enabled <strong>without installing a custom flake</strong> such as [https://github.com/sodiboo/niri-flake niri-flake]. {{ic|niri-flake}} is only necessary if you would like to use a very recent version of Niri or if you would want to write configurations in the Nix language, although as of 2025 this repository is listed near the top in search engines.</translate>}}


{{Warning|Without [[#Configuration]] or [[#Additional Setup]], or in other words after fresh installation, you may be unable to launch apps because of missing Alacritty and fuzzel. Press <kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> to exit Niri and proceed to one of them.}}
{{Warning|<translate>Without [[#Configuration]] or [[#Additional Setup]], or after a fresh installation, you may be unable to launch apps due to missing expected programs such as Alacritty and fuzzel. Press <kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> to exit niri and proceed to one of them.</translate>}}


<translate>
== Configuration ==
== Configuration ==


The configuration path for Niri is {{ic|$XDG_CONFIG_HOME/niri/config.kdl}}. Therefore [[Home Manager]] can be used for configuration:
The configuration path for niri is {{ic|$XDG_CONFIG_HOME/niri/config.kdl}}. Therefore [[Home Manager]] can be used for configuration:
</translate>


{{file|~/.config/home-manager/home.nix|nix|3=
{{file|~/.config/home-manager/home.nix|nix|3=
Line 37: Line 41:
}}
}}


<translate>
You might want to start from [https://github.com/YaLTeR/niri/blob/main/resources/default-config.kdl the default configuration file] described at [https://github.com/YaLTeR/niri/wiki/Getting-Started#main-default-hotkeys].
You might want to start from [https://github.com/YaLTeR/niri/blob/main/resources/default-config.kdl the default configuration file] described at [https://github.com/YaLTeR/niri/wiki/Getting-Started#main-default-hotkeys].


See [https://yalter.github.io/niri/ the wiki] for configuration options for Niri.
See [https://yalter.github.io/niri/ the wiki] for configuration options for niri.


== Additional Setup ==
== Additional Setup ==


As described in [https://github.com/YaLTeR/niri/wiki/Example-systemd-Setup Example systemd Setup (Niri wiki)], you might want to set up some additional services including [[Swayidle]], [[Swaylock]], [[Waybar]], [[Polkit]] and [[Secret Service]] as follows to complement the functionality of a regular window manager. Some of the these settings are also required to enable all the features of [https://github.com/YaLTeR/niri/blob/main/resources/default-config.kdl the default configuration file].
As described in [https://github.com/YaLTeR/niri/wiki/Example-systemd-Setup Example systemd Setup (niri wiki)], you might want to set up some additional services including [[Swayidle]], [[Swaylock]], [[Waybar]], [[Polkit]] and [[Secret Service]] as follows to complement the functionality of a regular window manager. Some of the these settings are also required to enable all the features of [https://github.com/YaLTeR/niri/blob/main/resources/default-config.kdl the default configuration file].
</translate>


{{file|3=
{{file|3=
Line 65: Line 71:
|name=~/.config/home-manager/home.nix|lang=nix}}
|name=~/.config/home-manager/home.nix|lang=nix}}


<translate>
== Troubleshooting ==
== Troubleshooting ==


Line 70: Line 77:


There is a general workaround to set {{ic|NIXOS_OZONE_WL}} as described in [[Wayland#Electron_and_Chromium]]:
There is a general workaround to set {{ic|NIXOS_OZONE_WL}} as described in [[Wayland#Electron_and_Chromium]]:
</translate>


{{file|/etc/nixos/configuration.nix|nix|3=
{{file|/etc/nixos/configuration.nix|nix|3=
Line 75: Line 83:
}}
}}


However, since Niri does not support text-input-v1, sometimes enabling text-input-v3 by manually adding {{ic|<nowiki>--wayland-text-input-version=3</nowiki>}} flag is necessary for IME to work:
<translate>
However, since niri does not support text-input-v1, sometimes enabling text-input-v3 by manually adding {{ic|<nowiki>--wayland-text-input-version=3</nowiki>}} flag is necessary for IME to work:
</translate>


{{code|<nowiki>slack --wayland-text-input-version=3</nowiki>}}
{{code|<nowiki>slack --wayland-text-input-version=3</nowiki>}}


Alternatively, if the package supports {{ic|commandLineArgs}}, the following may be used instead:
<translate>
<code>wrapProgram</code> may be used to add the flag automatically:
</translate>


{{code|<nowiki>(pkgs.vscode.override {
{{file|/etc/nixos/configuration.nix|nix|3=
  commandLineArgs = [
environment.systemPackages = [
     "--wayland-text-input-version=3"
  (pkgs.symlinkJoin {
   ];
    pname = pkgs.vscode.pname;
});</nowiki>}}
    paths = [ pkgs.vscode ];
    buildInputs = [ pkgs.makeWrapper ];
     postBuild = "wrapProgram $out/bin/code --add-flags --wayland-text-input-version=3";
   };)
];}}


<translate>
=== XWayland apps not working ===
=== XWayland apps not working ===
There is a optional dependency for Niri which is highly recommended to install (you can read [https://github.com/YaLTeR/niri/wiki/Xwayland this] article to learn more about this)
 
There is a optional dependency for niri which is highly recommended to install (you can read [https://github.com/YaLTeR/niri/wiki/Xwayland this] article to learn more about this)
</translate>


{{File|3=environment.systemPackages = with pkgs; [  
{{File|3=environment.systemPackages = with pkgs; [  
Line 94: Line 113:
];|name=/etc/nixos/configuration.nix|lang=nix}}
];|name=/etc/nixos/configuration.nix|lang=nix}}


<translate>
Or using [[Home Manager]]
Or using [[Home Manager]]
</translate>


{{File|3=home.packages = with pkgs; [
{{File|3=home.packages = with pkgs; [
Line 100: Line 121:
];|name=~/.config/home-manager/home.nix|lang=nix}}
];|name=~/.config/home-manager/home.nix|lang=nix}}


After you installed {{ic|xwayland-satellite}} Niri will integrate it out of the box and all of your XWayland apps will function properly.
<translate>
After you installed {{ic|xwayland-satellite}} niri will integrate it out of the box and all of your XWayland apps will function properly.


=== File picker not working ===
=== File picker not working ===
If you are using <code>xdg-desktop-portal-gnome</code>, it will attempt to use Nautilus as the file picker, which will fail if Nautilus is not installed.
If you are using <code>xdg-desktop-portal-gnome</code>, it will attempt to use Nautilus as the file picker, which will fail if Nautilus is not installed.


To work around this problem, you can force usage of the gtk or kde portals for file picker instead:
To work around this problem, you can force usage of the gtk or kde portals for file picker instead:
</translate>
{{File|3=xdg.portal.config.niri = {
{{File|3=xdg.portal.config.niri = {
   "org.freedesktop.impl.portal.FileChooser" = [ "gtk" ]; # or "kde"
   "org.freedesktop.impl.portal.FileChooser" = [ "gtk" ]; # or "kde"
};|name=/etc/nixos/configuration.nix|lang=nix}}
};|name=/etc/nixos/configuration.nix|lang=nix}}


<translate>
== See Also ==
== See Also ==


Retrieved from "https://wiki.nixos.org/wiki/Niri"