From 5153eac0d3cc8c5aab649eb6c308b00c321054e7 Mon Sep 17 00:00:00 2001 From: gabriel Date: Thu, 14 Jan 2021 20:41:57 +0000 Subject: [PATCH] setuid requirements expansion Clarify `hikari-unlocker` needs setuid, that `hikari` does not, mechanisms used to gain root privileges and optional setuid procedure if needed. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5836838..9093214 100644 --- a/README.md +++ b/README.md @@ -89,8 +89,11 @@ repository, breaking changes might be encountered. These are documented in the ### Compiling and Installing 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 -be installed with root setuid in your `PATH`. +latter is used to check credentials for unlocking the screen, which needs to be +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 default configuration can be found under `$PREFIX/etc/hikari/hikari.conf`