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
  20   * Running Cloudeebus:
  21
  22 The Cloudeebus server must be run either with credentials and a whitelist to
  23  restrict access to DBus services, or in opendoor mode.
  24
  25         usage: cloudeebus.py [-h] [-d] [-o] [-p PORT] [-c CREDENTIALS] [-w WHITELIST]
  26
  27         Javascript DBus bridge.
  28
  29         optional arguments:
  30           -h, --help            show this help message and exit
  31           -d, --debug           log debug info on standard output
  32           -o, --opendoor        allow anonymous access to all services
  33           -p PORT, --port PORT  port number
  34           -c CREDENTIALS, --credentials CREDENTIALS
  35                                 path to credentials file
  36           -w WHITELIST, --whitelist WHITELIST
  37                                 path to whitelist file
  38
  39
  40 Examples
  41 --------
  42
  43   * The /doc/dbus-tools folder contains dbus-send and dbus-register test pages.
  44
  45 Cloudeebus runs in opendoor mode, the dbus-tools pages have no manifest.
  46
  47         cloudeebus.py --debug --opendoor &
  48         firefox ./doc/dbus-tools/dbus-register.html ./doc/dbus-tools/dbus-send.html &
  49
  50   * The /doc/sample folder contains a working sample using credentials, whitelist
  51    and manifest.
  52
  53 Cloudeebus runs with credentials and a whitelist that are matched by the
  54  sample page manifest.
  55
  56         cloudeebus.py --debug --credentials=./doc/sample/CREDENTIALS --whitelist=./doc/sample/WHITELIST &
  57         firefox ./doc/sample/cloudeebus.html &
  58
  59
  60 Acknowledgements
  61 ----------------
  62
  63 Cloudeebus uses code from the following open-source projects:
  64
  65   * [AutobahnJS](http://autobahn.ws/js)
  66   * [AutobahnPython](http://autobahn.ws/python)