setuid requirements expansion

Clarify `hikari-unlocker` needs setuid, that `hikari` does not, mechanisms
used to gain root privileges and optional setuid procedure if needed.
This commit is contained in:
gabriel 2021-01-14 20:41:57 +00:00
parent e09aa1f73c
commit 5153eac0d3
1 changed files with 5 additions and 2 deletions

View File

@ -89,8 +89,11 @@ repository, breaking changes might be encountered. These are documented in the
### Compiling and Installing ### Compiling and Installing
The build process will produce two binaries `hikari` and `hikari-unlocker`. The The build process will produce two binaries `hikari` and `hikari-unlocker`. The
latter one is used to check credentials for unlocking the screen. Both need to latter is used to check credentials for unlocking the screen, which needs to be
be installed with root setuid in your `PATH`. installed with root setuid. `hikari` can rely on `seatd`, `(e)logind` or other
mechanisms to gain root privileges when required; however, if needed it can
also be installed with root setuid - see "Installing with SUID" below.
Both binaries need to be located in your `PATH`.
`hikari` can be configured via `$XDG_CONFIG_HOME/hikari/hikari.conf`, the `hikari` can be configured via `$XDG_CONFIG_HOME/hikari/hikari.conf`, the
default configuration can be found under `$PREFIX/etc/hikari/hikari.conf` default configuration can be found under `$PREFIX/etc/hikari/hikari.conf`