NixOS Wiki

Sway: Difference between revisions

← Older edit
Visual
imported>Rasmus-kirk
Changed systemd sway configuration since the old was broken
Axka (talk | contribs)
28 edits
m nix->NixOS
 
(67 intermediate revisions by 37 users not shown)
Line 1: Line 1:
Sway is a tiling [[Wayland]] compositor and a drop-in replacement for the i3 window manager for X11. It works with your existing i3 configuration and supports most of i3's features, plus a few extras.  
Sway is a tiling Wayland compositor and a drop-in replacement for the i3 window manager for X11. It works with your existing i3 configuration and supports most of i3's features, plus a few extras.  
[https://github.com/swaywm/sway/wiki/i3-Migration-Guide i3 migration guide]
[https://github.com/swaywm/sway/wiki/i3-Migration-Guide i3 migration guide]


== Installation ==
== Setup ==
 
You can install Sway by enabling it in NixOS directly, or by using [[Home Manager]], or both.
=== NixOS ===
[https://search.nixos.org/options?query=sway NixOS options for sway]


=== Using NixOS ===
Here is a minimal configuration:
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
programs.sway = {
{ config, pkgs, lib, ... }:
   enable = true;
{
  wrapperFeatures.gtk = true; # so that gtk works properly
   environment.systemPackages = with pkgs; [
  extraPackages = with pkgs; [
     grim # screenshot functionality
     swaylock
     slurp # screenshot functionality
     swayidle
     wl-clipboard # wl-copy and wl-paste for copy/paste from stdin / stdout
     wl-clipboard
     mako # notification system developed by swaywm maintainer
     mako # notification daemon
    alacritty # Alacritty is the default terminal in the config
    dmenu # Dmenu is the default in the config but i recommend wofi since its wayland native
   ];
   ];
};


  # Enable the gnome-keyring secrets vault.
  # Will be exposed through DBus to programs willing to store secrets.
  services.gnome.gnome-keyring.enable = true;
  # enable Sway window manager
  programs.sway = {
    enable = true;
    wrapperFeatures.gtk = true;
  };
}
</syntaxhighlight>By default, the Sway module in NixOS comes with a set of extra packages, including the <code>foot</code> terminal, <code>swayidle</code>, <code>swaylock</code>, and <code>wmenu</code>, which can be configured under  <code>[https://search.nixos.org/options?show=programs.sway.extraPackages programs.sway.extraPackages]</code> option. You may also want to include <code>wl-clipboard</code> for clipboard functionality and <code>slurp</code> for screenshot region selection. Additionally, for a more customizable bar implementation than <code>sway-bar</code>, <code>waybar</code> can be enabled with <code>programs.waybar.enable</code>.
The default Sway configuration is simlinked to <code>/etc/sway/config</code> and <code>/etc/sway/config.d/nixos.conf</code>. The latter file contains dbus and systemd configuration that is critical to using apps that depend on XDG desktop portals with Sway, and should be included in any custom configuration files.
A few general comments:
* There is some friction between GTK theming and Sway. Currently the Sway developers suggest using gsettings to set gtk theme attributes as described here [https://github.com/swaywm/sway/wiki/GTK-3-settings-on-Wayland]. There is currently a plan to allow GTK theme attributes to be set directly in the Sway config.
* Running Sway as a systemd user service is not recommended [https://github.com/swaywm/sway/wiki/Systemd-integration#running-sway-itself-as-a---user-service] [https://github.com/swaywm/sway/issues/5160]
=== Using Home Manager ===
To set up Sway using [[Home Manager]], first you must enable [[Polkit]] in your NixOS configuration:
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
security.polkit.enable = true;
</nowiki>}}
Then you can enable Sway in your home manager configuration. Here is a minimal example:
<syntaxhighlight lang="nix>
  wayland.windowManager.sway = {
    enable = true;
    wrapperFeatures.gtk = true; # Fixes common issues with GTK 3 apps
    config = rec {
      modifier = "Mod4";
      # Use kitty as default terminal
      terminal = "kitty";
      startup = [
        # Launch Firefox on start
        {command = "firefox";}
      ];
    };
  };
</syntaxhighlight>
</syntaxhighlight>


=== Home Manager ===
See [https://nix-community.github.io/home-manager/options.xhtml#opt-wayland.windowManager.sway.enable Home Manager's Options for Sway] for a complete list of configuration options.
[https://rycee.gitlab.io/home-manager/options.html#opt-wayland.windowManager.sway.enable Home Manager options for sway]
 
You might need to active dbus manually from .zshrc to use i.e: dunst, see [https://discourse.nixos.org/t/dunst-crashes-if-run-as-service/27671/2 Dunst crashes if run as service]
 
{{Note|
It's recommended to enable a [[Secret Service]] provider, like GNOME Keyring:
{{file|home.nix|nix|<nowiki>
services.gnome-keyring.enable = true;
</nowiki>}}
}}
 
=== Systemd services ===
Kanshi is an output configuration daemon. As explained above, we don't run Sway itself as a systemd service. There are auxiliary daemons that we do want to run as systemd services, for example Kanshi [https://sr.ht/~emersion/kanshi/], which implements monitor hot swapping. It would be enabled as follows:
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
  # kanshi systemd service
  systemd.user.services.kanshi = {
    description = "kanshi daemon";
    environment = {
      WAYLAND_DISPLAY="wayland-1";
      DISPLAY = ":0";
    };
    serviceConfig = {
      Type = "simple";
      ExecStart = ''${pkgs.kanshi}/bin/kanshi -c kanshi_config_file'';
    };
  };
</nowiki>}}
 
{{file|sway config|bash|
# give Sway a little time to startup before starting kanshi.
exec sleep 5; systemctl --user start kanshi.service
}}
When you launch Sway, the systemd service is started.


<syntaxhighlight lang="nix">
=== Using greeter ===
wayland.windowManager.sway = {
Installing a greeter based on [https://search.nixos.org/options?channel=unstable&show=services.greetd.settings&from=0&size=50&sort=relevance&type=packages&query=greetd greetd] is the most straightforward way to launch Sway.
  enable = true;
 
  wrapperFeatures.gtk = true ;
Tuigreet does not even need a separate compositor to launch.
};
home.packages = with pkgs; [
  swaylock
  swayidle
  wl-clipboard
  mako # notification daemon
  alacritty # Alacritty is the default terminal in the config
  dmenu # Dmenu is the default in the config but i recommend wofi since its wayland native
];
</syntaxhighlight>


== Info ==
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
services.greetd = {                                                     
  enable = true;                                                       
  settings = {                                                         
    default_session = {                                                 
      command = "${pkgs.greetd.tuigreet}/bin/tuigreet --time --cmd sway";
      user = "greeter";                                                 
    };                                                                 
  };                                                                   
};                                                                     
</nowiki>}}


=== Clipboard ===
== Configuration ==
Sway can be configured for specific users using Home-Manager or manually through configuration files. Default is <code>/etc/sway/config</code> and custom user configuration in <code>~/.config/sway/config</code>.


For clipboard support
=== Keyboard layout ===
<syntaxhighlight lang="nix">
Changing layout for all keyboards to German (de)<syntaxhighlight lang="console">
environment.systemPackages = with pkgs; [ wl-clipboard ];
input * xkb_layout "de"
</syntaxhighlight>
</syntaxhighlight>


to use [https://github.com/brunelli/wl-clipboard-x11/ wl-clipboard-x11] which is a wrapper to use wl-clipboard as a drop-in replacement to X11 clipboard tools
=== High-DPI scaling ===
 
Changing scale for all screens to factor 1.5<syntaxhighlight lang="console">
<syntaxhighlight lang="nix">
output * scale 1.5
nixpkgs.overlays = [
  (self: super: {
    wl-clipboard-x11 = super.stdenv.mkDerivation rec {
    pname = "wl-clipboard-x11";
    version = "5";
 
    src = super.fetchFromGitHub {
      owner = "brunelli";
      repo = "wl-clipboard-x11";
      rev = "v${version}";
      sha256 = "1y7jv7rps0sdzmm859wn2l8q4pg2x35smcrm7mbfxn5vrga0bslb";
    };
 
    dontBuild = true;
    dontConfigure = true;
    propagatedBuildInputs = [ super.wl-clipboard ];
    makeFlags = [ "PREFIX=$(out)" ];
    };
 
    xsel = self.wl-clipboard-x11;
    xclip = self.wl-clipboard-x11;
  })
];
</syntaxhighlight>
</syntaxhighlight>
{{Note|This will recompile all packages that have xclip or xsel in their dependencies|warn}}


=== Brightness and volume ===
=== Brightness and volume ===
 
You can set up brightness and volume function keys as follows by binding the key codes to their corresponding commands in your sway config. The following configurations accomplish this using <code>light</code> and <code>pulseaudio</code>:
Brightnessctl has worked better for me than light
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
environment.systemPackages = with pkgs; [ brightnessctl ];
users.users.yourusername.extraGroups = [ "video" ];
users.users.yourusername.extraGroups = [ "video" ];
# or
programs.light.enable = true;
programs.light.enable = true;
 
environment.systemPackages = [ pkgs.pulseaudio ];
environment.systemPackages = with pkgs; [ pactl ];
</nowiki>}}
</nowiki>}}


Line 94: Line 133:


# Brightness
# Brightness
bindsym XF86MonBrightnessDown exec "brightnessctl set 2%-"
bindsym XF86MonBrightnessDown exec light -U 10
bindsym XF86MonBrightnessUp exec "brightnessctl set +2%"
bindsym XF86MonBrightnessUp exec light -A 10


# Volume
# Volume
Line 103: Line 142:
}}
}}


=== Polkit ===
== Troubleshooting ==


nix generated sway config
=== Cursor is too tiny on HiDPI displays ===
<syntaxhighlight lang="nix">
 
${pkgs.polkit_gnome}/libexec/polkit-gnome-authentication-agent-1
Using [[Home Manager]] try configuring a general mouse cursor size and theme
</syntaxhighlight>
 
<syntaxhighlight lang="nix>
 
home-manager.users.myUser = {
 
    home.pointerCursor = {
      name = "Adwaita";
      package = pkgs.gnome.adwaita-icon-theme;
      size = 24;
      x11 = {
        enable = true;
        defaultCursor = "Adwaita";
      };
    };


normal sway config
};
<syntaxhighlight lang="nix">
environment.systemPackages = with pkgs; [ polkit_gnome ];
environment.pathsToLink = [ "/libexec" ];
</syntaxhighlight>
</syntaxhighlight>


<syntaxhighlight lang="bash">
Replace <code>myUser</code> with your user running the graphical environment.
# NixOS
exec /run/current-system/sw/libexec/polkit-gnome-authentication-agent-1
# Home Manager | pathsToLink is not needed
exec ~/.nix-profile/libexec/polkit-gnome-authentication-agent-1
</syntaxhighlight>


=== Missing fonts on Xorg applications ===


If fonts for certain languages are missing in Xorg applications (e.g. Japanese fonts don't appear in Discord) even though they're in the system, you can set them as default fonts in your configuration file.


=== Theming ===
<syntaxhighlight lang="nix>


==== Gtk ====
  fonts = {
    packages = with pkgs; [
      noto-fonts
      noto-fonts-cjk
      noto-fonts-emoji
      font-awesome
      source-han-sans
      source-han-sans-japanese
      source-han-serif-japanese
    ];
    fontconfig.defaultFonts = {
      serif = [ "Noto Serif" "Source Han Serif" ];
      sansSerif = [ "Noto Sans" "Source Han Sans" ];
    };
  };


<syntaxhighlight lang="nix">
environment.systemPackages = with pkgs; [
  gtk-engine-murrine
  gtk_engines
  gsettings-desktop-schemas
  lxappearance
];
</syntaxhighlight>
</syntaxhighlight>
open lxappearance and pick your themes


read [https://github.com/swaywm/sway/wiki/GTK-3-settings-on-Wayland GTK3 settings on Wayland]
=== Swaylock cannot be unlocked with the correct password ===


==== Qt ====
Add the following to your NixOS configuration.


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix>
programs.qt5ct.enable = true;
  security.pam.services.swaylock = {};
</syntaxhighlight>
</syntaxhighlight>
open qt5ct and pick your theme


=== Additional packages ===
The <code>programs.sway.enable</code> option does this automatically.


=== Inferior performance compared to other distributions ===


{{app|waybar|Highly customizable Wayland bar for Sway and Wlroots based compositors|https://github.com/Alexays/Waybar|waybar}}
Enabling realtime may improve latency and reduce stuttering, specially in high load scenarios.
{{app|autotiling|Script for sway and i3 to automatically switch the horizontal / vertical window split orientation|https://github.com/nwg-piotr/autotiling|autotiling}}
{{app|gammastep|Reduces bluelight and saves your eyes|https://gitlab.com/chinstrap/gammastep|gammastep}}
{{app|clipman|Simple clipboard manager for Wayland|https://github.com/yory8/clipman/|clipman}}
{{app|wofi|Launcher/menu program for wlroots based wayland compositors such as sway|https://hg.sr.ht/~scoopta/wofi|wofi}}
{{app|flashfocus|Simple focus animations for tiling window managers|https://github.com/fennerm/flashfocus|flashfocus}}
{{app|wf-recorder|Screen recorder for wlroots-based compositors such as sway|https://github.com/ammen99/wf-recorder|wf-recorder}}
{{app|i3-ratiosplit|Configurable window size on creation|https://github.com/333fred/i3-ratiosplit|i3-ratiosplit}}


more packages here [https://github.com/swaywm/sway/wiki/i3-Migration-Guide i3 migration guide]
<syntaxhighlight lang="nix">
security.pam.loginLimits = [
  { domain = "@users"; item = "rtprio"; type = "-"; value = 1; }
];
</syntaxhighlight>


Enabling this option allows any program run by the "users" group to request real-time priority.


=== Systemd integration ===
=== WLR Error when trying to launch Sway ===


In an article on the sway wiki [https://github.com/swaywm/sway/wiki/Systemd-integration], a way to integrate Sway with systemd user services is proposed. Starting sway that way has some benefits:
When this happens on a new nixos system, enabling opengl in configuration.nix may fix this issue.
 
* Services like Waybar, kanshi, redshift can depend on <code>graphical-session.target</code> and can therefore be started as their own user service, including convenient service management and logging.


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
{ config, pkgs, lib, ... }: {
hardware.opengl.enable = true;
</syntaxhighlight>


  programs.sway = {
=== Touchscreen input bound to the wrong monitor in multi-monitor setups ===
    enable = true;
    extraPackages = with pkgs; [
      swaylock # lockscreen
      swayidle
      xwayland # for legacy apps
      waybar # status bar
      mako # notification daemon
      kanshi # autorandr
    ];
  };


  environment = {
See this [https://github.com/swaywm/sway/issues/6590#issue-1021207180 GitHub issue for Sway] and the solution give in [https://github.com/swaywm/sway/issues/6590#issuecomment-938724355 this response].
    etc = {
      # Put config files in /etc. Note that you also can put these in ~/.config, but then you can't manage them with NixOS anymore!
      "sway/config".source = ./dotfiles/sway/config;
      "xdg/waybar/config".source = ./dotfiles/waybar/config;
      "xdg/waybar/style.css".source = ./dotfiles/waybar/style.css;
    };
  };


  services.redshift = {
Using [[Home Manager]] add the following to your Sway configuration:
    enable = true;
<syntaxhighlight lang="nix">
    # Redshift with wayland support isn't present in nixos-19.09 atm. You have to cherry-pick the commit from https://github.com/NixOS/nixpkgs/pull/68285 to do that.
  wayland.windowManager.sway = {
    package = pkgs.redshift-wlr;
    [...]
  };
    config = {
      [...]
      input = {
        [...]
        "type:touch" = {
          # Replace touchscreen_output_identifier with the identifier of your touchscreen.
          map_to_output = touchscreen_output_identifier;
        };
      };
    };
  };
</syntaxhighlight>


  programs.waybar.enable = true;
=== GTK apps take an exceptionally long time to start ===
This occurs because GTK apps make blocking calls to freedesktop portals to be displayed. If Sway is not integrated with dbus and systemd, it will not be able to communicate via the <code>org.freedesktop.portal.Desktop</code> portal. To fix this, see the [[Sway#Using NixOS|description]] of default Sway configurations earlier. Adding the following to your sway configuration, if it is not already present, may resolve the issue:
include /etc/sway/config.d/*


  systemd.user.services.kanshi = {
== Tips and tricks ==
    description = "Kanshi output autoconfig ";
    wantedBy = [ "graphical-session.target" ];
    partOf = [ "graphical-session.target" ];
    serviceConfig = {
      # kanshi doesn't have an option to specifiy config file yet, so it looks
      # at .config/kanshi/config
      ExecStart = ''
        ${pkgs.kanshi}/bin/kanshi
      '';
      RestartSec = 5;
      Restart = "always";
    };
  };


}
=== Toggle monitor modes script ===
</syntaxhighlight>
Following script toggles screen / monitor modes if executed. It can also be mapped to a specific key in Sway.


And then simply add the following to the ''end'' of your sway configuration
First add the Flake input required for the script<syntaxhighlight lang="nix">
<syntaxhighlight>
{
exec "systemctl --user import-environment; systemctl --user start sway-session.target"
  inputs = {
</syntaxhighlight>
    [...]
    wl-togglescreens.url = "git+https://git.project-insanity.org/onny/wl-togglescreens.git?ref=main";
  };


Note: swayidle will fail cryptically if it cannot find {{ic|sh}} in {{ic|PATH}}, so you must provide this if you create a service file for it. An example is below:
  outputs = {self, nixpkgs, ...}@inputs: {
 
    nixosConfigurations.myhost = inputs.nixpkgs.lib.nixosSystem {
<syntaxhighlight lang="nix">
      system = "x86_64-linux";
   systemd.user.services.swayidle = {
      specialArgs.inputs = inputs;
     description = "Idle Manager for Wayland";
      [...]
    documentation = [ "man:swayidle(1)" ];
</syntaxhighlight>Map the script binary to a specific key<syntaxhighlight lang="nix">
    wantedBy = [ "sway-session.target" ];
{ config, pkgs, lib, inputs, ... }:{
    partOf = [ "graphical-session.target" ];
   home-manager.users.onny = {
    path = [ pkgs.bash ];
     programs = {
    serviceConfig = {
      [...]
      ExecStart = '' ${pkgs.swayidle}/bin/swayidle -w -d \
      wayland.windowManager.sway = {
        timeout 300 '${pkgs.sway}/bin/swaymsg "output * dpms off"' \
        enable = true;
         resume '${pkgs.sway}/bin/swaymsg "output * dpms on"'
        config = {
       '';
          [...]
          keybindings = lib.mkOptionDefault{
            [...]
            "XF86Display" = "exec ${inputs.wl-togglescreens.packages.x86_64-linux.wl-togglescreens}/bin/wl-togglescreens";
          };
         };
       };
     };
     };
  };
</syntaxhighlight>
</syntaxhighlight>
[[Category:Window managers]]
[[Category:Window managers]]
[[Category:Applications]]
Retrieved from "https://wiki.nixos.org/wiki/Sway"