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 mayber 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.