···
-
xcfg = config.services.xserver;
-
cfg = xcfg.desktopManager.plasma5;
-
# Use only for **internal** options.
-
# This is not exactly user-friendly.
-
description = "KDE Configuration value";
-
set = (nullOr (lazyAttrsOf valueTypes)) // {
-
description = "KDE Configuration set";
-
emptyValue.value = { };
-
description = "KDE Configuration file";
-
emptyValue.value = { };
-
# The KDE icon cache is supposed to update itself automatically, but it uses
-
# the timestamp on the icon theme directory as a trigger. This doesn't work
-
# on NixOS because the timestamp never changes. As a workaround, delete the
-
# icon cache at login and session activation.
-
# See also: http://lists-archives.org/kde-devel/26175-what-when-will-icon-cache-refresh.html
-
rm -fv "$HOME"/.cache/icon-cache.kcache
-
# xdg-desktop-settings generates this empty file but
-
# it makes kbuildsyscoca5 fail silently. To fix this
-
# remove that menu if it exists.
-
rm -fv "''${XDG_CONFIG_HOME}"/menus/applications-merged/xdg-desktop-menu-dummy.menu
-
# Qt writes a weird ‘libraryPath’ line to
-
# ~/.config/Trolltech.conf that causes the KDE plugin
-
# paths of previous KDE invocations to be searched.
-
# Obviously using mismatching KDE libraries is potentially
-
# disastrous, so here we nuke references to the Nix store
-
# in Trolltech.conf. A better solution would be to stop
-
# Qt from doing this wackiness in the first place.
-
trolltech_conf="''${XDG_CONFIG_HOME}/Trolltech.conf"
-
if [ -e "$trolltech_conf" ]; then
-
${getBin pkgs.gnused}/bin/sed -i "$trolltech_conf" -e '/nix\\store\|nix\/store/ d'
-
# Remove the kbuildsyscoca5 cache. It will be regenerated
-
# immediately after. This is necessary for kbuildsyscoca5 to
-
# recognize that software that has been removed.
-
rm -fv "$HOME"/.cache/ksycoca*
-
${pkgs.plasma5Packages.kservice}/bin/kbuildsycoca5
-
set_XDG_CONFIG_HOME = ''
-
# Set the default XDG_CONFIG_HOME if it is unset.
-
# Per the XDG Base Directory Specification:
-
# https://specifications.freedesktop.org/basedir-spec/latest
-
# 1. Never export this variable! If it is unset, then child processes are
-
# expected to set the default themselves.
-
# 2. Contaminate / if $HOME is unset; do not check if $HOME is set.
-
XDG_CONFIG_HOME=''${XDG_CONFIG_HOME:-$HOME/.config}
-
services.xserver.desktopManager.plasma5 = {
-
description = "Enable the Plasma 5 (KDE 5) desktop environment.";
-
phononBackend = mkOption {
-
description = "Phonon audio backend to install.";
-
useQtScaling = mkOption {
-
description = "Enable HiDPI scaling in Qt.";
-
runUsingSystemd = mkOption {
-
description = "Use systemd to manage the Plasma session";
-
notoPackage = mkPackageOption pkgs "Noto fonts" {
-
default = [ "noto-fonts" ];
-
example = "noto-fonts-lgc-plus";
-
# Internally allows configuring kdeglobals globally
-
kdeglobals = mkOption {
-
type = kdeConfigurationType;
-
# Internally allows configuring kwin globally
-
type = kdeConfigurationType;
-
mobile.enable = mkOption {
-
Enable support for running the Plasma Mobile shell.
-
mobile.installRecommendedSoftware = mkOption {
-
Installs software recommended for use with Plasma Mobile, but which
-
is not strictly required for Plasma Mobile to run.
-
bigscreen.enable = mkOption {
-
Enable support for running the Plasma Bigscreen session.
-
environment.plasma5.excludePackages = mkOption {
-
description = "List of default packages to exclude from the configuration";
-
type = types.listOf types.package;
-
example = literalExpression "[ pkgs.plasma5Packages.oxygen ]";
-
(mkRemovedOptionModule [
-
] "Phonon no longer supports Qt 4.")
-
(mkRemovedOptionModule [
-
] "DDC/CI is no longer supported upstream.")
-
[ "services" "xserver" "desktopManager" "kde5" ]
-
[ "services" "xserver" "desktopManager" "plasma5" ]
-
[ "services" "xserver" "desktopManager" "plasma5" "excludePackages" ]
-
[ "environment" "plasma5" "excludePackages" ]
-
# Common Plasma dependencies
-
(mkIf (cfg.enable || cfg.mobile.enable || cfg.bigscreen.enable) {
-
"Plasma 5 has been deprecated and will be removed in NixOS 25.11. Please migrate your configuration to Plasma 6."
-
capabilities = "cap_sys_nice+ep";
-
source = "${getBin pkgs.plasma5Packages.kwin}/bin/kwin_wayland";
-
// optionalAttrs (!cfg.runUsingSystemd) {
-
source = "${getBin pkgs.plasma5Packages.kinit}/libexec/kf5/start_kdeinit";
-
environment.systemPackages =
-
with pkgs.plasma5Packages;
-
kirigami2 # In system profile for SDDM theme. TODO: wrapper.
-
plasma-workspace-wallpapers
-
pkgs.hicolor-icon-theme
-
pkgs.xdg-user-dirs # Update user dirs as described in https://freedesktop.org/wiki/Software/xdg-user-dirs/
-
pkgs.aha # needed by kinfocenter for fwupd support
-
plasma-browser-integration
-
(lib.getBin qttools) # Expose qdbus in PATH
-
++ utils.removePackagesByName optionalPackages config.environment.plasma5.excludePackages
-
++ lib.optional (cfg.phononBackend == "gstreamer") pkgs.plasma5Packages.phonon-backend-gstreamer
-
++ lib.optional (cfg.phononBackend == "vlc") pkgs.plasma5Packages.phonon-backend-vlc
-
# Optional hardware support features
-
++ lib.optionals config.hardware.bluetooth.enable [
-
++ lib.optional config.networking.networkmanager.enable plasma-nm
-
++ lib.optional config.services.pulseaudio.enable plasma-pa
-
++ lib.optional config.services.pipewire.pulse.enable plasma-pa
-
++ lib.optional config.powerManagement.enable powerdevil
-
++ lib.optional config.services.colord.enable pkgs.colord-kde
-
++ lib.optional config.services.hardware.bolt.enable pkgs.plasma5Packages.plasma-thunderbolt
-
++ lib.optional config.services.samba.enable kdenetwork-filesharing
-
++ lib.optional config.services.xserver.wacom.enable pkgs.wacomtablet
-
++ lib.optional config.services.flatpak.enable flatpak-kcm;
-
# Extra services for D-Bus activation
-
services.dbus.packages = [
-
pkgs.plasma5Packages.kactivitymanagerd
-
environment.pathsToLink = [
-
# FIXME: modules should link subdirs of `/share` rather than relying on this
-
environment.etc."X11/xkb".source = xcfg.xkb.dir;
-
environment.sessionVariables = {
-
PLASMA_USE_QT_SCALING = mkIf cfg.useQtScaling "1";
-
# Needed for things that depend on other store.kde.org packages to install correctly,
-
# notably Plasma look-and-feel packages (a.k.a. Global Themes)
-
# FIXME: this is annoyingly impure and should really be fixed at source level somehow,
-
# but kpackage is a library so we can't just wrap the one thing invoking it and be done.
-
# This also means things won't work for people not on Plasma, but at least this way it
-
# works for SOME people.
-
KPACKAGE_DEP_RESOLVERS_PATH = "${pkgs.plasma5Packages.frameworkintegration.out}/libexec/kf5/kpackagehandlers";
-
# Enable GTK applications to load SVG icons
-
programs.gdk-pixbuf.modulePackages = [ pkgs.librsvg ];
-
fonts.packages = with pkgs; [
-
fonts.fontconfig.defaultFonts = {
-
sansSerif = [ "Noto Sans" ];
-
serif = [ "Noto Serif" ];
-
programs.gnupg.agent.pinentryPackage = mkDefault pkgs.pinentry-qt;
-
programs.ssh.askPassword = mkDefault "${pkgs.plasma5Packages.ksshaskpass.out}/bin/ksshaskpass";
-
# Enable helpful DBus services.
-
services.accounts-daemon.enable = true;
-
programs.dconf.enable = true;
-
# when changing an account picture the accounts-daemon reads a temporary file containing the image which systemsettings5 may place under /tmp
-
systemd.services.accounts-daemon.serviceConfig.PrivateTmp = false;
-
services.power-profiles-daemon.enable = mkDefault true;
-
services.system-config-printer.enable = mkIf config.services.printing.enable (mkDefault true);
-
services.udisks2.enable = true;
-
services.upower.enable = config.powerManagement.enable;
-
services.libinput.enable = mkDefault true;
-
# Extra UDEV rules used by Solid
-
services.udev.packages = [
-
# libmtp has "bin", "dev", "out" outputs. UDEV rules file is in "out".
-
# Enable screen reader by default
-
services.orca.enable = mkDefault true;
-
services.displayManager.sddm = {
-
theme = mkDefault "breeze";
-
security.pam.services.kde = {
-
allowNullPassword = true;
-
security.pam.services.login.kwallet.enable = true;
-
systemd.user.services = {
-
plasma-early-setup = mkIf cfg.runUsingSystemd {
-
description = "Early Plasma setup";
-
wantedBy = [ "graphical-session-pre.target" ];
-
serviceConfig.Type = "oneshot";
-
script = activationScript;
-
xdg.icons.enable = true;
-
xdg.portal.enable = true;
-
xdg.portal.extraPortals = [ pkgs.plasma5Packages.xdg-desktop-portal-kde ];
-
xdg.portal.configPackages = mkDefault [ pkgs.plasma5Packages.xdg-desktop-portal-kde ];
-
# xdg-desktop-portal-kde expects PipeWire to be running.
-
services.pipewire.enable = mkDefault true;
-
# Update the start menu for each user that is currently logged in
-
system.userActivationScripts.plasmaSetup = activationScript;
-
programs.firefox.nativeMessagingHosts.packages = [
-
pkgs.plasma5Packages.plasma-browser-integration
-
programs.chromium.enablePlasmaBrowserIntegration = true;
-
(mkIf (cfg.kwinrc != { }) {
-
environment.etc."xdg/kwinrc".text = lib.generators.toINI { } cfg.kwinrc;
-
(mkIf (cfg.kdeglobals != { }) {
-
environment.etc."xdg/kdeglobals".text = lib.generators.toINI { } cfg.kdeglobals;
-
# Seed our configuration into nixos-generate-config
-
system.nixos-generate-config.desktopConfiguration = [
-
# Enable the Plasma 5 Desktop Environment.
-
services.displayManager.sddm.enable = true;
-
services.xserver.desktopManager.plasma5.enable = true;
-
services.displayManager.sessionPackages = [ pkgs.plasma5Packages.plasma-workspace ];
-
# Default to be `plasma` (X11) instead of `plasmawayland`, since plasma wayland currently has
-
# See: https://github.com/NixOS/nixpkgs/issues/143272
-
services.displayManager.defaultSession = mkDefault "plasma";
-
environment.systemPackages =
-
with pkgs.plasma5Packages;
-
kdegraphics-thumbnailers
-
++ utils.removePackagesByName optionalPackages config.environment.plasma5.excludePackages;
-
systemd.user.services = {
-
plasma-run-with-systemd = {
-
description = "Run KDE Plasma via systemd";
-
wantedBy = [ "basic.target" ];
-
serviceConfig.Type = "oneshot";
-
${pkgs.plasma5Packages.kconfig}/bin/kwriteconfig5 \
-
--file startkderc --group General --key systemdBoot ${lib.boolToString cfg.runUsingSystemd}
-
(mkIf cfg.mobile.enable {
-
# The user interface breaks without NetworkManager
-
assertion = config.networking.networkmanager.enable;
-
message = "Plasma Mobile requires NetworkManager.";
-
# The user interface breaks without bluetooth
-
assertion = config.hardware.bluetooth.enable;
-
message = "Plasma Mobile requires Bluetooth.";
-
# The user interface breaks without pulse
-
config.services.pulseaudio.enable
-
|| (config.services.pipewire.enable && config.services.pipewire.pulse.enable);
-
message = "Plasma Mobile requires a Pulseaudio compatible sound server.";
-
environment.systemPackages =
-
with pkgs.plasma5Packages;
-
# Basic packages without which Plasma Mobile fails to work properly.
-
++ lib.optionals (cfg.mobile.installRecommendedSoftware) (
-
with pkgs.plasma5Packages.plasmaMobileGear;
-
# Additional software made for Plasma Mobile.
-
# The following services are needed or the UI is broken.
-
hardware.bluetooth.enable = true;
-
networking.networkmanager.enable = true;
-
# Required for autorotate
-
hardware.sensor.iio.enable = lib.mkDefault true;
-
# Recommendations can be found here:
-
# - https://invent.kde.org/plasma-mobile/plasma-phone-settings/-/tree/master/etc/xdg
-
# This configuration is the minimum required for Plasma Mobile to *work*.
-
services.xserver.desktopManager.plasma5 = {
-
# This forces a numeric PIN for the lockscreen, which is the
-
# recommendation from upstream.
-
LookAndFeelPackage = lib.mkDefault "org.kde.plasma.phone";
-
"InputMethod[$e]" = "/run/current-system/sw/share/applications/com.github.maliit.keyboard.desktop";
-
"VirtualKeyboardEnabled" = "true";
-
"org.kde.kdecoration2" = {
-
# No decorations (title bar)
-
NoPlugin = lib.mkDefault "true";
-
services.displayManager.sessionPackages = [ pkgs.plasma5Packages.plasma-mobile ];
-
(mkIf cfg.bigscreen.enable {
-
environment.systemPackages = with pkgs.plasma5Packages; [
-
plasma-remotecontrollers
-
services.displayManager.sessionPackages = [ pkgs.plasma5Packages.plasma-bigscreen ];
-
# required for plasma-remotecontrollers to work correctly
-
hardware.uinput.enable = true;