Skip to content

Commit

Permalink
v2.3.0: new release.
Browse files Browse the repository at this point in the history
  • Loading branch information
@npeditto
npeditto committed Oct 22, 2018
1 parent a47193e commit 6c4a0a0
Show file tree
Hide file tree
Showing 16 changed files with 954 additions and 96 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ RUN apt-get update && apt-get install -y \
git python-dev python-setuptools libyaml-dev libpython2.7-dev nmap unzip socat bridge-utils python-pip python-httplib2 libssl-dev libffi-dev \
&& rm -rf /var/lib/apt/lists/*

RUN npm install -g --unsafe @mdslab/wstun [email protected] requestify mysql nconf ip express node-uuid autobahn q body-parser ps-node nodemailer nodemailer-smtp-transport swagger-jsdoc cors bcrypt optimist jsonwebtoken md5\
RUN npm install -g --unsafe @mdslab/wstun [email protected] requestify mysql nconf ip express node-uuid autobahn@18.10.2 q body-parser ps-node nodemailer nodemailer-smtp-transport swagger-jsdoc cors bcrypt optimist jsonwebtoken md5\
&& npm cache --force clean

RUN mkdir -p /var/lib/iotronic/plugins \
Expand Down
96 changes: 73 additions & 23 deletions docs/installation_ubuntu_14.04.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,25 +67,29 @@ during the installation the procedure asks the following information:

* ##### Install dependencies using npm
```
npm install -g --unsafe [email protected] requestify mysql nconf ip express node-uuid autobahn q body-parser ps-node nodemailer nodemailer-smtp-transport swagger-jsdoc cors bcrypt optimist jsonwebtoken md5 crypto
npm install -g --unsafe [email protected] requestify mysql nconf ip express node-uuid autobahn@18.10.2 [email protected] q body-parser ps-node nodemailer nodemailer-smtp-transport swagger-jsdoc cors bcrypt optimist jsonwebtoken md5 crypto
npm install -g --unsafe @mdslab/wstun
```

* ##### Setup IoTronic environment
```
mkdir /var/lib/iotronic/
cd /usr/lib/node_modules/@mdslab/
cd $NODE_PATH/
git clone git://github.com/MDSLab/s4t-iotronic-standalone.git
mv s4t-iotronic-standalone/ iotronic-standalone
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/init.d/s4t-iotronic /etc/init.d/
cp $NODE_PATH/iotronic-standalone/etc/init.d/s4t-iotronic /etc/init.d/
chmod +x /etc/init.d/s4t-iotronic
sed -i '/^ *#/b; s%exit 0%/etc/init.d/s4t-iotronic start\nexit 0%g' /etc/rc.local
mkdir -p /var/lib/iotronic/drivers/
mkdir -p /var/log/iotronic/plugins/
mkdir -p /var/log/wstun/
cp $NODE_PATH/@mdslab/iotronic-standalone/utils/templates/settings.example.json /var/lib/iotronic/settings.json
cp $NODE_PATH/@mdslab/iotronic-standalone/utils/templates/board_settings_template.json /var/lib/iotronic/board_settings_template.json
echo "IOTRONIC_HOME=/var/lib/iotronic" >> /etc/environment
source /etc/environment
Expand All @@ -94,50 +98,53 @@ echo $IOTRONIC_HOME

* ##### Setup Crossbar.io environment
```
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/init.d/crossbar /etc/init.d/
cp $NODE_PATH/iotronic-standalone/etc/init.d/crossbar /etc/init.d/
chmod +x /etc/init.d/crossbar
sed -i '/^ *#/b; s%exit 0%/etc/init.d/crossbar start\nexit 0%g' /etc/rc.local
```


* ##### Configure Websocket reverse tunnel (WSTUN) server
```
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/init.d/wstun /etc/init.d/
cp $NODE_PATH/iotronic-standalone/etc/init.d/wstun /etc/init.d/
chmod +x /etc/init.d/wstun
sed -i '/^ *#/b; s%exit 0%/etc/init.d/wstun start\nexit 0%g' /etc/rc.local
```

* ##### Import IoTronic-standalone database
You need to import the IoTronic database schema. During the installation of the MySQL package you should have been asked for a database root password. Please note that name of the database is set to "s4t-iotronic". If you want to change it, please consider that later on you will need to correctly change it in other configuration files.
```
mysql -u root -p < /usr/lib/node_modules/@mdslab/iotronic-standalone/utils/s4t-db.sql
mysql -u root -p < $NODE_PATH/iotronic-standalone/utils/s4t-db.sql
```


## Configure Crossbar.io router
Configure Crossbar with SSL:
```
mkdir /etc/crossbar
[for HTTP]
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/crossbar/config.example.json /etc/crossbar/config.json
[for HTTPS]
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/crossbar/config.SSL.example.json /etc/crossbar/config.json
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/crossbar/config.SSL.example.json /etc/crossbar/config.json
vim /etc/crossbar/config.json
"key": "<PRIVATE-KEY.PEM>",
"certificate": "<PUBLIC-CERT.PEM>",
"chain_certificates": [<CHAIN-CERT.PEM>]
```

or without SSL:
```
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/crossbar/config.example.json /etc/crossbar/config.json
```
at the end check the configuration:
```
crossbar check --cbdir /etc/crossbar
```

Please, note that the config[.SSL].example.json coming with the iotronic-standalone package sets the name of the WAMP realm to "s4t" and the Crossbar.io listening port to "8181". If you want to change such values, please consider that later on you will need to correctly change them in other configuration files.



## Configure IoTronic-standalone

Please, note that the settings.example.json coming with the iotronic-standalone package sets the IoTronic listening port to "8888", the database name to "s4t-iotronic" (the database server is supposed to be running locally), the WAMP realm to "s4t" (the Crossbar.io WAMP router is supposed to be running locally on port 8181). If you want to change such values, please consider that later on you will need to correctly change them in other configuration files.
Please, note that the settings.example.json coming with the iotronic-standalone package sets the IoTronic listening port to "8888", the database name to "s4t-iotronic" (the database server is supposed to be running locally), the WAMP realm to "s4t" (the Crossbar.io WAMP router is supposed to be running locally on port 8181). If you want to change such values, please consider that later on you will need to correctly change them in other configuration files.

Open /var/lib/iotronic/settings.json:
- specify the NIC (e.g., change <INTERFACE> with "eth0") or the public IP and the port that IoTronic supposed to use to expose its REST interface;
Expand Down Expand Up @@ -185,10 +192,42 @@ if you would like to use HTTPS to expose them you have to specify the "https" se
}
```


- configure and enable Iotronic modules:
```
"modules": {
"plugins_manager": {
"enabled": true
},
etc
}
```

each Iotronic module (e.g. "plugins_manager") has a flag "enabled" to set at true or false in order to enable o disable that module.

In particular, the Service Manager module, has to be configured properly (if enabled):

```
"services_manager": {
"enabled": true,
"wstun":
{
"port_range":{
"high":40100,
"low": 40001
},
"public_ip":""
}
},
```
- in the "port_range" section you must specify the range (high and low) of the ports used by this module to expose the board services.
- the "public_ip" field is used to specify the public IP exposed by Iotronic that the user uses (with the port assigned by Iotronic) to reach the running service in his board.


Set authentication parameters:
- create SuperAdmin token ("adminToken" to set below in the settings.json):
```
node /usr/lib/node_modules/@mdslab/iotronic-standalone/utils/createAdminToken.js <PASSWORD>
node $NODE_PATH/@mdslab/iotronic-standalone/utils/createAdminToken.js <PASSWORD>
```
- open /var/lib/iotronic/settings.json:
```
Expand All @@ -197,6 +236,7 @@ node /usr/lib/node_modules/@mdslab/iotronic-standalone/utils/createAdminToken.js
"adminToken": "<GENERATED-BEFORE>",
"backend": "iotronic",
"expire_time": "30m"
"auth_lr_mode":"basic"
}
```
The "encryptKey" field is a user-defined keyword/password used to encrypt/decrypt the users passwords during authentication procedures.
Expand All @@ -207,24 +247,34 @@ The "expire_time" field is expressed in seconds (e.g.: 60) or as string describi
If you decide to express this field in seconds you MUST specify it as integer (e.g. 60 -> 1 minute)
NOT as a string (e.g. "60" -> 60 milliseconds).

Through "auth_lr_mode" field you can set the authentication mode used by Iotronic to authenticate the Lightning-rod istances. The mode supported are:
- "basic": Iotronic check only if the board ID provided by the board is registered in the database. If a second board try to connect through the same board ID, the login will be rejected.
- "password": Iotronic check the password provided by the board during the login procedure. The password is between 4 and 36 char long.
- "certs": Iotronic verify the signature provided by the board, through the public-key of the board that Iotronic saved in the registration phase into the database.

## Start IoTronic-standalone

#### Start services
##### Start services
```
/etc/init.d/crossbar start
/etc/init.d/wstun start
systemctl start crossbar
systemctl start wstun
/etc/init.d/crossbar status
/etc/init.d/wstun status
systemctl status crossbar
systemctl status wstun
```
Now you are ready to start Iotronic:
```
/etc/init.d/s4t-iotronic start
systemctl start iotronic-standalone.service
systemctl status iotronic-standalone.service
```
You can check logs by typing:
```
tail -f /var/log/iotronic/s4t-iotronic.log
and
tail -f /var/log/wstun/wstun.log
```

##### Register Admin user and project
Expand Down Expand Up @@ -263,7 +313,7 @@ RESPONSE:


## API documentation management
IoTronic releases its APIs documentation by means of Swagger framework. In particular we used ["swagger-jsdoc"](https://www.npmjs.com/package/swagger-jsdoc) and ["swagger-ui"](https://swagger.io/swagger-ui/)
IoTronic releases its APIs documentation by means of Swagger framework. In particular we used ["swagger-jsdoc"](https://www.npmjs.com/package/swagger-jsdoc) and ["swagger-ui"](https://swagger.io/swagger-ui/)
respectively to describe each RESTful API in the source code and publish the produced documentation.

Iotronic is able to expose the documentation:
Expand Down Expand Up @@ -368,7 +418,7 @@ Script usage:
node iotronic-docs-gen.js --iotronic="<IOTRONIC_SOURCE_CODE_PATH>" -e [true|false] [ -p <API_DOCS_PORT> ] [ -w <SWAGGER-JSON-SAVE-PATH>]
```
options:
- -i, --iotronic IoTronic suorce code path. (e.g. "/usr/lib/node_modules/@mdslab/iotronic-standalone/")
- -i, --iotronic IoTronic suorce code path. (e.g. "$NODE_PATH/@mdslab/iotronic-standalone/")
- -e, --embedded true | false to spawn API webpage documentation; if "false" the "iotronic-swagger.json" will be created in the <SWAGGER-DIST-PATH> folder specified in the "settings.json" file in the "docs" section.
- -p, --port [only with --embedded=true] Listening port. (this port has to be different from the ports used by IoTronic "http(s)_port")
- -w, --web Web server path: where will be created the swagger json file "iotronic-swagger.json".
Expand Down
67 changes: 55 additions & 12 deletions docs/installation_ubuntu_16.04.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,29 +63,31 @@ during the installation the procedure asks the following information:

* ##### Install dependencies using npm
```
npm install -g --unsafe [email protected] requestify mysql nconf ip express node-uuid autobahn q body-parser ps-node nodemailer nodemailer-smtp-transport swagger-jsdoc cors bcrypt optimist jsonwebtoken md5 crypto
npm install -g --unsafe [email protected] requestify mysql nconf ip express node-uuid autobahn@18.10.2 [email protected] q body-parser ps-node nodemailer nodemailer-smtp-transport swagger-jsdoc cors bcrypt optimist jsonwebtoken md5 crypto
npm install -g --unsafe @mdslab/wstun
```

* ##### Setup IoTronic environment
```
mkdir /var/lib/iotronic/
cd /usr/lib/node_modules/@mdslab/
cd $NODE_PATH/@mdslab/
git clone git://github.com/MDSLab/s4t-iotronic-standalone.git
mv s4t-iotronic-standalone/ iotronic-standalone
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/systemd/system/iotronic-standalone.service /etc/systemd/system/
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/systemd/system/iotronic-standalone.service /etc/systemd/system/
sed -i "s|ExecStart=<IOTRONIC-LAUNCHER>|ExecStart=$NODE_PATH/@mdslab/iotronic-standalone/bin/server|g" /etc/systemd/system/iotronic-standalone.service
chmod +x /etc/systemd/system/iotronic-standalone.service
systemctl daemon-reload
systemctl enable iotronic-standalone.service
mkdir -p /var/lib/iotronic/drivers/
mkdir -p /var/log/iotronic/plugins/
mkdir -p /var/log/wstun/
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/settings.example.json /var/lib/iotronic/settings.json
cp $NODE_PATH/@mdslab/iotronic-standalone/utils/templates/settings.example.json /var/lib/iotronic/settings.json
cp $NODE_PATH/@mdslab/iotronic-standalone/utils/templates/board_settings_template.json /var/lib/iotronic/board_settings_template.json
echo "IOTRONIC_HOME=/var/lib/iotronic" >> /etc/environment
source /etc/environment
Expand All @@ -94,7 +96,7 @@ echo $IOTRONIC_HOME

* ##### Setup Crossbar.io environment
```
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/systemd/system/crossbar.service /etc/systemd/system/
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/systemd/system/crossbar.service /etc/systemd/system/
chmod +x /etc/systemd/system/crossbar.service
systemctl daemon-reload
systemctl enable crossbar.service
Expand All @@ -103,7 +105,7 @@ systemctl enable crossbar.service

* ##### Configure Websocket reverse tunnel (WSTUN) server
```
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/systemd/system/wstun.service /etc/systemd/system/
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/systemd/system/wstun.service /etc/systemd/system/
chmod +x /etc/systemd/system/wstun.service
systemctl daemon-reload
systemctl enable wstun.service
Expand All @@ -112,14 +114,14 @@ systemctl enable wstun.service
* ##### Import IoTronic-standalone database
You need to import the IoTronic database schema. During the installation of the MySQL package you should have been asked for a database root password. Please note that name of the database is set to "s4t-iotronic". If you want to change it, please consider that later on you will need to correctly change it in other configuration files.
```
mysql -u root -p < /usr/lib/node_modules/@mdslab/iotronic-standalone/utils/s4t-db.sql
mysql -u root -p < $NODE_PATH/@mdslab/iotronic-standalone/utils/s4t-db.sql
```


## Configure Crossbar.io router
Configure Crossbar with SSL:
```
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/crossbar/config.SSL.example.json /etc/crossbar/config.json
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/crossbar/config.SSL.example.json /etc/crossbar/config.json
vim /etc/crossbar/config.json
"key": "<PRIVATE-KEY.PEM>",
Expand All @@ -129,7 +131,7 @@ vim /etc/crossbar/config.json

or without SSL:
```
cp /usr/lib/node_modules/@mdslab/iotronic-standalone/etc/crossbar/config.example.json /etc/crossbar/config.json
cp $NODE_PATH/@mdslab/iotronic-standalone/etc/crossbar/config.example.json /etc/crossbar/config.json
```
at the end check the configuration:
```
Expand Down Expand Up @@ -190,10 +192,42 @@ if you would like to use HTTPS to expose them you have to specify the "https" se
}
```


- configure and enable Iotronic modules:
```
"modules": {
"plugins_manager": {
"enabled": true
},
etc
}
```

each Iotronic module (e.g. "plugins_manager") has a flag "enabled" to set at true or false in order to enable o disable that module.

In particular, the Service Manager module, has to be configured properly (if enabled):

```
"services_manager": {
"enabled": true,
"wstun":
{
"port_range":{
"high":40100,
"low": 40001
},
"public_ip":""
}
},
```
- in the "port_range" section you must specify the range (high and low) of the ports used by this module to expose the board services.
- the "public_ip" field is used to specify the public IP exposed by Iotronic that the user uses (with the port assigned by Iotronic) to reach the running service in his board.


Set authentication parameters:
- create SuperAdmin token ("adminToken" to set below in the settings.json):
```
node /usr/lib/node_modules/@mdslab/iotronic-standalone/utils/createAdminToken.js <PASSWORD>
node $NODE_PATH/@mdslab/iotronic-standalone/utils/createAdminToken.js <PASSWORD>
```
- open /var/lib/iotronic/settings.json:
```
Expand All @@ -202,6 +236,7 @@ node /usr/lib/node_modules/@mdslab/iotronic-standalone/utils/createAdminToken.js
"adminToken": "<GENERATED-BEFORE>",
"backend": "iotronic",
"expire_time": "30m"
"auth_lr_mode":"basic"
}
```
The "encryptKey" field is a user-defined keyword/password used to encrypt/decrypt the users passwords during authentication procedures.
Expand All @@ -212,6 +247,10 @@ The "expire_time" field is expressed in seconds (e.g.: 60) or as string describi
If you decide to express this field in seconds you MUST specify it as integer (e.g. 60 -> 1 minute)
NOT as a string (e.g. "60" -> 60 milliseconds).

Through "auth_lr_mode" field you can set the authentication mode used by Iotronic to authenticate the Lightning-rod istances. The mode supported are:
- "basic": Iotronic check only if the board ID provided by the board is registered in the database. If a second board try to connect through the same board ID, the login will be rejected.
- "password": Iotronic check the password provided by the board during the login procedure. The password is between 4 and 36 char long.
- "certs": Iotronic verify the signature provided by the board, through the public-key of the board that Iotronic saved in the registration phase into the database.

## Start IoTronic-standalone

Expand All @@ -232,6 +271,10 @@ systemctl status iotronic-standalone.service
You can check logs by typing:
```
tail -f /var/log/iotronic/s4t-iotronic.log
and
tail -f /var/log/wstun/wstun.log
```

##### Register Admin user and project
Expand Down Expand Up @@ -270,7 +313,7 @@ RESPONSE:


## API documentation management
IoTronic releases its APIs documentation by means of Swagger framework. In particular we used ["swagger-jsdoc"](https://www.npmjs.com/package/swagger-jsdoc) and ["swagger-ui"](https://swagger.io/swagger-ui/)
IoTronic releases its APIs documentation by means of Swagger framework. In particular we used ["swagger-jsdoc"](https://www.npmjs.com/package/swagger-jsdoc) and ["swagger-ui"](https://swagger.io/swagger-ui/)
respectively to describe each RESTful API in the source code and publish the produced documentation.

Iotronic is able to expose the documentation:
Expand Down Expand Up @@ -375,7 +418,7 @@ Script usage:
node iotronic-docs-gen.js --iotronic="<IOTRONIC_SOURCE_CODE_PATH>" -e [true|false] [ -p <API_DOCS_PORT> ] [ -w <SWAGGER-JSON-SAVE-PATH>]
```
options:
- -i, --iotronic IoTronic suorce code path. (e.g. "/usr/lib/node_modules/@mdslab/iotronic-standalone/")
- -i, --iotronic IoTronic suorce code path. (e.g. "$NODE_PATH/@mdslab/iotronic-standalone/")
- -e, --embedded true | false to spawn API webpage documentation; if "false" the "iotronic-swagger.json" will be created in the <SWAGGER-DIST-PATH> folder specified in the "settings.json" file in the "docs" section.
- -p, --port [only with --embedded=true] Listening port. (this port has to be different from the ports used by IoTronic "http(s)_port")
- -w, --web Web server path: where will be created the swagger json file "iotronic-swagger.json".
Expand Down
1 change: 1 addition & 0 deletions docs/iotronic-swagger.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 6c4a0a0

Please sign in to comment.