coffin

commit c58213dbcdb7a8477b7f959836349c2361775b85
parent 14f478dc78b5d37fa6b5730df4ad6203fa7b37e5
Author: parazyd <parazyd@dyne.org>
Date:   Mon, 10 Oct 2016 13:46:08 +0200

update doc

Diffstat:
M
README.md
 | 
33
++++++++++++++++++++++++++-------

1 file changed, 26 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -1,8 +1,12 @@
-# COFFIN
+COFFIN
+======
+
 ## Crypto Office Filer For Important Nuggets
+
 Secure dedicated LAN file storage made easy
 
 ## What is this nonsense?
+
 A coffin is a dedicated device you can use to keep your files on a safe
 and encrypted place. The core workflow of the coffin is having a key
 that is autodetected by the device once plugged in. Once detected, the
@@ -15,13 +19,15 @@ files are once again unreadable.
 Install the needed dependencies on a Debian-based distro:
 
 ```
-; sudo apt-get install zsh cryptsetup libgcrypt20-dev apache2 wipe sshfs inotify-tools pinentry-curses pwgen gettext haveged sudo
+; sudo apt-get install zsh cryptsetup libgcrypt20-dev apache2 wipe sshfs inotify-tools pinentry-curses pwgen gettext haveged sudo openssl
 ```
 
-Clone this repository to the device you will be using.
+Clone this repository to the device you will be using and update repo's
+submodules.
 
 ```
 ; git clone https://github.com/parazyd/coffin.git coffin && cd coffin
+; git submodule update --init
 ```
 
 Run `make` in order to compile tomb's KDF modules.
@@ -31,21 +37,21 @@ Run `make` in order to compile tomb's KDF modules.
 ```
 
 Run `make install` as root in order to install and configure your
-device.
+machine.
 
 ```
 ; sudo make install
 ```
 
-## Notes
-
 ## Usage
+
 After installation, you will end up with an initscript in /etc/init.d/coffin
 You can start coffin by issuing `/etc/init.d/coffin start` as root and the
 watch script will begin to watch your /dev for new devices. You can see
 coffin's output by issuing (as root) `tail -f /var/log/coffin`
 
 ### Hooks
+
 Hooks are oneliners written on your USB key which will trigger actions
 on the coffin depending on their content. You can either create them
 manually or use ready scripts (GUI or CLI) from the `helpers` directory.
@@ -55,35 +61,43 @@ reading. Actually, read anyway, it will give you insight on how coffin
 works.
 
 #### Hook syntax
+
 ```
 action:userName:tombName:options
 ```
+
 So far there are only two actions (create, delete) but more are to be
 added in the future.
 To create a hook, add one or more to the `.coffin` directory in a file
 called `hook`. Separate each hook with a newline.
+
 ##### Create hook
+
 ```
 create:userName:tombName:tombSize:features
 create:undertaker:myAwesomeCrypt:50:webdav:sshfs
 ```
+
 So, to create a tomb, you will have to choose a username, a tomb name
 and the size of your choice (in MiB). This is the bare minimum.
 There are also features like `webdav` or `sshfs` that can be used to
 access your files.
+
 Currently implemented features:
 * WebDAV
-* SSHFS
+* SSH(FS)
 
 Important note is that if you use any of the features listed above you
 will have to add according files as well. For more info, please consult
 the README file inside the `conf/` directory.
 
 ##### Delete hook
+
 ```
 delete:userName:tombName
 delete:undertaker:myAwesomeCrypt
 ```
+
 To delete an existing tomb, you will have to reuse your username you
 used to create that tomb, and the tomb's name. You will also have to
 have the tomb's keyfile along with it in order to delete your stuff.
@@ -91,6 +105,7 @@ Coffin will automatically delete your WebDAV info, but will keep the ssh
 key if there is any.
 
 #### Okay, I made a hook (I think?). What do I do now?
+
 Provided it's correct, just plug your USB key to a box running coffin
 and the magic happens. Coffin will recognize if there are any hooks and
 perform according actions. After your first tomb is created, you can
@@ -98,12 +113,15 @@ plug the USB key back into your computer and there you will find some
 new files coffin needs to work correctly.
 
 ##### ttab
+
 The ttab is a file holding info on your tombs. It's syntax is
 supersimple:
+
 ```
 userName:tombName:dostuff
 undertaker:myAwesomeCrypt:true
 ```
+
 You already recognize your username and tomb name. The third part is a
 boolean value, telling coffin to either do stuff with this tomb or leave
 it alone (ex: to open/close or not to open/close). You will have to edit
@@ -115,6 +133,7 @@ into the coffin box and depending on the boolean value, coffin could
 close your tomb and make your files unreadable and encrypted :)
 
 #### How do I access my files?
+
 If you haven't added any features like WebDAV, your only way is
 accessing your files the way you accessed your box when installing.
 If you've enabled WebDAV, just use a WebDAV client and connect to your