nixos/modules/services/x11/desktop-managers/pantheon.md

   1 # Pantheon Desktop {#chap-pantheon}
   2
   3 Pantheon is the desktop environment created for the elementary OS distribution. It is written from scratch in Vala, utilizing GNOME technologies with GTK and Granite.
   4
   5 ## Enabling Pantheon {#sec-pantheon-enable}
   6
   7 All of Pantheon is working in NixOS and the applications should be available, aside from a few [exceptions](https://github.com/NixOS/nixpkgs/issues/58161). To enable Pantheon, set
   8 ```nix
   9 {
  10   services.xserver.desktopManager.pantheon.enable = true;
  11 }
  12 ```
  13 This automatically enables LightDM and Pantheon's LightDM greeter. If you'd like to disable this, set
  14 ```nix
  15 {
  16   services.xserver.displayManager.lightdm.greeters.pantheon.enable = false;
  17   services.xserver.displayManager.lightdm.enable = false;
  18 }
  19 ```
  20 but please be aware using Pantheon without LightDM as a display manager will break screenlocking from the UI. The NixOS module for Pantheon installs all of Pantheon's default applications. If you'd like to not install Pantheon's apps, set
  21 ```nix
  22 {
  23   services.pantheon.apps.enable = false;
  24 }
  25 ```
  26 You can also use [](#opt-environment.pantheon.excludePackages) to remove any other app (like `elementary-mail`).
  27
  28 ## Wingpanel and Switchboard plugins {#sec-pantheon-wingpanel-switchboard}
  29
  30 Wingpanel and Switchboard work differently than they do in other distributions, as far as using plugins. You cannot install a plugin globally (like with {option}`environment.systemPackages`) to start using it. You should instead be using the following options:
  31
  32   - [](#opt-services.xserver.desktopManager.pantheon.extraWingpanelIndicators)
  33   - [](#opt-services.xserver.desktopManager.pantheon.extraSwitchboardPlugs)
  34
  35 to configure the programs with plugs or indicators.
  36
  37 The difference in NixOS is both these programs are patched to load plugins from a directory that is the value of an environment variable. All of which is controlled in Nix. If you need to configure the particular packages manually you can override the packages like:
  38 ```nix
  39 wingpanel-with-indicators.override {
  40   indicators = [
  41     pkgs.some-special-indicator
  42   ];
  43 }
  44
  45 ```
  46 ```nix
  47 switchboard-with-plugs.override {
  48   plugs = [
  49     pkgs.some-special-plug
  50   ];
  51 }
  52 ```
  53 please note that, like how the NixOS options describe these as extra plugins, this would only add to the default plugins included with the programs. If for some reason you'd like to configure which plugins to use exactly, both packages have an argument for this:
  54 ```nix
  55 wingpanel-with-indicators.override {
  56   useDefaultIndicators = false;
  57   indicators = specialListOfIndicators;
  58 }
  59 ```
  60 ```nix
  61 switchboard-with-plugs.override {
  62   useDefaultPlugs = false;
  63   plugs = specialListOfPlugs;
  64 }
  65 ```
  66 this could be most useful for testing a particular plug-in in isolation.
  67
  68 ## FAQ {#sec-pantheon-faq}
  69
  70 [I have switched from a different desktop and Pantheon’s theming looks messed up.]{#sec-pantheon-faq-messed-up-theme}
  71   : Open Switchboard and go to: Administration → About → Restore Default Settings → Restore Settings. This will reset any dconf settings to their Pantheon defaults. Note this could reset certain GNOME specific preferences if that desktop was used prior.
  72
  73 [I cannot enable both GNOME and Pantheon.]{#sec-pantheon-faq-gnome-and-pantheon}
  74   : This is a known [issue](https://github.com/NixOS/nixpkgs/issues/64611) and there is no known workaround.
  75
  76 [Does AppCenter work, or is it available?]{#sec-pantheon-faq-appcenter}
  77   : AppCenter has been available since 20.03. Starting from 21.11, the Flatpak backend should work so you can install some Flatpak applications using it. However, due to missing appstream metadata, the Packagekit backend does not function currently. See this [issue](https://github.com/NixOS/nixpkgs/issues/15932).
  78
  79     If you are using Pantheon, AppCenter should be installed by default if you have [Flatpak support](#module-services-flatpak) enabled. If you also wish to add the `appcenter` Flatpak remote:
  80
  81     ```ShellSession
  82     $ flatpak remote-add --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
  83     ```