nixos/modules/services/x11/desktop-managers/cinnamon.nix

   1 { config, lib, pkgs, utils, ... }:
   2
   3 with lib;
   4
   5 let
   6
   7   cfg = config.services.xserver.desktopManager.cinnamon;
   8   serviceCfg = config.services.cinnamon;
   9
  10   nixos-gsettings-overrides = pkgs.cinnamon-gsettings-overrides.override {
  11     extraGSettingsOverridePackages = cfg.extraGSettingsOverridePackages;
  12     extraGSettingsOverrides = cfg.extraGSettingsOverrides;
  13   };
  14
  15   notExcluded = pkg: (!(lib.elem pkg config.environment.cinnamon.excludePackages));
  16 in
  17
  18 {
  19   options = {
  20     services.cinnamon = {
  21       apps.enable = mkEnableOption "Cinnamon default applications";
  22     };
  23
  24     services.xserver.desktopManager.cinnamon = {
  25       enable = mkEnableOption "the cinnamon desktop manager";
  26
  27       sessionPath = mkOption {
  28         default = [];
  29         type = types.listOf types.package;
  30         example = literalExpression "[ pkgs.gpaste ]";
  31         description = ''
  32           Additional list of packages to be added to the session search path.
  33           Useful for GSettings-conditional autostart.
  34
  35           Note that this should be a last resort; patching the package is preferred (see GPaste).
  36         '';
  37       };
  38
  39       extraGSettingsOverrides = mkOption {
  40         default = "";
  41         type = types.lines;
  42         description = "Additional gsettings overrides.";
  43       };
  44
  45       extraGSettingsOverridePackages = mkOption {
  46         default = [];
  47         type = types.listOf types.path;
  48         description = "List of packages for which gsettings are overridden.";
  49       };
  50     };
  51
  52     environment.cinnamon.excludePackages = mkOption {
  53       default = [];
  54       example = literalExpression "[ pkgs.blueman ]";
  55       type = types.listOf types.package;
  56       description = "Which packages cinnamon should exclude from the default environment";
  57     };
  58
  59   };
  60
  61   config = mkMerge [
  62     (mkIf cfg.enable {
  63       services.displayManager.sessionPackages = [ pkgs.cinnamon-common ];
  64
  65       services.xserver.displayManager.lightdm.greeters.slick = {
  66         enable = mkDefault true;
  67
  68         # Taken from mint-artwork.gschema.override
  69         theme = mkIf (notExcluded pkgs.mint-themes) {
  70           name = mkDefault "Mint-Y-Aqua";
  71           package = mkDefault pkgs.mint-themes;
  72         };
  73         iconTheme = mkIf (notExcluded pkgs.mint-y-icons) {
  74           name = mkDefault "Mint-Y-Sand";
  75           package = mkDefault pkgs.mint-y-icons;
  76         };
  77         cursorTheme = mkIf (notExcluded pkgs.mint-cursor-themes) {
  78           name = mkDefault "Bibata-Modern-Classic";
  79           package = mkDefault pkgs.mint-cursor-themes;
  80         };
  81       };
  82
  83       # Have to take care of GDM + Cinnamon on Wayland users
  84       environment.extraInit = ''
  85         ${concatMapStrings (p: ''
  86           if [ -d "${p}/share/gsettings-schemas/${p.name}" ]; then
  87             export XDG_DATA_DIRS=$XDG_DATA_DIRS''${XDG_DATA_DIRS:+:}${p}/share/gsettings-schemas/${p.name}
  88           fi
  89
  90           if [ -d "${p}/lib/girepository-1.0" ]; then
  91             export GI_TYPELIB_PATH=$GI_TYPELIB_PATH''${GI_TYPELIB_PATH:+:}${p}/lib/girepository-1.0
  92             export LD_LIBRARY_PATH=$LD_LIBRARY_PATH''${LD_LIBRARY_PATH:+:}${p}/lib
  93           fi
  94         '') cfg.sessionPath}
  95       '';
  96
  97       # Default services
  98       services.blueman.enable = mkDefault (notExcluded pkgs.blueman);
  99       hardware.bluetooth.enable = mkDefault true;
 100       security.polkit.enable = true;
 101       services.accounts-daemon.enable = true;
 102       services.system-config-printer.enable = (mkIf config.services.printing.enable (mkDefault true));
 103       services.dbus.packages = with pkgs; [
 104         cinnamon-common
 105         cinnamon-screensaver
 106         nemo-with-extensions
 107         xapp
 108       ];
 109       services.cinnamon.apps.enable = mkDefault true;
 110       services.gnome.evolution-data-server.enable = true;
 111       services.gnome.glib-networking.enable = true;
 112       services.gnome.gnome-keyring.enable = true;
 113       services.gvfs.enable = true;
 114       services.switcherooControl.enable = mkDefault true; # xapp-gpu-offload-helper
 115       services.touchegg.enable = mkDefault true;
 116       services.udisks2.enable = true;
 117       services.upower.enable = mkDefault config.powerManagement.enable;
 118       services.libinput.enable = mkDefault true;
 119       services.xserver.updateDbusEnvironment = true;
 120       networking.networkmanager.enable = mkDefault true;
 121
 122       # Enable colord server
 123       services.colord.enable = true;
 124
 125       # Enable dconf
 126       programs.dconf.enable = true;
 127
 128       # Enable org.a11y.Bus
 129       services.gnome.at-spi2-core.enable = true;
 130
 131       # Fix lockscreen
 132       security.pam.services = {
 133         cinnamon-screensaver = {};
 134       };
 135
 136       environment.systemPackages = with pkgs; ([
 137         desktop-file-utils
 138
 139         # common-files
 140         cinnamon-common
 141         cinnamon-session
 142         cinnamon-desktop
 143         cinnamon-menus
 144         cinnamon-translations
 145
 146         # utils needed by some scripts
 147         killall
 148
 149         # session requirements
 150         cinnamon-screensaver
 151         # cinnamon-killer-daemon: provided by cinnamon-common
 152         networkmanagerapplet # session requirement - also nm-applet not needed
 153
 154         # For a polkit authentication agent
 155         polkit_gnome
 156
 157         # packages
 158         nemo-with-extensions
 159         gnome-online-accounts-gtk
 160         cinnamon-control-center
 161         cinnamon-settings-daemon
 162         libgnomekbd
 163
 164         # theme
 165         adwaita-icon-theme
 166         gnome-themes-extra
 167         gtk3.out
 168
 169         # other
 170         glib # for gsettings
 171         xdg-user-dirs
 172       ] ++ utils.removePackagesByName [
 173         # accessibility
 174         onboard
 175
 176         # theme
 177         sound-theme-freedesktop
 178         nixos-artwork.wallpapers.simple-dark-gray
 179         mint-artwork
 180         mint-cursor-themes
 181         mint-l-icons
 182         mint-l-theme
 183         mint-themes
 184         mint-x-icons
 185         mint-y-icons
 186         xapp # provides some xapp-* icons
 187       ] config.environment.cinnamon.excludePackages);
 188
 189       xdg.mime.enable = true;
 190       xdg.icons.enable = true;
 191
 192       xdg.portal.enable = true;
 193       xdg.portal.extraPortals = [
 194         pkgs.xdg-desktop-portal-xapp
 195         (pkgs.xdg-desktop-portal-gtk.override {
 196           # Do not build portals that we already have.
 197           buildPortalsInGnome = false;
 198         })
 199       ];
 200
 201       services.orca.enable = mkDefault (notExcluded pkgs.orca);
 202
 203       xdg.portal.configPackages = mkDefault [ pkgs.cinnamon-common ];
 204
 205       # Override GSettings schemas
 206       environment.sessionVariables.NIX_GSETTINGS_OVERRIDES_DIR = "${nixos-gsettings-overrides}/share/gsettings-schemas/nixos-gsettings-overrides/glib-2.0/schemas";
 207
 208       environment.pathsToLink = [
 209         # FIXME: modules should link subdirs of `/share` rather than relying on this
 210         "/share" # TODO: https://github.com/NixOS/nixpkgs/issues/47173
 211       ];
 212
 213       # Shell integration for VTE terminals
 214       programs.bash.vteIntegration = mkDefault true;
 215       programs.zsh.vteIntegration = mkDefault true;
 216
 217       # Qt application style
 218       qt = {
 219         enable = mkDefault true;
 220         style = mkDefault "gtk2";
 221         platformTheme = mkDefault "gtk2";
 222       };
 223
 224       # Default Fonts
 225       fonts.packages = with pkgs; [
 226         dejavu_fonts # Default monospace font in LMDE 6+
 227         ubuntu-classic # required for default theme
 228       ];
 229     })
 230
 231     (mkIf serviceCfg.apps.enable {
 232       programs.gnome-disks.enable = mkDefault (notExcluded pkgs.gnome-disk-utility);
 233       programs.gnome-terminal.enable = mkDefault (notExcluded pkgs.gnome-terminal);
 234       programs.file-roller.enable = mkDefault (notExcluded pkgs.file-roller);
 235
 236       environment.systemPackages = with pkgs; utils.removePackagesByName [
 237         # cinnamon team apps
 238         bulky
 239         warpinator
 240
 241         # cinnamon xapp
 242         xviewer
 243         xreader
 244         xed-editor
 245         xplayer
 246         pix
 247
 248         # external apps shipped with linux-mint
 249         gnome-calculator
 250         gnome-calendar
 251         gnome-screenshot
 252       ] config.environment.cinnamon.excludePackages;
 253     })
 254   ];
 255 }