Unl0kr: Difference between revisions
Cherrypicker (talk | contribs) No edit summary |
Cherrypicker (talk | contribs) Add configuration section |
||
Line 3: | Line 3: | ||
By itself unl0kr doesn't actually perform any unlocking. Instead it uses the so called "keyscript mode" in which the entered password is piped through STDOUT into the actual unlocking program. The unl0kr package in pmOS's aports implements the latter as a shell script. | By itself unl0kr doesn't actually perform any unlocking. Instead it uses the so called "keyscript mode" in which the entered password is piped through STDOUT into the actual unlocking program. The unl0kr package in pmOS's aports implements the latter as a shell script. | ||
For screenshots of the currently available themes see [https://gitlab.com/cherrypicker/unl0kr/-/tree/master/screenshots here]. | == Configuration == | ||
Unl0kr's configuration file resides in /etc/unl0kr.conf. There is currently no documentation for the existing options but you may refer to the [https://gitlab.com/cherrypicker/unl0kr/-/blob/master/unl0kr.conf example config] for inspiration. | |||
Among others, a number of built-in UI themes can be selected through the config file. For screenshots of the currently available themes see [https://gitlab.com/cherrypicker/unl0kr/-/tree/master/screenshots here]. | |||
To verify the effect of changing config options, you can run unl0kr manually from a TTY as described in the "Running within pmOS" section. To actually apply the changes during boot, you need to regenerate the init FS. | |||
== Reporting Issues == | == Reporting Issues == |
Revision as of 18:44, 31 May 2022
Unl0kr is an experimental disk unlocker UI aiming to eventually replace Osk-sdl. It is written in C using LVGL and runs on the Linux framebuffer without hardware acceleration.
By itself unl0kr doesn't actually perform any unlocking. Instead it uses the so called "keyscript mode" in which the entered password is piped through STDOUT into the actual unlocking program. The unl0kr package in pmOS's aports implements the latter as a shell script.
Configuration
Unl0kr's configuration file resides in /etc/unl0kr.conf. There is currently no documentation for the existing options but you may refer to the example config for inspiration.
Among others, a number of built-in UI themes can be selected through the config file. For screenshots of the currently available themes see here.
To verify the effect of changing config options, you can run unl0kr manually from a TTY as described in the "Running within pmOS" section. To actually apply the changes during boot, you need to regenerate the init FS.
Reporting Issues
Issues with unl0kr should be reported on the project's GitLab issues page.
There is currently no dedicated Matrix room but if needed you may contact @h3nn3s:matrix.org directly.
Running within pmOS
The unl0kr package is part of pmOS's aports directory. When installing pmOS, you can select unl0kr over osk-sdl via
$ pmbootstrap install --fde --add unl0kr
To run unl0kr from pmOS (not in initramfs) switch to a TTY (e.g. via chvt) and run
$ sudo unl0kr
Note that unl0kr conflicts with osk-sdl and you won't be able to install both at the same time.