README
------

--------------------------------------------------------------------------------
1.) How to launch the hub:
--------------------------------------------------------------------------------

At the current stage of code base you need to launch the hub by entering the
following command at a command prompt (Win32) or console (Linux, etc.) in the
root directory:

php index.php app=hub

Another other (later added) parameters should be added after app=hub in the same
way due to the "design" of the inc/includes.php script. This file is somewhat
deprecated anyway.

If you want to try out an other 'node mode' just add a parameter 'mode=???' to
the above command by '???' can be one of the following:

mode=regular  -  The default mode for joining the hub network as a regular node.
                 This mode doesn't have to be entered manually unless you
                 changed the configuration entry in application/hub/config.php

mode=boot     -  Your node acts as a bootstrapping-node. This mode is completely
                 the same as the master-mode. If you can make sure that your node
                 is up at least 99%, every downtime of a bootstrapping-node
                 'hurts' the network, and that you have the latest SVN changes
                 you might want to contact me with your static IP number and port
                 number of your node so I may add it to the hard-coded list of
                 boostrapping-nodes.

mode=list     -  Your node participates as a list-node in the network which
                 'aids' the master-nodes by maintaining an identical list of
                 nodes.

mode=master   -  A master-node holds a list of known nodes and which types of
                 objects they are sharing.

--------------------------------------------------------------------------------
2.) Current development notices:
--------------------------------------------------------------------------------

These modes are currently not yet finished. If you try an invalid out you get a
nice small error message. Still this script lacks of a 'help' command-line
parameter and many more. This should be done with a nice helper class and not
just 'hey, my code runs' code.

--------------------------------------------------------------------------------
3.) Why the name "hub"
--------------------------------------------------------------------------------

This software is simply called "hub". This has a simple reason that this is,
first, the "working title" for it. And second, I have found no better name than
"Generic Object Sharing Hub" for this. I would not shortcut it to "Gosh" or
"GNU Gosh" or such other title, because the word "gosh" is english and
completely misleading.

So if you have a really good ("selling") name, please send it to me:
roland[at]mxchange[dot]org or webmaster[at]ship-simu[dot]org if you prefer
webmaster accounts... ;-)