Adding some informations in Readme
authorFrederic PAUT <frederic.paut@linux.intel.com>
Wed, 3 Jul 2013 13:49:05 +0000 (15:49 +0200)
committerFrederic PAUT <frederic.paut@linux.intel.com>
Wed, 3 Jul 2013 13:50:08 +0000 (15:50 +0200)
README.md
cloudeebus/cloudeebus.py
doc/agent/client.html

index 44c322b..2451ed8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,17 +32,21 @@ The Cloudeebus server must be run either with credentials and a whitelist to
        
        optional arguments:
          -h, --help            show this help message and exit
-         -d, --debug           log debug info on standard output
          -v, --version         print version and exit
+         -d, --debug           log debug info on standard output
          -o, --opendoor        allow anonymous access to all services
          -p PORT, --port PORT  port number
          -c CREDENTIALS, --credentials CREDENTIALS
-                               path to credentials file
-         -w WHITELIST, --whitelist WHITELIST
-                               path to whitelist file
+                               path to credentials file
+         -w WHITELIST , --whitelist  WHITELIST 
+                               path to whitelist file (which the list of allowed DBus
+                               service to use)
+         -s SERVICELIST, --servicelist SERVICELIST
+                               path to servicelist file (which the list of allowed
+                               DBus service to create (=agent))
          -n NETMASK, --netmask NETMASK
-                               netmask,IP filter (comma separated.) eg. :
-                               -n 127.0.0.1,192.168.2.0/24,10.12.16.0/255.255.255.0
+                               netmask,IP filter (comma separated.) eg. : -n
+                               127.0.0.1,192.168.2.0/24,10.12.16.0/255.255.255.0
 
 
 Documentation
@@ -75,6 +79,22 @@ Cloudeebus runs with credentials and a whitelist that are matched by the
 
 The sample page is also online as a [live demo](http://01org.github.com/cloudeebus/).
 
+### agent
+
+The /doc/agent folder contains a working client sample using credentials, whitelist and manifest and
+a working service sample using credentials, servicelist and manifest.
+One instance of cloudeebus runs with credentials and a whitelist that are matched by the 
+client page manifest.
+
+       cloudeebus.py --debug --credentials=./doc/agent/CREDENTIALS --whitelist=./doc/agent/SAMPLELIST -p 9002 &
+       firefox ./doc/agent/client.html &
+
+The other instance of cloudeebus runs with credentials and a servicelist that are matched by the 
+server page manifest.
+
+       cloudeebus.py --debug --credentials=./doc/agent/CREDENTIALS --servicelist=./doc/agent/SAMPLELIST -p 9003 &
+       firefox ./doc/agent/server.html &
+
 
 Acknowledgements
 ----------------
index f99153b..66e646d 100755 (executable)
@@ -743,9 +743,9 @@ if __name__ == '__main__':
     parser.add_argument('-c', '--credentials',
         help='path to credentials file')
     parser.add_argument('-w', '--whitelist',
-        help='path to whitelist file')
+        help='path to whitelist file (which the list of allowed DBus service to use)')
     parser.add_argument('-s', '--servicelist',
-        help='path to servicelist file')
+        help='path to servicelist file (which the list of allowed DBus service to create (=agent))')
     parser.add_argument('-n', '--netmask',
         help='netmask,IP filter (comma separated.) eg. : -n 127.0.0.1,192.168.2.0/24,10.12.16.0/255.255.255.0')
     
index 123779c..ac09ebf 100644 (file)
@@ -90,7 +90,7 @@ function connectSuccess() {
   cloudeebus.SessionBus().getObject("org.cloudeebus.Sample", "/org/cloudeebus/Sample", gotProxy, errorCB);
 }
 
-cloudeebus.connect("ws://localhost:9003", manifest, connectSuccess, errorCB);
+cloudeebus.connect("ws://localhost:9002", manifest, connectSuccess, errorCB);
 </textarea>
                <br>
                <input type="button" value="run script" onclick="evalScript()"/>