Add CoAP over Websocket interface in cloud
[platform/upstream/iotivity.git] / cloud / interface / README
1 This project contains the Cloud Interface(CI) Server code.
2
3 Build and Run
4
5 1) Install Apache Maven if you don't have it
6
7         http://maven.apache.org
8
9 2) Build a CloudStack. If you are building first time, then build the stack.
10
11         go to "stack" folder in root directory
12         $ mvn install -Dmaven.test.skip=true
13
14 3) Build a .jar file
15
16         $ mvn install -Dmaven.test.skip=true
17
18         - The CloudInterface-0.0.1-SNAPSHOT.jar file will be placed in the "target" folder
19
20 4) Run .jar file
21
22         go to "target" folder
23         $ java -jar CloudInterface-0.0.1-SNAPSHOT.jar arg1(CI CoAP Server Port) arg2(RD CoAP Server IP) arg3(RD CoAP Server Port) arg4(Account Server IP) arg5(Account Server Port) arg6(MQBroker IP) arg7(MQBroker Port)
24                 arg8(CI Http-CoAP proxy server port, '0' if unnecessary) arg9(CI CoAP websocket server port, '0' if unnecessary) arg10(TLS mode <0|1> required) arg11(web log IP, optional) and arg12(web log port, optional)
25         e.g. java -jar CloudInterface-0.0.1-SNAPSHOT.jar 5683 127.0.0.1 5684 127.0.0.1 5685 127.0.0.1 5686 80 8080 0
26
27         - Before running a CI server, you should run a RD server, Account server and MQBroker first.
28         - If you want to operate on TLS mode, "CLOUD_CERT_FILE(iotivitycloud.crt)", "CLOUD_KEY_FILE(iotivitycloud.key)" and ROOT_CERT_FILE(rootca.crt) files should be placed in the "target" folder.