docs/README

   1 README
   2 ------
   3
   4 --------------------------------------------------------------------------------
   5 1.) How to launch the hub:
   6 --------------------------------------------------------------------------------
   7
   8 At the current stage of code base you need to launch the hub by entering the
   9 following command at a command prompt (Win32) or console (Linux, etc.) in the
  10 root directory:
  11
  12 php index.php app=hub
  13
  14 Another other (later added) parameters should be added after app=hub in the same
  15 way due to the "design" of the inc/includes.php script. This file is somewhat
  16 deprecated anyway.
  17
  18 If you want to try out an other 'node mode' just add a parameter 'mode=???' to
  19 the above command by '???' can be one of the following:
  20
  21 mode=regular  -  The default mode for joining the hub network as a regular node.
  22                  This mode doesn't have to be entered manually unless you
  23                  changed the configuration entry in application/hub/config.php
  24
  25 mode=boot     -  Your node acts as a bootstrapping-node. This mode is completely
  26                  the same as the master-mode. If you can make sure that your node
  27                  is up at least 99%, every downtime of a bootstrapping-node
  28                  'hurts' the network, and that you have the latest SVN changes
  29                  you might want to contact me with your static IP number and port
  30                  number of your node so I may add it to the hard-coded list of
  31                  boostrapping-nodes.
  32
  33 mode=list     -  Your node participates as a list-node in the network which
  34                  'aids' the master-nodes by maintaining an identical list of
  35                  nodes.
  36
  37 mode=master   -  A master-node holds a list of known nodes and which types of
  38                  objects they are sharing.
  39
  40 --------------------------------------------------------------------------------
  41 2.) Current development notices:
  42 --------------------------------------------------------------------------------
  43
  44 These modes are currently not yet finished. If you try an invalid out you get a
  45 nice small error message. Still this script lacks of a 'help' command-line
  46 parameter and many more. This should be done with a nice helper class and not
  47 just 'hey, my code runs' code.
  48
  49 --------------------------------------------------------------------------------
  50 3.) Why the name "hub"
  51 --------------------------------------------------------------------------------
  52
  53 This software is simply called "hub". This has a simple reason that this is,
  54 first, the "working title" for it. And second, I have found no better name than
  55 "Generic Object Sharing Hub" for this. I would not shortcut it to "Gosh" or
  56 "GNU Gosh" or such other title, because the word "gosh" is English and
  57 completely misleading.
  58
  59 So if you have a really good ("selling") name, please send it to me:
  60 roland[at]mxchange[dot]org or webmaster[at]ship-simu[dot]org if you prefer
  61 webmaster accounts... ;-)
  62
  63 --------------------------------------------------------------------------------
  64 4.) How to start the cruncher
  65 --------------------------------------------------------------------------------
  66
  67 The cruncher is a test application (or maybe later used in a serious
  68 environment?) to find the right key for an encrypted message to decrypt it. It
  69 can be launched with this command:
  70
  71 php index.php app=hub command=cruncher
  72
  73 A producer application will follow which shall produce work units for the
  74 cruncher to work on. In the meanwhile the cruncher shall run test units which
  75 I will mainly use for development.
  76
  77 --------------------------------------------------------------------------------
  78 5.) How to start the miner
  79 --------------------------------------------------------------------------------
  80
  81 The miner is a test application (or maybe later used in a serious
  82 environment?) to find hash blocks:
  83
  84 php index.php app=hub command=miner
  85
  86 The miner now relies on ext-scrypt. I used latest GIT/master here for developing
  87 this software so you may have to do the same. I used it directly from GIT:
  88
  89 $ git clone https://github.com/DomBlack/php-scrypt.git
  90
  91 Follow their build instructions (mostly involves a "configure", "make" and "make
  92 install"). Please also note that I cannot give support on 3rd-party programs or
  93 libraries like this one. You may wish to build this PHP extension outside *this*
  94 path, not to mix them both up.
  95
  96 --------------------------------------------------------------------------------
  97 6.) How to start the crawler
  98 --------------------------------------------------------------------------------
  99
 100 The distributed crawler is a test application (or maybe later used in a serious
 101 environment?) to crawl websites and build a searchable and distributed index:
 102
 103 php index.php app=hub command=crawler
 104
 105 --------------------------------------------------------------------------------
 106 7.) How to start the chat console and use it
 107 --------------------------------------------------------------------------------
 108
 109 The chat console is yet another test application for the node. You can launch
 110 its "server-side" part by invoking this command:
 111
 112 php index.php app=hub command=chat
 113
 114 If you do so, another port xxxxx will be opened where you can telnet to:
 115
 116 telnet localhost xxxxx
 117
 118 After that you will be greeted and you are able to enter simple commands. Please
 119 do not try any 'interactive console' things like cursor key or so. This is
 120 (or will be) a very simple and basic telnet console.
 121
 122 --------------------------------------------------------------------------------
 123 8.) How to start the apt-proxy and use it
 124 --------------------------------------------------------------------------------
 125
 126 The apt-proxy is yet another test application for the node and shall provide a
 127 proxy for sharing Debian packages over the node network. You can launch its
 128 connector by invoking this command:
 129
 130 php index.php app=hub command=apt-proxy
 131
 132 If you do so, another port xxxxx will be opened which you can use in your deb
 133 and deb-src lines:
 134
 135 deb [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib
 136 deb-src [arch=amd64,i386] http://localhost:xxxxx/ftp.de.debian.org/debian unstable main non-free contrib
 137
 138 --------------------------------------------------------------------------------
 139 9.) How to start the virtual file system and use it
 140 --------------------------------------------------------------------------------
 141
 142 The FUSE virtual filesystem allows to access your node's properties and (later)
 143 many more through FUSE (Filesystem in User SpacE). You need the PHP extension
 144 'fuse' enabled in your php.ini and please use latest SVN code from
 145 https://svn.php.net/repository/pecl/fuse/trunk as I also use it. If fuse.dll/so
 146 is correctly installed and enabled in php.ini, you can try to start it like this:
 147
 148 php index.php app=hub command=fuse
 149
 150 If all went smooth, you can then access the virtual file system through the
 151 mount point 'fuse' in root directory.