Jump to content

Unl0kr: Difference between revisions

From postmarketOS Wiki
Add configuration section
Split running 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.


== Configuration ==
== Installation ==
 
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 ==
 
Issues with unl0kr should be reported on [https://gitlab.com/cherrypicker/unl0kr/issues the project's GitLab issues page].


There is currently no dedicated Matrix room but if needed you may contact @h3nn3s:matrix.org directly.
{{note|1=<nowiki/>
 
Unl0kr conflicts with osk-sdl and you won't be able to install both at the same time
== Running within pmOS ==
}}


The unl0kr package is part of pmOS's aports directory. When installing pmOS, you can select unl0kr over osk-sdl via
The unl0kr package is part of pmOS's aports directory. When installing pmOS, you can select unl0kr over osk-sdl via
Line 25: Line 15:
</syntaxhighlight>
</syntaxhighlight>


To run unl0kr from pmOS (not in initramfs) switch to a TTY (e.g. via chvt) and run
Alternatively, you may also install unl0kr into a running system with apk. Installing the package automatically triggers regeneration of the initramfs.
 
== Running outside the initramfs ==
 
For testing purposes, you can run unl0kr outside the boot process. Simply switch to a TTY (e.g. with chvt) and run


<syntaxhighlight lang="shell-session">
<syntaxhighlight lang="shell-session">
Line 31: Line 25:
</syntaxhighlight>
</syntaxhighlight>


Note that unl0kr conflicts with osk-sdl and you won't be able to install both at the same time.
As mentioned above, unl0kr only prints the entered password to STDOUT so this won't actually do anything to your disks.
 
== 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 initramfs.
 
== Reporting Issues ==
 
Issues with unl0kr should be reported on [https://gitlab.com/cherrypicker/unl0kr/issues the project's GitLab issues page].
 
There is currently no dedicated Matrix room but if needed you may contact @h3nn3s:matrix.org directly.


[[Category:Guide]]
[[Category:Guide]]

Revision as of 18:55, 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.

Installation

Note Unl0kr conflicts with osk-sdl and you won't be able to install both at the same time

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

Alternatively, you may also install unl0kr into a running system with apk. Installing the package automatically triggers regeneration of the initramfs.

Running outside the initramfs

For testing purposes, you can run unl0kr outside the boot process. Simply switch to a TTY (e.g. with chvt) and run

$ sudo unl0kr

As mentioned above, unl0kr only prints the entered password to STDOUT so this won't actually do anything to your disks.

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 initramfs.

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.