• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

autostart/H03-May-2022-8344

man/H05-Nov-2021-5451

src/H05-Nov-2021-632420

test/H05-Nov-2021-51

translations/H03-May-2022-1,7681,734

AUTHORSH A D05-Nov-2021269 118

CHANGELOGH A D05-Nov-20215.9 KiB170146

LICENSEH A D05-Nov-202123.9 KiB459386

README.mdH A D05-Nov-20213.3 KiB8659

README.md

1# lxqt-policykit
2
3## Overview
4
5lxqt-policykit is the polkit authentification agent of LXQt.
6
7[polkit](https://www.freedesktop.org/wiki/Software/polkit/) is a software framework
8to handle privileges of processes.
9In LXQt it is e. g. used to extend the privileges of the GUI tools of
10[lxqt-admin](https://github.com/lxqt/lxqt-admin/). These are launched by a regular
11user. But in order to apply the settings they deal with root privileges are needed
12and acquired via polkit.
13Among the various components of polkit the authentication agent is the one to
14query the user for credentials by dialogue windows like this one of lxqt-policykit.
15![lxqt-policykit: GUI](lxqt-policykit_gui.png)
16While there's only a single implementation of all other polkit components various
17different authentication agents are provided by the various desktop environments.
18Basically these can be used interchangeably, that is lxqt-policykit can be used
19in an LXDE session or lxpolkit, the authentication agent of LXDE, can be used in
20an Xfce session. Most of the time it's better to use the implementation provided
21by a distinct desktop environment as it integrates better, though.
22
23Technically, lxqt-policykit is just a single binary `lxqt-policykit-agent` which
24is running as [LXQt Module](https://github.com/lxqt/lxqt-session#lxqt-modules)
25and launching the GUI on demand.
26
27Note that the naming lxqt-policykit is strictly speaking an anachronism. It refers
28to Policykit which was the predecessor of polkit. The name wasn't changed when
29Policykit was replaced by polkit as both provide roughly the same features albeit
30they are technically different.
31
32## Installing
33
34### Compiling sources
35
36Runtime dependencies are polkit-qt5 and [liblxqt](https://github.com/lxqt/liblxqt).
37Additional build dependencies are CMake and optionally Git to pull latest VCS
38checkouts.
39
40Code configuration is handled by CMake. CMake variable `CMAKE_INSTALL_PREFIX`
41has to be set to `/usr` on most operating systems.
42
43To build run `make`, to install `make install` which accepts variable `DESTDIR`
44as usual.
45
46### Binary packages
47
48#### Arch Linux
49
50The latest release is provided by package `lxqt-policykit` in repository community,
51the actual master checkout can be compiled by packages `lxqt-policykit-git` from
52the [AUR](https://aur.archlinux.org).
53
54#### Debian
55
56Package `lxqt-policykit` is available in the official repositories as of Debian
57buster.
58
59#### Fedora
60
61Package `lxqt-policykit` is available as of Fedora 22.
62
63#### openSUSE
64
65Package `lxqt-policykit` is providing the binary, `lxqt-policykit-lang` the
66translations. Both are available as of openSUSE Leap 42.1.
67
68## Configuration, Usage
69
70Like all LXQt Modules `lxqt-policykit-agent` can be adjusted from section
71"Basic Settings" in configuration dialogue
72[LXQt Session Settings](https://github.com/lxqt/lxqt-session#lxqt-session-settings)
73of [lxqt-session](https://github.com/lxqt/lxqt-session).
74
75From a user's point of view the usage is limited to interacting with the GUI as
76seen above.
77
78
79### Translations
80
81Translations can be done in [LXQt-Weblate](https://translate.lxqt-project.org/projects/lxqt-configuration/lxqt-policykit/).
82
83<a href="https://translate.lxqt-project.org/projects/lxqt-configuration/lxqt-policykit/">
84<img src="https://translate.lxqt-project.org/widgets/lxqt-configuration/-/lxqt-policykit/multi-auto.svg" alt="Translation status" />
85</a>
86