https://github.com/m-col/mkinitcpio-welcome

mkinitcpio hooks that print the word "Welcome" in big letters and draw a box for inputting an encryption password during early userspace
https://github.com/m-col/mkinitcpio-welcome

Last synced: 2 months ago
JSON representation

mkinitcpio hooks that print the word "Welcome" in big letters and draw a box for inputting an encryption password during early userspace

• Host: GitHub
• URL: https://github.com/m-col/mkinitcpio-welcome
• Owner: m-col
• Created: 2023-03-05T01:59:55.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-05T02:07:18.000Z (about 2 years ago)
• Last Synced: 2025-01-19T10:09:12.025Z (4 months ago)
• Language: Shell
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.rst

Awesome Lists containing this project

README

        
mkinitcpio-welcome

==================

A mkinitcpio_ hook that draws out the word "Welcome" in big letters early

during the boot process and accepts input for disk decryption. A box is drawn

underneath for inputting the password and printing the output of the 'fsck'

hook.

The hook wraps and replaces the encrypt hook so that it can have greater

control over the cursor and any printed messages.

If you find that the message is squeezed into a smaller number of columns that

can fit on screen, you may need to enable early `kernel mode setting`_,

although I found enabling the `consolefont` hook also fixed the issue.

It works very well with Evan Purkhiser's `mkinitcpio-colors`_.

Usage

-----

0. Ensure that you can successfully use the `encrypt` hook without first.

1. Copy `hooks/welcome` into `/etc/initcpio/hooks`.

2. Copy `install/welcome` into `/etc/initcpio/install`.

3. Add the `welcome` hook to `/etc/mkinitcpio.conf` replacing the `encrypt` hook.

4. Optionally configure the colours to use in `/etc/vconsole.conf`:

.. code-block:: sh

   WELCOME_BG=0    # background

   WELCOME_FG=5    # foreground ("Welcome")

   WELCOME_IN=6    # input box frame

where the number is 0-15 corresponding to the 16 defined console colours.

5. Rebuild the initramfs image with `mkinitcpio`.

Contact

-------

Email me @ [email protected] for questions or contributions.

.. _mkinitcpio: https://wiki.archlinux.org/index.php/mkinitcpio

.. _mkinitcpio-colors: https://github.com/EvanPurkhiser/mkinitcpio-colors