diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 46 insertions, 1 deletions
@@ -1,4 +1,49 @@ mkinitcpio-ykfde ================ -Full disk encryption with Yubikey (Yubico key) +**Full disk encryption with Yubikey (Yubico key)** + +This allows to automatically unlock a LUKS encrypted hard disk from `systemd`- +enabled initramdfs. + +Requirements +------------ + +To compile and use yubico full disk encryption you need: + +* [iniparser](http://ndevilla.free.fr/iniparser/) +* [systemd](http://www.freedesktop.org/wiki/Software/systemd/) +* [mkinitcpio](https://projects.archlinux.org/mkinitcpio.git/) (Though + it may be easy to port this to any initramfs that uses systemd) +* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation) + +Additionally it is expected to have `make` and `pkg-config` around to +successfully compile. + +Build and install +----------------- + +Building and installing is very easy. Just run: + +> make + +followed by: + +> make install + +This will place file to their desired places in filesystem. + +Usage +----- + +First prepare the key. Plug it in, make sure it is configured for HMAC- +SHA1, then run: + +> ykfde -d /dev/`LUKS-device` + +This will add a new slot to your LUKS device. Add `ykfde` to your hook +list in `/etc/mkinitcpio.conf` and rebuild your initramfs with: + +> mkinitcpio -p linux + +Reboot and have fun! |