diff options
| author | Andrei A. Bykov | 2025-04-11 13:36:49 -0300 |
|---|---|---|
| committer | Andrei A. Bykov | 2025-04-11 13:36:49 -0300 |
| commit | 6c736bed4422043a1e1823d47392bb6306587537 (patch) | |
| tree | d308b9cc55976b606cd7fd1dab91c305501bcbab | |
| parent | cb042d7b3419a35ec639c6f6aba03c71ece95189 (diff) | |
| parent | 53a1b7edbab20cd4e732eed948d0008e4bd233e1 (diff) | |
| download | aur-6c736bed4422043a1e1823d47392bb6306587537.tar.gz | |
Merge remote-tracking branch 'aur/master'
Merge branch 'aur/master
| -rw-r--r-- | README.md | 49 |
1 files changed, 36 insertions, 13 deletions
diff --git a/README.md b/README.md index ff5b9efd6cc6..aa2e376a1d91 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ Custom mkinitcpio hook to mount a container image from a block device before running the `encrypt` hook. -## What it does +--- + +## ๐ก What it does This hook is intended for use cases where your encrypted root filesystem is stored *inside a container file* on a block device, rather than on the block device itself. @@ -18,34 +20,55 @@ It: 3. Attaches it to a loop device 4. Makes the loop device available to the `encrypt` hook, via standard `cryptdevice=...` kernel parameter -## Kernel cmdline usage +--- + +## ๐งต Kernel cmdline usage You must add the following parameters to your kernel cmdline: src_dev=/dev/your_block_device src_img=/relative/path/to/container.img cryptdevice=/dev/loop0:your_crypt_name root=/dev/mapper/your_crypt_name + Example: src_dev=/dev/nvme0n1p3 src_img=/crypto/rootfs.img cryptdevice=/dev/loop0:cryptroot root=/dev/mapper/cryptroot -## On Arch-based distros you can install this package from AUR: -paru -S mkinitcpio-hook-neoshy (Of cause you can use another aur-helper :) ) -or just makepkg -i in source directory +--- + +## ๐ฆ Installation + +### โ
On Arch-based distros (AUR): + +Install via your favorite AUR helper: -## Installation on another distros: -make install +```bash +paru -S mkinitcpio-hook-neoshy +# or +yay -S mkinitcpio-hook-neoshy -Then add `neoshy` **before** `encrypt` in your `/etc/mkinitcpio.conf` HOOKS-section: -HOOKS=(base udev autodetect modconf block keyboard `neoshy` `encrypt` filesystems fsck) +Or manually: + +git clone https://aur.archlinux.org/mkinitcpio-hook-neoshy.git +cd mkinitcpio-hook-neoshy +makepkg -si + +๐ป On other distros (manual install): + +make install + +๐ง Configuration + +After installation, add neoshy before encrypt in your /etc/mkinitcpio.conf HOOKS array: + +HOOKS=(base udev autodetect modconf block keyboard neoshy encrypt filesystems fsck) Then rebuild your initramfs: + sudo mkinitcpio -P -## License +๐ License MIT ---- -Author: Andrei A. Bykov <andrei.a.bykov@hotmail.com> - +Maintainer: Andrei A. Bykov <andrei.a.bykov@hotmail.com> |