Skip to content

Commit 948b284

Browse files
committed
config/graphical-session/portals.md: document portal setup
seems a lot of people have had issues with this, sometimes exacerbated by the recent portals.conf change. Others have issues because they only install `-wlr`, which doesn't provide many of the common interfaces.
1 parent 94b0ecd commit 948b284

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
- [Wayland](./config/graphical-session/wayland.md)
5454
- [Fonts](./config/graphical-session/fonts.md)
5555
- [Icons](./config/graphical-session/icons.md)
56+
- [XDG Desktop Portals](./config/graphical-session/portals.md)
5657
- [GNOME](./config/graphical-session/gnome.md)
5758
- [KDE](./config/graphical-session/kde.md)
5859
- [Multimedia](./config/media/index.md)

src/config/external-applications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ security and/or privacy-violating features of proprietary software.
5858

5959
Some apps may not function properly (e.g. not being able to access the host
6060
system's files). Some of these issues can be fixed by installing one or more of
61-
the `xdg-desktop-portal`, `xdg-desktop-portal-gtk`, `xdg-user-dirs`,
62-
`xdg-user-dirs-gtk` or `xdg-utils` packages.
61+
the `xdg-user-dirs`, `xdg-user-dirs-gtk` or `xdg-utils` packages, and setting up
62+
[XDG Desktop Portals](./graphical-session/portals.md).
6363

6464
Some Flatpaks require [D-Bus](./session-management.md#d-bus) and/or
6565
[Pulseaudio](./media/pulseaudio.md).
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# XDG Desktop Portals
2+
3+
Some applications, including [Flatpak](../external-applications.md#flatpak), use
4+
[XDG Desktop Portals](https://github.com/flatpak/xdg-desktop-portal) to provide
5+
access to various system interfaces, including file open and save dialogs, the
6+
clipboard, screencasting, opening URLs, and more.
7+
8+
## Installation
9+
10+
XDG Desktop Portals require a [user D-Bus session
11+
bus](../session-management.md#d-bus). Install `xdg-desktop-portal` and one or
12+
more backends:
13+
14+
| Backend | Notes |
15+
|----------------------------|--------------------------------------------------------------------------------|
16+
| `xdg-desktop-portal-gnome` | Provides most common and GNOME-specific interfaces (GTK+ UI) |
17+
| `xdg-desktop-portal-gtk` | Provides most common interfaces (GTK+ UI) |
18+
| `xdg-desktop-portal-kde` | Provides most common and KDE-specific interfaces (Qt/KF5 UI) |
19+
| `xdg-desktop-portal-lxqt` | Only provides a file chooser (based on libfm-qt) |
20+
| `io.elementary.files` | Only provides a file chooser |
21+
| `xdg-desktop-portal-wlr` | Only provides a screenshot and screencasting interface for wlroots compositors |
22+
23+
If unsure what to choose, `xdg-desktop-portal-gtk` is a good default choice.
24+
25+
## Configuration
26+
27+
In most cases, the default configuration, located at
28+
`/usr/share/xdg-desktop-portal/portals.conf`, should suffice. If necessary, this
29+
configuration can be overridden for specific desktop environments and portal
30+
interfaces by creating `$XDG_CURRENT_DESKTOP-portals.conf` or `portals.conf` at
31+
the system or user level as described in
32+
[portals.conf(5)](https://man.voidlinux.org/portals.conf.5).

0 commit comments

Comments
 (0)