From 97467ea355ea3f39ad1ea568847d85757aa1052b Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 10 Mar 2024 22:06:11 -0500 Subject: [PATCH] Reorder and reword the KMS setup step --- docs/source/about/setup.rst | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/source/about/setup.rst b/docs/source/about/setup.rst index 8b803a78..5b1f3293 100644 --- a/docs/source/about/setup.rst +++ b/docs/source/about/setup.rst @@ -204,6 +204,22 @@ Install sudo udevadm trigger sudo modprobe uinput + #. Enable permissions for KMS capture. + .. warning:: Capture of most Wayland-based desktop environments will fail unless this step is performed. + + .. note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to + allow Sunshine to use KMS capture. + + **Enable** + .. code-block:: bash + + sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine)) + + **Disable (for Xorg/X11 only)** + .. code-block:: bash + + sudo setcap -r $(readlink -f $(which sunshine)) + #. Optionally, configure autostart service - filename: ``~/.config/systemd/user/sunshine.service`` @@ -248,20 +264,6 @@ Install systemctl --user enable sunshine - #. Additional Setup for KMS - .. note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to - allow Sunshine to use KMS. - - **Enable** - .. code-block:: bash - - sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine)) - - **Disable (for Xorg/X11)** - .. code-block:: bash - - sudo setcap -r $(readlink -f $(which sunshine)) - #. Reboot .. code-block:: bash