Skip to content

Commit 3c8514f

Browse files
authored
Update README.md
1 parent 4da55b8 commit 3c8514f

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
To 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.
1616

1717
# Step A. Prepare operating system
18-
To run `iot-server` effectively, the following system specifications are recommended:
18+
To run `Blockchain-based-IoT-Server` effectively, the following system specifications are recommended:
1919

2020
- **Operating System:** Ubuntu 24.04 LTS
2121
- **Memory:** 16 GB RAM
@@ -305,7 +305,7 @@ sudo apt install git
305305
- Clone the project
306306
```
307307
cd /home
308-
sudo git clone https://github.com/FidesInnova/iot-server.git
308+
sudo git clone https://github.com/FidesInnova/Blockchain-based-IoT-Server.git
309309
```
310310

311311
### Continue with Step B if you want to install a new node, or jump to Step C if you want to restore your node from a previous backup.
@@ -325,7 +325,7 @@ openssl rand -hex 32
325325
## B.2. Backend configurations
326326
- In project root folder, create `.env` file and edit parameters based on your node URL info
327327
```
328-
cd /home/iot-server/backend
328+
cd /home/Blockchain-based-IoT-Server/backend
329329
sudo nano .env
330330
```
331331

@@ -484,19 +484,19 @@ To enable mobile notifications on your Node server, follow these steps:
484484
Move the file to the backend directory:
485485

486486
```bash
487-
sudo mkdir /home/iot-server/backend/src/data/
488-
sudo nano /home/iot-server/backend/src/data/firebase-adminsdk.json
487+
sudo mkdir /home/Blockchain-based-IoT-Server/backend/src/data/
488+
sudo nano /home/Blockchain-based-IoT-Server/backend/src/data/firebase-adminsdk.json
489489
```
490490

491491
3. **Paste JSON Content**
492492
Open the file with `nano`, then paste the full content of the `firebase-adminsdk.json` file you received.
493493

494494
## B.3. Web App Logo
495-
- Copy your logo in `.png` format with the `logo` name as `logo.png` in `\home\iot-server\backend\uploads` folder on your server.
495+
- Copy your logo in `.png` format with the `logo` name as `logo.png` in `\home\Blockchain-based-IoT-Server\backend\uploads` folder on your server.
496496

497497
## B.4. Device Configuration File
498498
- Fidesinnova offers a mobile app to control IoT devices that support the MQTT protocol. The device configuration files, which specify the IoT device types, are stored on the IoT server. In this section, we will review how to create a device configuration file on the server. Each device in the configuration file is represented by an image, a title, a type, and its parameters:
499-
- **fileName**: Refers to the image file that should be placed in the `/iot-server/backend/uploads/device` directory. This image will be displayed in the mobile app (e.g., "ecard.png").
499+
- **fileName**: Refers to the image file that should be placed in the `/Blockchain-based-IoT-Server/backend/uploads/device` directory. This image will be displayed in the mobile app (e.g., "ecard.png").
500500
- **title**: The display name for the device (e.g., "E-Card").
501501
- **type**: Device type identifier (e.g., "E-CARD").
502502
- **Device Parameters**: Parameters specify data points each device supports. These parameters will be passed to the web app Blockly editor for creating new services.
@@ -506,13 +506,13 @@ To enable mobile notifications on your Node server, follow these steps:
506506
### B.4.1. Edit the `devices.json` file
507507
- Create `devices.json` file in the `backend/src/data/` in the project folder
508508
```
509-
cd /home/iot-server/backend/src
509+
cd /home/Blockchain-based-IoT-Server/backend/src
510510
sudo mkdir data
511511
cd data
512512
sudo nano devices.json
513513
```
514514

515-
- Copy the following config in your `devices.json` file if you would like to use zkSensor's devices. Please note that you can edit this file and add your own IoT devices. When you add your new IoT device make sure you upload a `.png` file in `/home/iot-server/backend/uploads/devices`. We hae already copied three `zksensor-ecard.png`, `zksensor-minisensor.png`, and `zksensor-zk-multisensor.png` files in this folder for the following devices.
515+
- Copy the following config in your `devices.json` file if you would like to use zkSensor's devices. Please note that you can edit this file and add your own IoT devices. When you add your new IoT device make sure you upload a `.png` file in `/home/Blockchain-based-IoT-Server/backend/uploads/devices`. We hae already copied three `zksensor-ecard.png`, `zksensor-minisensor.png`, and `zksensor-zk-multisensor.png` files in this folder for the following devices.
516516
```json
517517
[
518518
{
@@ -591,7 +591,7 @@ sudo nano devices.json
591591
## B.5. Install Panel Web App for users
592592
- In `Source_webapp` folder, create `.env` file.
593593
```
594-
cd /home/iot-server/web_app/Source_webapp
594+
cd /home/Blockchain-based-IoT-Server/web_app/Source_webapp
595595
sudo nano .env
596596
```
597597
Enter the following lines in the .env file and replace `YOUR_NODE_NAME` with your actual node name.
@@ -604,7 +604,7 @@ VITE_RPC_URL='https://rpc1.fidesinnova.io'
604604
## B.6. Install Admin Web App for administrator
605605
- In `Source_webapp` folder, create `.env` file.
606606
```
607-
cd /home/iot-server/admin_web_app/Source_webapp
607+
cd /home/Blockchain-based-IoT-Server/admin_web_app/Source_webapp
608608
sudo nano .env
609609
```
610610
Enter the following lines in the .env file and replace `YOUR_NODE_NAME` with your actual node name.
@@ -617,13 +617,13 @@ VITE_RPC_URL='https://rpc1.fidesinnova.io'
617617
# C. Restore Node from Backup
618618
- Create the 'backups' folder.
619619
```
620-
cd /home/iot-server/
620+
cd /home/Blockchain-based-IoT-Server/
621621
sudo mkdir backups
622622
```
623623
- Copy your backup file (e.g. iot_server_backup_2025-02-12.tar.gz ) to this folder.
624624
- Execute the restore script file
625625
```
626-
cd /home/iot-server/
626+
cd /home/Blockchain-based-IoT-Server/
627627
sudo chmod +x restore.sh
628628
sudo ./restore.sh
629629
```
@@ -632,7 +632,7 @@ VITE_RPC_URL='https://rpc1.fidesinnova.io'
632632
## D.1. Build the System
633633
To automate the setup and build processes for both the backend and frontend applications, run the `initial_setup.sh` script located in the root directory of the project. This script will handle building both the backend and frontend applications and configuring systemctl services automatically.
634634
```
635-
cd /home/iot-server/
635+
cd /home/Blockchain-based-IoT-Server/
636636
sudo chmod +x initial_setup.sh
637637
sudo ./initial_setup.sh
638638
```
@@ -654,21 +654,21 @@ To automate the setup and build processes for both the backend and frontend appl
654654
## E.1. Update IoT Server
655655
- Every time Fidesinnova core development team push a new version of the code on GitHub.
656656
```
657-
cd /home/iot-server/
657+
cd /home/Blockchain-based-IoT-Server/
658658
sudo git fetch
659659
sudo git pull
660660
```
661661

662662
- Every time you pull a new version of the server code from GitHub or you make a change to any `.env` files in the system, you should apply the changes to your production server via update script.
663663
```
664-
cd /home/iot-server/
664+
cd /home/Blockchain-based-IoT-Server/
665665
sudo chmod +x update.sh
666666
sudo ./update.sh
667667
```
668668
## E.2. Backup IoT Server
669669
- Every time you want to get a backup from your server, you should execute the following script and get your backup file in the 'backups' folder.
670670
```
671-
cd /home/iot-server/
671+
cd /home/Blockchain-based-IoT-Server/
672672
sudo chmod +x backup.sh
673673
sudo ./backup.sh
674674
```
@@ -733,7 +733,7 @@ systemctl list-units --type=service
733733
- Change the Panel Web App Port
734734
In `Runner_webapp` folder, create `.env` file.
735735
```
736-
cd /home/iot-server/web_app/Runner_webapp
736+
cd /home/Blockchain-based-IoT-Server/web_app/Runner_webapp
737737
sudo nano .env
738738
```
739739
Change the port number in the following line.
@@ -744,7 +744,7 @@ PORT=4000
744744
- Change the Admin Web App Port
745745
- In `Runner_webapp` folder, create `.env` file.
746746
```
747-
cd /home/iot-server/admin_web_app/Runner_webapp
747+
cd /home/Blockchain-based-IoT-Server/admin_web_app/Runner_webapp
748748
sudo nano .env
749749
```
750750
Change the port number in the following line.

0 commit comments

Comments
 (0)