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 at command prompt (Win32) or console (Linux etc.) in the
  10 root directory of this script:
  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. We need to change that
  16 anyway.
  17
  18 If you want to e.g. temporarily try out an other 'node mode' just add a parameter
  19 'mode=???' to 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 may
  45 get an exception called 'ClassNotFoundException' which has to be rewritten to
  46 test if the mode is valid and output a nicer message to the user.