README.md

   1
   2 Cloudeebus
   3 ==========
   4
   5 Cloudeebus - DBus for the Cloud - is a component which enables calling DBus
   6  methods and registering on DBus signals from Javascript.
   7
   8
   9 Install
  10 -------
  11
  12 ### Installing Cloudeebus from the project root directory:
  13
  14 Cloudeebus will install itself in Python's dist-packages folder. The
  15  cloudeebus.py wrapper shell goes in the executables path.
  16
  17         sudo python setup.py install
  18
  19 See the [Getting Started](https://github.com/01org/cloudeebus/wiki/Getting-started)
  20  section of the [Cloudeebus wiki](https://github.com/01org/cloudeebus/wiki)
  21  for a list of dependencies to install.
  22
  23
  24 ### Running Cloudeebus:
  25
  26 The Cloudeebus server must be run either with credentials and a whitelist to
  27  restrict access to DBus services, or in opendoor mode.
  28
  29         usage: cloudeebus.py [-h] [-v] [-d] [-o] [-p PORT] [-c CREDENTIALS]
  30                              [-w WHITELIST] [-s SERVICELIST] [-n NETMASK]
  31
  32         Javascript DBus bridge.
  33
  34         optional arguments:
  35           -h, --help            show this help message and exit
  36           -v, --version         print version and exit
  37           -d, --debug           log debug info on standard output
  38           -o, --opendoor        allow anonymous access to all services
  39           -p PORT, --port PORT  port number
  40           -c CREDENTIALS, --credentials CREDENTIALS
  41                                 path to credentials file
  42           -w WHITELIST, --whitelist WHITELIST
  43                                 path to whitelist file (DBus services to use)
  44           -s SERVICELIST, --servicelist SERVICELIST
  45                                 path to servicelist file (DBus services to export)
  46           -n NETMASK, --netmask NETMASK
  47                                 netmask,IP filter (comma separated.) eg. : -n
  48                                 127.0.0.1,192.168.2.0/24,10.12.16.0/255.255.255.0
  49
  50
  51 Documentation
  52 -------------
  53
  54   * [Cloudeebus](http://01.org/cloudeebus) project home page on [01.org](http://01.org)
  55   * [Javascript API](https://github.com/01org/cloudeebus/wiki/API) reference.
  56   * [Architecture](https://github.com/01org/cloudeebus/wiki/Architecture) block diagram.
  57
  58
  59 Examples
  60 --------
  61
  62 ### dbus-tools
  63
  64 The /doc/dbus-tools folder contains dbus-send and dbus-register test pages.
  65 Cloudeebus runs in opendoor mode, the dbus-tools pages have no manifest.
  66
  67         cloudeebus.py --debug --opendoor --port=9001 &
  68         firefox ./doc/dbus-tools/dbus-register.html ./doc/dbus-tools/dbus-send.html &
  69
  70 ### sample
  71
  72 The /doc/sample folder contains a working sample using credentials, whitelist and manifest.
  73 Cloudeebus runs with credentials and a whitelist that are matched by the
  74  sample page manifest.
  75
  76         cloudeebus.py --debug --credentials=./doc/sample/CREDENTIALS --whitelist=./doc/sample/WHITELIST &
  77         firefox ./doc/sample/cloudeebus.html &
  78
  79 The sample page is also online as a [live demo](http://01org.github.com/cloudeebus/).
  80
  81 ### agent
  82
  83 The /doc/agent folder contains a working client sample using credentials, whitelist and manifest and
  84 a working service sample using credentials, servicelist and manifest.
  85 One instance of cloudeebus runs with credentials and a whitelist that are matched by the
  86 client page manifest.
  87
  88         cloudeebus.py --debug --credentials=./doc/agent/CREDENTIALS --whitelist=./doc/agent/SAMPLELIST -p 9002 &
  89         firefox ./doc/agent/client.html &
  90
  91 The other instance of cloudeebus runs with credentials and a servicelist that are matched by the
  92 server page manifest.
  93
  94         cloudeebus.py --debug --credentials=./doc/agent/CREDENTIALS --servicelist=./doc/agent/SAMPLELIST -p 9003 &
  95         firefox ./doc/agent/server.html &
  96
  97
  98 Acknowledgements
  99 ----------------
 100
 101 Cloudeebus uses code from the following open-source projects:
 102
 103   * [AutobahnJS](http://autobahn.ws/js) ([MIT](http://opensource.org/licenses/MIT) License)
 104   * [AutobahnPython](http://autobahn.ws/python) ([Apache 2.0](http://opensource.org/licenses/Apache-2.0) License)