Official NixOS Wiki

KDE: Difference between revisions

← Older edit
Arch is the best (talk | contribs)
23 edits
VisualWikitext
imported>Matthias Thym
Added information for using KDE Plasma 6
Don't need ddcutil in system packages
 
(76 intermediate revisions by 33 users not shown)
Line 1: Line 1:
KDE Plasma is a desktop environment that aims to be simple by default, powerful when needed.
[https://kde.org/plasma-desktop/ KDE Plasma] is a desktop environment that aims to be simple by default, powerful when needed.


== Installation ==
== Installation ==
Line 5: Line 5:
To use KDE Plasma, add this to your configuration.nix:
To use KDE Plasma, add this to your configuration.nix:


<syntaxHighlight lang=nix>
{{file|3={
services.xserver.enable = true;
  # Enable Plasma
services.xserver.displayManager.sddm.enable = true;
  services.desktopManager.plasma6.enable = true;
services.xserver.desktopManager.plasma5.enable = true;
 
# KDE Plasma 6 is now available on unstable
  # Default display manager for Plasma
# services.xserver.desktopManager.plasma6.enable = true;
  services.displayManager.sddm = {
</syntaxHighlight>
    enable = true;
 
  # To use Wayland (Experimental for SDDM)
    wayland.enable = true;
  };
 
  # Optionally enable xserver
  services.xserver.enable = true;
}|name=configuration.nix|lang=nix}}{{Warning|[[SDDM]] is no longer supported on the unstable branch, users on unstable should use [[Plasma Login Manager]] instead. See configuration options on the Plasma Login Manager page.}}
 
== Configuration ==
 
=== Excluding applications from the default install ===


=== Excluding some KDE Plasma applications from the default install ===
Some optional packages can be excluded if they are not needed at the cost of functionality.


==== Plasma 5 ====
Optional packages: [https://github.com/NixOS/nixpkgs/blob/7e495b747b51f95ae15e74377c5ce1fe69c1765f/nixos/modules/services/desktop-managers/plasma6.nix#L150-L170]


Not all applications that come pre-installed with the KDE Plasma desktop environment are desirable for everyone to have on their machines. There's a way to edit configuration.nix to exclude some [https://github.com/NixOS/nixpkgs/blob/nixos-23.11/nixos/modules/services/x11/desktop-managers/plasma5.nix#L275-L284 optional packages], for example as follows:
{{File|3={
  environment.plasma6.excludePackages = with pkgs.kdePackages; [
    plasma-browser-integration
    konsole
    elisa
  ];
}|name=configuration.nix|lang=nix}}


<syntaxHighlight lang=nix>
=== Default Wayland/X11 session ===
environment.plasma5.excludePackages = with pkgs.libsForQt5; [
  plasma-browser-integration
  konsole
  oxygen
];
</syntaxHighlight>


==== Plasma 6 ====
Plasma 6 runs on Wayland by default. To launch an X11 session by default:


<syntaxHighlight lang=nix>
{{File|3={ 
environment.plasma6.excludePackages = with pkgs.kdePackages; [
  services.displayManager.defaultSession = "plasmax11";
  plasma-browser-integration
}|name=configuration.nix|lang=nix}}
  konsole
  oxygen
];
</syntaxHighlight>


== Configuration ==


=== GNOME desktop integration ===
=== Unlock KDE Wallet with LUKS password ===


Using the following example configuration, QT applications will have a look similar to the [[GNOME]] desktop, using a dark theme
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>


<syntaxHighlight lang=nix>
For Plasma Login Manager in NixOS 26.05 or above, use:
qt = {
<syntaxhighlight lang="nix">
   enable = true;
{
   platformTheme = "gnome";
   boot.initrd.systemd.enable = true;
   style = "adwaita-dark";
   systemd.services.plasmalogin.serviceConfig.KeyringMode = "inherit";
};
   security.pam.services.plasmalogin-autologin.rules.auth = {
</syntaxHighlight>
    systemd_loadkey = {
      order = 0;
      control = "optional";
      modulePath = "${pkgs.systemd}/lib/security/pam_systemd_loadkey.so";
    };
    plasmalogin = {
      order = 1;
      control = "include";
      modulePath = "plasmalogin";
    };
  };
}
</syntaxhighlight>


== Troubleshoots ==
== Troubleshooting ==


=== Qt/KDE applications segfault on start ===
=== Qt/KDE applications segfault on start ===
Line 64: Line 93:
This affects GTK applications including Firefox and Thunderbird.
This affects GTK applications including Firefox and Thunderbird.


Add to your configuration.nix the following line:
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>
<syntaxHighlight lang=nix>
programs.dconf.enable = true;
[
bluedevil
bluez-qt
pkgs.openobex
pkgs.obexftp
]
</syntaxHighlight>
</syntaxHighlight>


You might also 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''.
=== 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.


[https://github.com/NixOS/nixpkgs/issues/180720 (See this issue)]
=== 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.


=== KMail Renders Blank Messages ===
=== 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.


When you see the message <code>grantlee.template: "Plugin library 'kde_grantlee_plugin' not found."</code> and/or kmail does shows only empty message then add to your configuration.nix the following line:
== Tips and tricks ==


<syntaxHighlight lang=nix>
=== Plasma-Manager ===
environment.sessionVariables = {
  NIX_PROFILES = "${pkgs.lib.concatStringsSep " " (pkgs.lib.reverseList config.environment.profiles)}";
};
</syntaxHighlight>


[https://github.com/NixOS/nixpkgs/issues/160599 (See this issue)]
{{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.


=== Launch KDE in Wayland session ===
=== User icon (avatar) ===
You can add a profile picture to your user by using a png file in <code>~/.face.icon</code>.


==== Plasma 5 ====
== 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.


<syntaxHighlight lang=nix>
=== Customizing ''nixpkgs'' ===
services.xserver.displayManager.defaultSession = "plasmawayland";
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">
</syntaxHighlight>
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:


==== Plasma 6 ====
==== 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.


For KDE Plasma 6, the defaults have changed. KDE Plasma 6 runs on Wayland with the default session set to <code>plasma</code>.
# 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>
If you want to use the X11 session as your default session, change it to <code>plasmax11</code>.
# Override the <code>patches</code> attribute of the <code>powerdevil</code>package:<syntaxhighlight lang="nix">
<syntaxHighlight lang=nix>
kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
services.xserver.displayManager.defaultSession = "plasma";
  powerdevil = kdePrev.powerdevil.overrideAttrs (prevPdAttrs: {
</syntaxHighlight>
    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>


==== Launch SDDM in Wayland too ====
==== 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.


It's possible to launch sddm in Wayland too to try to avoid running an X server.
===== Remote repository =====
<syntaxhighlight lang="nix">
kdePackages = prev.kdePackages.overrideScope(kdeFinal: kdePrev: {
  powerdevil = kdePrev.powerdevil.overrideAttrs (prevPdAttrs: {
    src = builtins.fetchGit {
      url = "https://invent.kde.org/plasma/powerdevil";
      rev = "f731c18e377b87c57f7205d9c1812a34f588c577";
    };
  });
});


<syntaxHighlight lang=nix>
</syntaxhighlight>
services.xserver.displayManager.sddm.wayland.enable = true;
</syntaxHighlight>


=== Plasma-Manager ===
===== 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";
    };
  });
});


{{note|  [https://github.com/pjones/plasma-manager Plasma-Manager] is not matured yet and currently unofficial }}
</syntaxhighlight>
On default the plasma configuration can be handeld like on [https://wiki.archlinux.org/title/KDE traditional systems].
With [https://github.com/pjones/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.


==== 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:Desktop environment]]
[[Category:Applications]]
[[Category:Applications]]
[[Category:KDE]]
Retrieved from "https://wiki.nixos.org/wiki/KDE"