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] [-w WHITELIST]
  30
  31         Javascript DBus bridge.
  32
  33         optional arguments:
  34           -h, --help            show this help message and exit
  35           -d, --debug           log debug info on standard output
  36           -v, --version         print version and exit
  37           -o, --opendoor        allow anonymous access to all services
  38           -p PORT, --port PORT  port number
  39           -c CREDENTIALS, --credentials CREDENTIALS
  40                                 path to credentials file
  41           -w WHITELIST, --whitelist WHITELIST
  42                                 path to whitelist file
  43
  44
  45 Examples
  46 --------
  47
  48 ### dbus-tools
  49
  50 The /doc/dbus-tools folder contains dbus-send and dbus-register test pages.
  51 Cloudeebus runs in opendoor mode, the dbus-tools pages have no manifest.
  52
  53         cloudeebus.py --debug --opendoor &
  54         firefox ./doc/dbus-tools/dbus-register.html ./doc/dbus-tools/dbus-send.html &
  55
  56 ### sample
  57
  58 The /doc/sample folder contains a working sample using credentials, whitelist and manifest.
  59 Cloudeebus runs with credentials and a whitelist that are matched by the
  60  sample page manifest.
  61
  62         cloudeebus.py --debug --credentials=./doc/sample/CREDENTIALS --whitelist=./doc/sample/WHITELIST &
  63         firefox ./doc/sample/cloudeebus.html &
  64
  65 The sample page is also online as a [live demo](http://01org.github.com/cloudeebus/).
  66
  67 Acknowledgements
  68 ----------------
  69
  70 Cloudeebus uses code from the following open-source projects:
  71
  72   * [AutobahnJS](http://autobahn.ws/js) ([MIT](http://opensource.org/licenses/MIT) License)
  73   * [AutobahnPython](http://autobahn.ws/python) ([Apache 2.0](http://opensource.org/licenses/Apache-2.0) License)