How to Start a FidesInnova IoT Node

o install the back-end and front-end components of the FidesInnova platform, including both the web app and mobile app, you can follow the steps below. These instructions assume that you have a basic understanding of setting up development environments and are familiar with JavaScript, Node.js, and related technologies.

How to Install BackEnd

1- Prepare operating system

First of all install Ubuntu 20.04 LTS on your server.

2- Install MongoDB

Step 1 — Installing MongoDB

Install MongoDB version 4.4

curl -fsSL https://www.mongodb.org/static/pgp/server-4.4.asc | sudo apt-key add -
apt-key list
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
sudo apt update
sudo apt install -y mongodb-org

Step 2 — Starting the MongoDB Service and Testing the Database

sudo systemctl start mongod.service
sudo systemctl status mongod
sudo systemctl enable mongod

Note: For managing the MongoDB Service you can use the following commands:

sudo systemctl status mongod
sudo systemctl stop mongod
sudo systemctl start mongod
sudo systemctl restart mongod
sudo systemctl disable mongod
sudo systemctl enable mongod

3- Install nginx web server

sudo apt update
sudo apt -y install nginx
systemctl status nginx

How to take SSL by certbot

sudo apt-get update
sudo apt-get install certbot
sudo certbot certonly --standalone --preferred-challenges http

After creating certificates you have to copy fullchain.pem, privkey.pem files into /etc/nginx/ssl

Update the `nginx.conf` file in `/etc/nginx/nginx.conf`

user www-data;
worker_processes auto;
pid /run/nginx.pid;
include /etc/nginx/modules-enabled/*.conf;

events {
	worker_connections 768;
	# multi_accept on;
}

http {
	##
	# Basic Settings
	##

	sendfile on;
	tcp_nopush on;
	tcp_nodelay on;
	keepalive_timeout 65;
	types_hash_max_size 2048;
	# server_tokens off;

	# server_names_hash_bucket_size 64;
	# server_name_in_redirect off;

	
	default_type application/octet-stream;
	include /etc/nginx/mime.types;
	##
	# SSL Settings
	##

	ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; # Dropping SSLv3, ref: POODLE
	ssl_prefer_server_ciphers on;

	ssl_certificate  ssl/fullchain.pem;
	ssl_certificate_key ssl/privkey.pem;

	##
	# Logging Settings
	##

	access_log /var/log/nginx/access.log;
	error_log /var/log/nginx/error.log;

	##
	# Gzip Settings
	##

	gzip on;

	server {
		listen 443 ssl;
		listen [::]:443 ssl;

		index index.html index.htm;
		server_name panel.YOUR_DOMAIN.io;

		root /var/www/html/wikifidesdoc/site;

		add_header 'Access-Control-Allow-Credentials' 'true';
		add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
		add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';

		# This section is for user Web App on port 4000
		location / {
			proxy_set_header Authorization $http_authorization;
			proxy_pass_header Authorization;
			add_header Access-Control-Allow-Origin '*';
			add_header Access-Control-Allow-Headers '*';
			proxy_pass https://localhost:4000;
		}

		# This section is for Server Backend on port 3000
		location /app {
			proxy_pass http://localhost:3000;
			add_header Access-Control-Allow-Origin *;
		}
	}


	server {


                ssl_certificate  ssl/fullchainadmin.pem;
                ssl_certificate_key ssl/privkeyadmin.pem;

		listen 443 ssl;
		listen [::]:443 ssl;
		server_name admin.YOUR_DOMAIN.io;

		index index.html index.htm;

		add_header 'Access-Control-Allow-Credentials' 'true';
		add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
		add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';

		# This section is for Admin Web App on port 5000
		location / {
			proxy_set_header Authorization $http_authorization;
			proxy_pass_header Authorization;
			add_header Access-Control-Allow-Origin '*';
			add_header Access-Control-Allow-Headers '*';
			proxy_pass https://localhost:5000;
		}
	}
}

Make sure to edit server_name to subdomain.yourdomain.com
Make sure to create the certificate for domain and all subdomains

Restart Nginx

systemctl restart nginx

4- Installation of Node.js (Version 20.9.0) and NestJS on Ubuntu

sudo apt update
sudo apt install nodejs
sudo apt install npm
sudo npm install -g n
n 20.9.0
npm i -g @nestjs/cli

5- Configure Firewall

Allow connections

Install ufw

apt install ufw

Allow OpenSSH connection

sudo ufw allow OpenSSH

Allow nginx connection

sudo ufw allow 'nginx full'

Allow Mobile App to connect to the server through port 3000

sudo ufw allow 3000

Allow Web App to connect to the server through port 4000

sudo ufw allow 4000

Allow Admin Web App to connect to the server through port 4000

sudo ufw allow 5000

Allow IoT devices to connect to the MQTT broker through port 8883

sudo ufw allow 8883

Enable firewall

sudo ufw enable

Check the firewall status

sudo ufw status

6- Clone the project

Install git

apt install git

In the root directory clone the project

cd /home
git clone https://github.com/FidesInnova/iot_node_backend_web_app.git

7- Prepare app host configuration

In project root folder, create .env file and edit parameters based on your node URL info

cd ~/iot_node_backend_web_app/backend
sudo nano .env

Inside the .env file, past the parameters.

NODE_ID = "your.node.url" # Set this with your node URL.
PORT = 5000
NODE_NAME = "your.node.name"
SWAGGER_LOCAL_SERVER = http://localhost:5000

# Smart contract user & pass
REMIX_USER = 'rmadmin'
REMIX_PASS = 'rm123'

# Zkp user & pass
ZKP_USER = 'zkpadmin'
ZKP_PASS = 'zkp123'

# Faucet Wallet Private Key
FAUCET_WALLET_PRIVATE_KEY = 'YOUR_FAUCET_WALLET_PRIVATE_KEY'

# Admin Wallet Private Key
ADMIN_WALLET_PRIVATE_KEY = 'YOUR_ADMIN_WALLET_PRIVATE_KEY'

# Server Configuration
HOST_PROTOCOL = 'https://'
HOST_NAME_OR_IP = 'panel.YOUR_DOMAIN.COM'
HOST_PORT = '3000'
HOST_SUB_DIRECTORY = 'app'

# StorX Config
STORX_BUCKET_NAME = 'fidesinnova'
STORX_HOST = 'https://b2.storx.io'
STORX_AUTH_HOST = 'https://auth.storx.io'

# Mongo Database Configuration
MONGO_DATABASE_NAME = fidesinnova
MONGO_USER = Administrator
# MONGO_PASSWORD = 'PASSWORD'
MONGO_PORT = 27017
MONGO_HOST = mongodb://127.0.0.1
MONGO_CONNECTION = mongodb://127.0.0.1:27017/fidesinnova

# Email Configuration
NOTIFICATION_BY_MAIL = 'enabled'
NOTIFICATION_BY_NOTIFICATION = 'enabled'

# Mail server
MAIL_HOST = YOUR_HOST_MAIL_SERVER_PROVIDER
MAIL_PORT = 465
MAIL_USER = noreply@YOUR_DOMAIN.COM
MAIL_PASSWORD = YOUR_MAIL_SERVER_PASSWORD
MAIL_FROM = noreply@YOUR_DOMAIN.COM
# optional
MAIL_TRANSPORT = smtp://${MAIL_USER}:${MAIL_PASSWORD}@${MAIL_HOST}

# Mobile theme ( hex color code without # )
THEME_LOGO = "www.example.com/image.png"
THEME_TEXT = "ffffff"
THEME_BACKGROUND = "212838"
THEME_BOX = "2d355c"
THEME_BUTTON = "4e46e7"

ACCESS_TOKEN_ISSUER = 'https://fidesinnova.io'
ACCESS_TOKEN_EXPIRATION_TIME = 1200000000     # Miliseconds
ACCESS_TOKEN_SECRET_KEY = '?#6KRVytq*zn5zhWWLHksL$MJj7Krkan^&^^BzZD?fqUjs4mhWNExZZ8S7CPXXkPGYMEzj2y$bK7@TWwYaja=7j^+ccFqG8#EpM4&4ppmST?A7?F_a3bq=m6B&CwRrb3'
# ACCESS_TOKEN_ALGORITHM = 'PS384'
ACCESS_TOKEN_ALGORITHM = 'HS384'

REFRESH_TOKEN_ISSUER = 'https://fidesinnova.io'
REFRESH_TOKEN_EXPIRATION_TIME = 2400000000    # Miliseconds
REFRESH_TOKEN_SECRET_KEY = 'Cn3ZU$EQcpc_C9Yyqc*t3pur#Rg_Q9xUt4GUVnf8=Q4ruE?f@8^ngFgKpE7Nh=gytxzY3!tcpBZ4STj-ehCfb2k-&C43sFgYfSfZ&ALP!XJhe3R%hNGTMmHXCMsm9Bfv'
REFRESH_TOKEN_ALGORITHM = 'HS384'

SUPER_ADMIN_EMAILS = ["admin.email.@example.com"] # your admins emails that can make other users into admin

# Multer Configuration     # Multer is a node.js middleware for handling multipart/form-data, which is primarily used for uploading files.
MULTER_MEDIA_PATH = ./storages/resources
MULTER_MEDIA_SIZE = 10000000    # 10 MB

Update these parameters:

NODE_NAME = "your.node.name"
NODE_ID = "your.node.url" # Set this to your node URL

FAUCET_WALLET_PRIVATE_KEY = "your-faucet-wallet-private-key"
ADMIN_WALLET_PRIVATE_KEY = 'your-admin-wallet-private-key'

HOST_NAME_OR_IP = 'panel.YOUR_DOMAIN.COM'

MAIL_HOST = YOUR_HOST_MAIL_SERVER_PROVIDER
MAIL_PORT = 465
MAIL_USER = noreply@YOUR_DOMAIN.COM
MAIL_PASSWORD = YOUR_MAIL_SERVER_PASSWORD
MAIL_FROM = noreply@YOUR_DOMAIN.COM

THEME_LOGO = 'your.logo.url'

From /etc/nginx/ssl, copy the files fullchain.pem, privkey.pem and rename them:
- fullchain.pem into webpublic.pem
- privkey.pem into webprivate.pem

put ssl certificate files in following directory:

iot_node_backend_web_app/backend/assets/certificates/webprivate.pem
iot_node_backend_web_app/backend/assets/certificates/webpublic.pem

8- Device Installation Data

During the installation process in the mobile app, the following devices will be displayed based on the data provided in the fidesinnova_node_iot/backend/src/data/devices.json file. Each device is represented by an image and a title:

[
  { 
    "fileName": "ecard.png", 
    "title": "E-Card", 
    "type": "E-CARD" 
  },
  {
    "fileName": "multisensor.png",
    "title": "Multi Sensor",
    "type": "MULTI_SENSOR"
  },
  {
    "fileName": "motionsensor.png",
    "title": "Motion Sensor",
    "type": "MOTION_SENSOR"
  }
]

fileName: Refers to the image file that should be placed in the /fidesinnova_node_iot/backend/uploads/device directory. This image will be displayed in the mobile app.
title: The name of the device as it will appear in the mobile app's device installation list.
type: The device type, which is used by the node supervisor to categorize the devices.

9- Installation of packages

In the project root directory run the following commands to install npm packages and then, build the project:

cd ~/iot_node_backend_web_app/backend
npm install
npm run build

10- Run the project with pm2

install pm2

sudo npm i -g pm2

Run the project with pm2

cd ~/iot_node_backend_web_app/backend
pm2 start dist/main.js --name "Backend Server"
pm2 save
pm2 startup

11- Running the project in developer mode

development

npm run start

watch mode (For developers)

npm run start:dev

production mode (For developers)

npm run start:prod

For first run of the app or after pull the project from GitHub or any change in project's code, before run following command you must run the app with npm run start once.

unit tests

npm run test

e2e tests

npm run test:e2e

test coverage

npm run test:cov

How to Install WebApp

Note:

The program's source is situated in the folder "Source_webapp". After building it from the source, you can place it in the "Runner_webapp/frontend". The runner section has already been executed on the server following the provided instructions.
If you are a Node owner, contact FidesInnova team at info@fidesinnova.io to add your Web App URL address to FidesInnova website.

1- Installation of packages

cd ~/iot_node_backend_web_app/web_app/Source_webapp
npm install

2- Prepare app configuration

In project root folder, create .env file and edit parameters based on your node URL info

cd ~/iot_node_backend_web_app/web_app/Source_webapp
sudo nano .env

Inside the .env file, past the parameters.

Make sure to add /app/ to the end of the VITE_URL path!
Enter your node name in VITE_NODE_NAME for showing in website

VITE_URL='https://panel.YOUR_DOMAIN.COM/app/'
VITE_NODE_NAME = 'your.node.name'

To obtain a new certificate for the admin

domain:

sudo certbot certonly --standalone --preferred-challenges http

From /etc/letsencrypt/live/admin.<Your Domain>, copy the files fullchain.pem, privkey.pem and rename them:
fullchain.pem into webpublic.pem
privkey.pem into webprivate.pem
fullchain.pem into fullchainadmin.pem
privkey.pem into privkeyadmin.pem

Put SSL certificate files in the following path:

iot_node_backend_web_app/web_app/Runner_webapp/assets/certificates/webpublic.pem
iot_node_backend_web_app/web_app/Runner_webapp/assets/certificates/webprivate.pem

etc/nginx/ssl/fullchainadmin.pem
etc/nginx/ssl/privkeyadmin.pem

3- Build

cd ~/iot_node_backend_web_app/web_app/Source_webapp
npm run build

**The build artifacts will be stored in the iot_node_backend_web_app/web_app/Source_webapp/build/ directory, you must copy the contents of the build folder into the iot_node_backend_web_app/web_app/Runner_webapp/frontend. **

4- Configure Firewall

Allow Web App to connect to the server through port 4000

sudo ufw allow 4000

5- Install npm packages for Runner

cd ~/iot_node_backend_web_app/web_app/Runner_webapp
npm i

In project root folder, create .env file and edit parameters based on your node URL info

cd ~/iot_node_backend_web_app/web_app/Runner_webapp
sudo nano .env

Inside the .env file, past the parameters.

PORT=4000

6- Run the project with pm2

cd ~/iot_node_backend_web_app/web_app/Runner_webapp
pm2 start main.js --name "Web App"

7- Running the project in developer mode

Build the project

tsc

Run the program

node main.js

production mode (For developers)

npm run start:prod

How to Install Admin WebApp

Note:

The program's source is situated in the folder "Source_webapp". After building it from the source, you can place it in the "Runner_webapp/frontend". The runner section has already been executed on the server following the provided instructions.
If you are a Node owner, contact FidesInnova team at info@fidesinnova.io to add your Admin Web App URL address to FidesInnova website.

1- Installation of packages

cd ~/iot_node_backend_web_app/admin_web_app/Source_webapp
npm install

2- Prepare app configuration

In project root folder, create .env file and edit parameters based on your node URL info

cd ~/iot_node_backend_web_app/admin_web_app/Source_webapp
sudo nano .env

Inside the .env file, past the parameters.

Make sure to add /app/ to the end of the VITE_URL path!
Enter your node name in VITE_NODE_NAME for showing in website

VITE_URL='https://panel.YOUR_DOMAIN.COM/app/'
VITE_NODE_NAME = 'your.node.name'

From /etc/nginx/ssl, copy the files fullchain.pem, privkey.pem and rename them:
fullchain.pem into webpublic.pem
privkey.pem into webprivate.pem

Put SSL certificate files in the following path:

iot_node_backend_web_app/admin_web_app/Runner_webapp/assets/certificates/webpublic.pem
iot_node_backend_web_app/admin_web_app/Runner_webapp/assets/certificates/webprivate.pem

3- Build

cd ~/iot_node_backend_web_app/admin_web_app/Source_webapp
npm run build

**The build artifacts will be stored in the iot_node_backend_web_app/admin_web_app/Source_webapp/build/ directory, you must copy the contents of the build folder into the iot_node_backend_web_app/admin_web_app/Runner_webapp/frontend. **

4- Configure Firewall

Allow Admin Web App to connect to the server through port 5000

sudo ufw allow 5000

5- Install npm packages for Runner

cd ~/iot_node_backend_web_app/admin_web_app/Runner_webapp
npm i

In project root folder, create .env file and edit parameters based on node URL info

cd ~/iot_node_backend_web_app/admin_web_app/Runner_webapp
sudo nano .env

Inside the .env file, past the parameters.

PORT=5000

6- Run the project with pm2

cd ~/iot_node_backend_web_app/admin_web_app/Runner_webapp
pm2 start main.js --name "Admin Web App"

7- Running the project in developer mode

Build the project

tsc

Run the program

node main.js

production mode (For developers)

npm run start:prod

PreviousAdministrators: Starting a FidesInnova IoT Node NextHow to Start a New Blockchain Node

Last updated 3 months ago

How to Install BackEnd

1- Prepare operating system

2- Install MongoDB

Step 1 — Installing MongoDB

Step 2 — Starting the MongoDB Service and Testing the Database

Note: For managing the MongoDB Service you can use the following commands:

3- Install nginx web server

How to take SSL by certbot

Update the nginx.conf file in /etc/nginx/nginx.conf

Restart Nginx

4- Installation of Node.js (Version 20.9.0) and NestJS on Ubuntu

5- Configure Firewall

Allow connections

Enable firewall

Check the firewall status

6- Clone the project

7- Prepare app host configuration

put ssl certificate files in following directory:

8- Device Installation Data

9- Installation of packages

10- Run the project with pm2

install pm2

Run the project with pm2

11- Running the project in developer mode

development

watch mode (For developers)

production mode (For developers)

unit tests

e2e tests

test coverage

How to Install WebApp

Note:

1- Installation of packages

2- Prepare app configuration

To obtain a new certificate for the admin

domain:

Put SSL certificate files in the following path:

3- Build

4- Configure Firewall

5- Install npm packages for Runner

6- Run the project with pm2

7- Running the project in developer mode

Build the project

Run the program

production mode (For developers)

How to Install Admin WebApp

Note:

1- Installation of packages

2- Prepare app configuration

Put SSL certificate files in the following path:

3- Build

4- Configure Firewall

5- Install npm packages for Runner

6- Run the project with pm2

7- Running the project in developer mode

Build the project

Run the program

production mode (For developers)

Update the `nginx.conf` file in `/etc/nginx/nginx.conf`