Skip to content

Commit c8556ff

Browse files
Update README.md
1 parent 613b0f2 commit c8556ff

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -496,10 +496,10 @@ To enable mobile notifications on your Node server, follow these steps:
496496

497497
3. **Paste JSON Content**
498498
Open the file with `nano`, then paste the full content of the `firebase-adminsdk.json` file you received.
499-
499+
---
500500
## B.3. Web App Logo
501501
- 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.
502-
502+
---
503503
## B.4. Device Configuration File
504504
- 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:
505505
- **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").
@@ -593,7 +593,7 @@ sudo nano devices.json
593593
}
594594
]
595595
```
596-
596+
---
597597
## B.5. Install Panel Web App for users
598598
- In `Source_webapp` folder, create `.env` file.
599599
```
@@ -606,7 +606,7 @@ VITE_URL='https://PANEL_URL/app/'
606606
VITE_NODE_NAME='YOUR_NODE_NAME'
607607
VITE_RPC_URL='https://rpc1.fidesinnova.io'
608608
```
609-
609+
---
610610
## B.6. Install Admin Web App for administrator
611611
- In `Source_webapp` folder, create `.env` file.
612612
```
@@ -619,7 +619,7 @@ VITE_URL='https://PANEL_URL/app/'
619619
VITE_NODE_NAME='YOUR_NODE_NAME'
620620
VITE_RPC_URL='https://rpc1.fidesinnova.io'
621621
```
622-
622+
---
623623
# C. Restore Node from Backup
624624
- Create the 'backups' folder.
625625
```
@@ -635,17 +635,19 @@ VITE_RPC_URL='https://rpc1.fidesinnova.io'
635635
```
636636

637637
# D. Build and Execute
638+
---
638639
## D.1. Build the System
639640
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.
640641
```
641642
cd /home/Blockchain-based-IoT-Server/
642643
sudo chmod +x initial_setup.sh
643644
sudo ./initial_setup.sh
644645
```
646+
---
645647
## D.2. Account Setup
646648
- Goto `https://PANEL_URL` and go to the 'Sign up' section and create a password for your `super admin email address`.
647649
- Goto `https://ADMIN_URL` and login with your `super admin email address` and its password.
648-
650+
---
649651
## D.3. Congratulations
650652
- Panel Web App, `https://PANEL_URL` is for your regular users.
651653
- Admin Web App, `https://ADMIN_URL` is for your super admin users.
@@ -657,6 +659,7 @@ To automate the setup and build processes for both the backend and frontend appl
657659
- [https://panel.trustsense.tech](https://panel.trustsense.tech/)
658660

659661
# E. Maintenance
662+
---
660663
## E.1. Update IoT Server
661664
- Every time the Fides Innova core development team pushes a new version of the code on GitHub.
662665
- **Note:** Make sure to check the name of the repository, and if needed, update the folder name using the following command:
@@ -676,13 +679,15 @@ cd /home/Blockchain-based-IoT-Server/
676679
sudo chmod +x update.sh
677680
sudo ./update.sh
678681
```
682+
---
679683
## E.2. Backup IoT Server
680684
- 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.
681685
```
682686
cd /home/Blockchain-based-IoT-Server/
683687
sudo chmod +x backup.sh
684688
sudo ./backup.sh
685689
```
690+
---
686691
## E.3. Troubleshooting
687692
- Useful commands for troubleshooting
688693
```
@@ -740,6 +745,7 @@ sudo systemctl disable fides.backend.service
740745
# List all active systemd services:
741746
systemctl list-units --type=service
742747
```
748+
---
743749
## E.4. Web App Ports
744750
- Change the Panel Web App Port
745751
In `Runner_webapp` folder, create `.env` file.
@@ -764,7 +770,7 @@ PORT=5000
764770
```
765771
Note: If you change these two ports, please make sure you consult with the Fides Innova repository manager to avoid any future git push conflicts.
766772

767-
--------
773+
---
768774

769775
# 🔐 Automated Web App Security Scan with OWASP ZAP (Docker)
770776

0 commit comments

Comments
 (0)