Official NixOS Wiki

KDE: Difference between revisions

← Older edit
Railwhale (talk | contribs)
21 edits
VisualWikitext
imported>Appetrosyan
m Added file template
Railwhale (talk | contribs)
21 edits
Add very dirty workaround for setting locale in system settings
Tags: Mobile edit Mobile web edit Advanced mobile edit
 
(98 intermediate revisions by 49 users not shown)
Line 1: Line 1:
[https://kde.org/plasma-desktop/ KDE Plasma] is a desktop environment that aims to be simple by default, powerful when needed.
== Installation ==
== Installation ==
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
services.xserver.desktopManager.plasma5.enable = true;
</nowiki>}}


== Enable GTK themes in KDE ==
To use KDE Plasma, add this to your configuration.nix:
 
{{file|3={
  # Enable Plasma
  services = {
    desktopManager.plasma6.enable = true;
 
  # Default display manager for Plasma
    displayManager.plasma-login-manager.enable = true;
 
  # Optionally enable xserver
  # xserver.enable = true;
  };
}|name=configuration.nix|lang=nix}}
== Configuration ==
 
=== Excluding applications from the default install ===
 
Some optional packages can be excluded if they are not needed at the cost of functionality.
 
Optional packages: [https://github.com/NixOS/nixpkgs/blob/7e495b747b51f95ae15e74377c5ce1fe69c1765f/nixos/modules/services/desktop-managers/plasma6.nix#L150-L170]
 
{{File|3={
  environment.plasma6.excludePackages = with pkgs.kdePackages; [
    plasma-browser-integration
    konsole
    elisa
  ];
}|name=configuration.nix|lang=nix}}
 
=== Default Wayland/X11 session ===


=== Enable GTK themes in KDE in KDE System Settings ===
Plasma 6 runs on Wayland by default. To launch an X11 session by default:


Nixpkgs now provides the GTK configuration module for KDE system settings, which you can install with:
{{File|3={ 
  services.displayManager.defaultSession = "plasmax11";
}|name=configuration.nix|lang=nix}}


<syntaxhighlight lang="console">$ nix-env -i kde-gtk-config</syntaxhighlight>


You should also install any GTK themes you like. You can choose a GTK theme and set related options in <code>System Settings > Application Appearance > GTK</code>.
=== Unlock KDE Wallet with LUKS password ===


=== Enable GTK themes in KDE manually ===
When using LUKS disk encryption and autologin in your display manager, it is possible to unlock KDE Wallet with the LUKS password. Set the LUKS password, login password, and KWallet keyring password all to the same string, and for NixOS 25.11 and below use the following configuration:
<syntaxhighlight lang="nix">
{
  boot.initrd.systemd.enable = true;
  systemd.services.display-manager.serviceConfig.KeyringMode = "inherit";
  security.pam.services.sddm-autologin.text = pkgs.lib.mkBefore ''
    auth optional ${pkgs.systemd}/lib/security/pam_systemd_loadkey.so
    auth include sddm
  '';
}
</syntaxhighlight>


As a normal nix user you can install the Oxygen GTK theme:
For Plasma Login Manager in NixOS 26.05 or above, use:
<syntaxhighlight lang="nix">
{
  boot.initrd.systemd.enable = true;
  systemd.services.plasmalogin.serviceConfig.KeyringMode = "inherit";
  security.pam.services.plasmalogin-autologin.rules.auth = {
    systemd_loadkey = {
      order = 0;
      control = "optional";
      modulePath = "${pkgs.systemd}/lib/security/pam_systemd_loadkey.so";
    };
    plasmalogin = {
      order = 1;
      control = "include";
      modulePath = "plasmalogin";
    };
  };
}
</syntaxhighlight>


<syntaxhighlight lang="console">$ nix-env -i oxygen-gtk</syntaxhighlight>
== Troubleshooting ==


KDE will run any scripts you place in ~/.kde/env on startup so this is a good place to set the GTK_PATH so that applications can find the theme engine. If the path is wrong/unset you will see errors like this:
=== Qt/KDE applications segfault on start ===


<code>Gtk-WARNING **: Unable to locate theme engine in module_path</code>
This is caused by a stale QML cache [https://github.com/NixOS/nixpkgs/issues/177720 (see this issue)]. A dirty way to fix this is by running on a terminal the following command:
 
<syntaxHighlight lang=sh>
find ${XDG_CACHE_HOME:-$HOME/.cache}/**/qmlcache -type f -delete
</syntaxHighlight>
 
=== GTK themes are not applied in Wayland applications / Window Decorations missing / Cursor looks different ===
This affects GTK applications including Firefox and Thunderbird.
 
You may need to set a GTK theme ''Breeze'' imitating the KDE theme with the same name in ''System Settings -> Application Style -->Configure GNOME/GTK Application Style''.
 
[https://github.com/NixOS/nixpkgs/issues/180720 (See this issue)]
 
=== After Update to Plasma 6 Signal-Desktop complains about a Database Error involving kwallet5 ===
 
# Close Signal
# Open ~/.config/Signal/config.json
# Replace <code>"safeStorageBackend": "kwallet5"</code> with <code>"safeStorageBackend": "kwallet6"</code> (change 5 to 6)
# Start Signal
 
=== Bluetooth configuration not available ===
 
Add the following configuration (generally in hardware-configuration.nix):
 
<syntaxHighlight lang=nix>
hardware.bluetooth.enable = true;
</syntaxHighlight>
 
This will add the following packages:
 
<syntaxHighlight lang=nix>
[
bluedevil
bluez-qt
pkgs.openobex
pkgs.obexftp
]
</syntaxHighlight>
 
=== Brightness and Color brightness control sets gamma instead of brightness on external monitors ===
To allow <code>powerdevil</code> (and by extension the "Brightness and Color" status tray menu) to control brightness on supported monitors directly instead of adjusting gamma, [[Backlight#Via ddcutil|configure your system to enable ddcutil]], and allow your user to use DDC/CI without root. Note that you do not need to add <code>ddcutil</code> to your system packages because PowerDevil uses libddcutil.
 
=== Plasma wallpaper reverts back to default after a Nix GC ===
When setting a wallpaper, Plasma may save the path as a <code>/nix/store/*/share/wallpapers</code> path instead of <code>/run/current-system/sw/share/wallpapers/</code>. To fix this, open <code>$XDG_CONFIG_HOME/plasma-org.kde.plasma.desktop-appletsrc</code> and manually change the paths.
 
=== No available locale settings in the Plasma system settings ===
The "Region & Language" page in the Plasma system settings is somewhat broken on NixOS. Instead, edit the <code>$XDG_CONFIG_HOME/plasma-localerc</code> file.
 
If you really want to configure locale in settings, you can use this workaround:
<syntaxhighlight lang="nix">
{ pkgs, ... }:
{
  i18n = {
    extraLocales = "all";
    imperativeLocale = true; # Unknown if needed (system settings sets user-level override?)
  };
  environment = {
    systemPackages = [ pkgs.stdenv.cc.libc.out ]; # this derivation contains the locales
    pathsToLink = [ "/share/i18n" ];
  };
}
</syntaxhighlight>
 
Switch to that configuration, then run:


To set Oxygen-GTK as the gtk theme create the following file and make it executable: ~/.kde/env/set-gtk-theme.sh
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
#!/bin/sh
sudo mkdir -p /usr/share/i18n
sudo ln -s /run/current-system/sw/share/i18n/locales /usr/share/i18n/locales
</syntaxhighlight>
That is a very dirty command, and I don't know if it persists across reboots.
 
== Tips and tricks ==
 
=== Plasma-Manager ===
 
{{note|  [https://github.com/nix-community/plasma-manager Plasma-Manager] is a community project}}
By default, the Plasma configuration can be handled like on [https://wiki.archlinux.org/title/KDE traditional systems].
With [https://github.com/nix-community/plasma-manager plasma-manager], it is possible to make Plasma configurations via nix by providing [https://github.com/nix-community/home-manager home-manager] modules.
 
=== User icon (avatar) ===
You can add a profile picture to your user by using a png file in <code>~/.face.icon</code>.
 
== Hacking ==
There are many reasons to modify the KDE packages, such as testing patches from other KDE developers, applying a fix before it is officially released and finds its way into ''nixpkgs'' or developing contributions for the KDE project.
 
=== Customizing ''nixpkgs'' ===
To override KDE packages, the common way using <code>overrideAttrs</code> won't work, since they are part of the <code>kdePackages</code>scope, which requires the usage of <code>overrideScope</code> first:<syntaxhighlight lang="nix">
nixpkgs-overlay = final: prev: {
  kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
    somepackage = kdePrev.somepackage.overrideAttrs(prevPkgAttrs: {
      someattribute = …;
    };
  };
};
</syntaxhighlight>The following examples will demonstrate various ways how to achieve the customization of the KDE package <code>powerdevil</code> in different scenarios:
 
==== Using a single diff from a remote URL ====
A KDE developer might have provided a diff that one wants to utilize locally to test it or to make use of it until it's included in an upcoming release.


export GTK_PATH=$GTK_PATH:~/.nix-profile/lib/gtk-2.0
# Generate the SRI hash of the file: <code>nix store prefetch-file <nowiki>https://invent.kde.org/plasma/powerdevil/-/commit/f731c18e377b87c57f7205d9c1812a34f588c577.diff</nowiki> --json --name toggle-nightlight.diff</code>
export GTK2_RC_FILES=$GTK2_RC_FILES:~/.nix-profile/share/themes/oxygen-gtk/gtk-2.0/gtkrc
# Override the <code>patches</code> attribute of the <code>powerdevil</code>package:<syntaxhighlight lang="nix">
kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
  powerdevil = kdePrev.powerdevil.overrideAttrs (prevPdAttrs: {
    patches = prevPdAttrs.patches or [] ++ [
      (prev.fetchpatch {
        name = "toggle-nightlight.diff";
        url = "https://invent.kde.org/plasma/powerdevil/-/commit/f731c18e377b87c57f7205d9c1812a34f588c577.diff";
        sha256 = "sha256-X0ZHSRnSLqmp2fcLGx9DUTn7F9BFh5puh9Q4YAj6/5o=";
      })
    ];
  });
});
</syntaxhighlight>
</syntaxhighlight>


Alternatively, on NixOS:
==== Using commits of a repository ====
Either a local clone or remote repository might provide the code that should be used to build the package in question instead.


{{file|configuration.nix|nix|<nowiki>
===== Remote repository =====
environment = {
<syntaxhighlight lang="nix">
   systemPackages = [ pkgs.oxygen_gtk ];
kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
  shellInit = ''
   powerdevil = kdePrev.powerdevil.overrideAttrs (prevPdAttrs: {
    export GTK_PATH=$GTK_PATH:${pkgs.oxygen_gtk}/lib/gtk-2.0
    src = builtins.fetchGit {
     export GTK2_RC_FILES=$GTK2_RC_FILES:${pkgs.oxygen_gtk}/share/themes/oxygen-gtk/gtk-2.0/gtkrc
      url = "https://invent.kde.org/plasma/powerdevil";
   '';
      rev = "f731c18e377b87c57f7205d9c1812a34f588c577";
};
     };
</nowiki>}}
   });
});
 
</syntaxhighlight>


Or alternatively, copy the themes folder in the home directory
===== Local repository =====
{{Note|This will ignore files that are present in the worktree, but not committed yet.}}
<syntaxhighlight lang="nix">
kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
  powerdevil = kdePrev.powerdevil.overrideAttrs (prevPdAttrs: {
    src = builtins.fetchGit {
      url = "file:///home/eliasp/code-repositories/public/KDE/plasma/powerdevil";
      rev = "f731c18e377b87c57f7205d9c1812a34f588c577";
    };
  });
});


<syntaxhighlight lang="console">
$ cp -R ~/.nix-profile/share/themes/ ~/.themes
</syntaxhighlight>
</syntaxhighlight>


[[Category:Desktop environments]]
==== Using the worktree of a local repository ====
{{Note|Since this relies on reading directly from the filesystem during the build, the impure mode has to be used, e.g.: <code>nixos-rebuild --impure …</code>}}
Now one might not want to commit each and every change during development to iterate more quickly, but to just rebuild after having saved the latest changes.
 
By just redirecting <code>src</code>to the path of the working directory, where the required code resides, quick & dirty rebuilds are possible:<syntaxhighlight lang="nix">
kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
  powerdevil = kdePrev.powerdevil.overrideAttrs (prevPdAttrs: {
    src = /home/eliasp/code-repositories/public/KDE/plasma/powerdevil;
  });
});
 
</syntaxhighlight>
[[Category:Desktop environment]]
[[Category:Applications]]
[[Category:KDE]]
Retrieved from "https://wiki.nixos.org/wiki/KDE"