In case of non-blocking connections (and that is for 99.9999% the case here)

[hub.git] / docs / README

diff --git a/docs/README b/docs/README
index c634470873cfedc47dccea62475cbf30567c690f..1c27ada580cc673e2d7a6e6e8cb4fa6deecd3df3 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -83,8 +83,27 @@ environment?) to find hash blocks:
 
 php index.php app=hub command=miner
 
+The miner now relies on ext-scrypt. I used latest GIT/master here for developing
+this software so you may have to do the same. I used it directly from GIT:
+
+$ git clone https://github.com/DomBlack/php-scrypt.git
+
+Follow their build instructions (mostly involves a "configure", "make" and "make
+install"). Please also note that I cannot give support on 3rd-party programs or
+libraries like this one. You may wish to build this PHP extension outside *this*
+path, not to mix them both up.
+
+--------------------------------------------------------------------------------
+6.) How to start the crawler
+--------------------------------------------------------------------------------
+
+The distributed crawler is a test application (or maybe later used in a serious
+environment?) to crawl websites and build a searchable and distributed index:
+
+php index.php app=hub command=crawler
+
 --------------------------------------------------------------------------------
-6.) How to start the chat console and use it
+7.) How to start the chat console and use it
 --------------------------------------------------------------------------------
 
 The chat console is yet another test application for the node. You can launch
@@ -101,7 +120,7 @@ do not try any 'interactive console' things like cursor key or so. This is
 (or will be) a very simple and basic telnet console.
 
 --------------------------------------------------------------------------------
-7.) How to start the apt-proxy and use it
+8.) How to start the apt-proxy and use it
 --------------------------------------------------------------------------------
 
 The apt-proxy is yet another test application for the node and shall provide a
@@ -115,3 +134,18 @@ and deb-src lines:
 
 deb [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib
 deb-src [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib
+
+--------------------------------------------------------------------------------
+9.) How to start the virtual file system and use it
+--------------------------------------------------------------------------------
+
+The FUSE virtual filesystem allows to access your node's properties and (later)
+many more through FUSE (Filesystem in User SpacE). You need the PHP extension
+'fuse' enabled in your php.ini and please use latest SVN code from
+https://svn.php.net/repository/pecl/fuse/trunk as I also use it. If fuse.dll/so
+is correctly installed and enabled in php.ini, you can try to start it like this:
+
+php index.php app=hub command=fuse
+
+If all went smooth, you can then access the virtual file system through the
+mount point 'fuse' in root directory.