Write up some docs

tfheen · Mar 13, 2011 · 16daf22 · 16daf22
1 parent 3a9faf6
commit 16daf22
Showing 1 changed file with 17 additions and 3 deletions.
diff --git a/README b/README
@@ -1,3 +1,17 @@
-uuidgen > challenge
-ykchalresp $(cat challenge)
-cryptsetup luksAddKey /dev/sda2
+
+ykfde - yubikey-based full disk encryption
+
+Quick start:
+
+install the package
+uuidgen > /boot/yubikey-challenge
+ykchalresp $(cat /boot/yubikey-challenge)
+cryptsetup luksAddKey /dev/sda2 /boot/yubikey-challenge
+
+On bootup, you will be asked to insert a yubikey (2.2 or newer) which
+will then provide the response.  If you do not want to use a yubikey,
+press enter and then enter a normal passphrase during bootup.
+
+Limitations/bugs:
+- uses the default ykchalresp settings, meaning no support for slot 2
+- does not update the challenge after each boot.