fix(docs/linux): add Portal and EGL context tips (#5419)
CodeQL / CodeQL (push) Waiting to run
CI / Release Setup (push) Waiting to run
CI / Docker (push) Blocked by required conditions
CI / FreeBSD (push) Blocked by required conditions
CI / Homebrew (push) Blocked by required conditions
CI / macOS (push) Blocked by required conditions
CI / Linux (push) Blocked by required conditions
CI / Archlinux (push) Blocked by required conditions
CI / Linux Copr (push) Blocked by required conditions
CI / Linux Flatpak (push) Blocked by required conditions
CI / Windows (push) Blocked by required conditions
CI / Bundle Analysis (push) Blocked by required conditions
CI / Coverage-Archlinux (push) Blocked by required conditions
CI / Coverage-FreeBSD-aarch64 (push) Blocked by required conditions
CI / Coverage-FreeBSD-amd64 (push) Blocked by required conditions
CI / Coverage-Homebrew-ubuntu-24.04 (push) Blocked by required conditions
CI / Coverage-Linux-AppImage (push) Blocked by required conditions
CI / Coverage-Windows-AMD64 (push) Blocked by required conditions
CI / Coverage-Windows-ARM64 (push) Blocked by required conditions
CI / Coverage-Homebrew-macos-14 (push) Blocked by required conditions
CI / Coverage-macOS-arm64 (push) Blocked by required conditions
CI / Coverage-Homebrew-macos-15 (push) Blocked by required conditions
CI / Coverage-Homebrew-macos-26 (push) Blocked by required conditions
CI / GitHub Env Debug (push) Waiting to run
CI / Coverage-macOS-x86_64 (push) Blocked by required conditions
CI / Release (push) Blocked by required conditions
CI / Release Homebrew Beta (push) Blocked by required conditions
localize / Update Localization (push) Waiting to run
Build GH-Pages / prep (push) Waiting to run
Build GH-Pages / call-jekyll-build (push) Blocked by required conditions

This commit is contained in:
Conn O'Griofa
2026-07-15 21:51:18 +01:00
committed by GitHub
parent 114e633486
commit 9d2409f71b
+35
View File
@@ -128,6 +128,27 @@ resort suggestion.
## Linux
### Hardware Encoders throttle/drop FPS during high GPU load
Capture methods (`wlgrab`) or encoders (`nvenc`, `vaapi`) that utilize EGL contexts may exhibit FPS drops
in conjunction with a Sunshine installation that runs in a sandboxed or reduced permissions state
(Flatpak, AppImage, or when using Portal capture) due to the lack of active CAP_SYS_NICE process permissions
needed to set up high priority EGL contexts.
To check if you are affected by this issue, look out for this message in your Sunshine log:
```
Warning: EGL: context priority set to HIGH but CAP_SYS_NICE capability is missing
```
> [!IMPORTANT]
> Switching to Vulkan encoding should resolve the issue for the majority of configurations, but refer to this
> table for recommended configurations (especially if Vulkan encoding is not supported on your system):
> | Desktop Environment | Vulkan Supported? | Recommended Sunshine Install Type | Recommended Capture & Encoder Configuration |
> |:--------------------|-------------------|-----------------------------------|--------------------------------------------------:|
> | KDE Plasma | Yes | Any | `portal` or `kwin` capture with `vulkan` encoding |
> | KDE Plasma | No | Non-Sandboxed | `kwin` capture with `vaapi`/`nvenc` encoding |
> | GNOME / other | Yes | Any | `portal` capture with `vulkan` encoding |
> | GNOME / other | No | Non-Sandboxed | `kms` capture with `vaapi`/`nvenc` encoding |
### Hardware Encoding fails
Due to legal concerns, Mesa has disabled hardware decoding and encoding by default.
@@ -149,6 +170,20 @@ If you see the above error in the Sunshine logs, compiling *Mesa* manually may b
> Other build options are listed in the
> [meson options](https://gitlab.freedesktop.org/mesa/mesa/-/blob/main/meson_options.txt) file.
### Portal token issues
Portal capture requires you to manually approve Remote Desktop permissions via an on-screen prompt on the host.
This creates a portal token which is used to automaticaly reauthorize on subsequent reconnects, but under certain
circumstances (a Sunshine crash, switching to another desktop environment, or if a monitor hotplug event occurs)
the portal token may become lost or invalid, necessitating manual re-approval of capture permissions.
Users of the KDE Plasma desktop can bypass this issue either by switching to `kwin` capture or setting the following
configuration to enable permanent capture autorization for Sunshine via Portal capture:
```
flatpak permission-set kde-authorized remote-desktop dev.lizardbyte.app.Sunshine yes
```
> [!NOTE]
> Although this configuration is plumbed through Flatpak, it will work with any supported Sunshine installation type.
### Input not working
After installation, the `udev` rules need to be reloaded. Our post-install script tries to do this for you
automatically, but if it fails, you may need to restart your system.