summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 14 insertions, 7 deletions
diff --git a/README b/README
index 4630f38..323f402 100644
--- a/README
+++ b/README
@@ -6,11 +6,13 @@ You need something else? Patch it, it's only 117 lines.
Features:
+- uses existing system tools, no compilation necessary
- password LUKS unlock
- SSH remote unlock
-- firmware loading
+- firmware loading (trivial, done by kernel)
- extremely fast initramfs creation: compression off: ~70ms cold cache, ~30ms
warm; lz4 --best: 1.6s
+- no temporary files during creation
- extremely fast initramfs runtime: ~zero overhead compared to direct kernel
loading
- minimal code: 117 SLOC total (init + make + Makefile + unlock)
@@ -18,6 +20,7 @@ Features:
Drawbacks:
+- uses existing system tools, no compilation possible
- no modprobe support. custom kernel is required to use myinitramfs. if you
want configurability, probably better to use mkinitcpio or dracut.
- pure POSIX shell + POSIX Makefile
@@ -26,21 +29,23 @@ Usage:
0. Read (skim) https://wiki.gentoo.org/wiki/Custom_Initramfs.
-1. Install busybox, dropbear, e2fsprogs (if you use ext4).
+1. Install busybox, dropbear, e2fsprogs if you use ext4, and C toolchain for
+ building gen_init_cpio.
2. Adjust ./init as required:
a) Adjust networking as required (e.g. maybe static IP instead of DHCP, or
- you don't use eth0)
- b) Adjust UUID (probably yours is not the same as mine)
- c) Adjust fsck as needed (if you are not using ext4)
- d) Put whatever you want:
+ you don't use eth0, but remember that myinitramfs has no udev, so no
+ predictable interface names)
+ b) Adjust UUID (most likely yours is not the same as mine)
+ c) Change or remove fsck for non-ext4 roots
+ d) Put whatever you want: usr mount, NFS root, whatever.
3. Adjust ./make as required:
a) Put your needed commands in gen_cpio_list.
b) Select your desired compressor at the end. Try make comp_bench for a comparison.
summary: lz4 is usually best, xz if storage is important above all (saves
a few MB but adds ~0.5s to boot), gzip is mediocre on both size and
- speed, lzo is almost always worse than lz4, never use bzip2 or lzma.
+ speed, lzo is usually worse than gzip, never use bzip2 or lzma.
4. Customize cpio_list.txt with your required files. Remember that commands
must go in ./make (for library detection), and device files except
@@ -54,3 +59,5 @@ Usage:
7. sudo make install
8. Configure your boot loader/boot manager to use initramfs.img.
+
+9. Use as usual. For remote unlock, SSH to port 2222 and "exec unlock".