Skip to content

Commit a272a19

Browse files
authored
docs: restructure backend README
Improved README structure and clarity for the backend (FIM Engine). Focused on better architecture explanation, reduced redundancy, and clearer separation of system components. No functional changes.
1 parent 125f715 commit a272a19

1 file changed

Lines changed: 57 additions & 23 deletions

File tree

README.md

Lines changed: 57 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,20 @@
1-
# File-Integrity Scanner
2-
## Overview
3-
4-
The **File-Integrity Scanner** is a powerful tool designed to ensure the integrity of files by using cryptographic
5-
hash functions. This application provides peace of mind that files have not been tampered with, which is crucial
6-
for security and data verification purposes.
7-
8-
1+
# File-Integrity Scanner Backend (FIM Engine)
2+
This repository contains the backend service for the File Integrity Scanner system. It provides file integrity verification using cryptographic hash functions and detects unauthorized modifications and file corruption, ensuring reliable integrity checks for local systems.
93

104
## What is a File Integrity Scanner?
11-
12-
A file integrity scanner is a software utility that computes cryptographic hashes of files and monitors them for
13-
changes. This process helps in detecting unauthorized modifications or corruption of critical files on a local
14-
machine.
15-
5+
A file integrity scanner computes cryptographic hashes of files and monitors them for changes over time. It detects tampering, corruption, or unauthorized modifications to critical system and user files.
166

177
## Key Features
8+
Different hashing algorithms are supported to allow flexibility between performance and cryptographic strength depending on use case requirements.
189

19-
- **Hashing Algorithms:** Supports three different hashing algorithms:
10+
- **Hashing Algorithms:**
2011
- SHA-256
2112
- SHA-3 (256-bit)
22-
- BLAKE_2b (512-bit)
13+
- BLAKE2b (512-bit)
2314

2415
- **Database Storage:** Uses PostgreSQL to store file hashes along with the date of the scan and other relevant file metadata.
2516

26-
- **Local Operation:** The scanner runs exclusively on the user's local machine. No remote services are required
27-
or desired, ensuring full control over data integrity for the end-user.
17+
- **Local Operation:** The scanner runs exclusively on the user's local machine. No remote services are required, ensuring full local control over data and integrity verification.
2818

2919

3020
![File Integrity Scanner Image](https://github.com/pwssOrg/File-Integrity-Scanner/blob/master/.github/assets/images/640x486.jpg?raw=true)
@@ -33,17 +23,18 @@ or desired, ensuring full control over data integrity for the end-user.
3323

3424
🛡️ **Zero spyware. Zero tracking. Full respect for your privacy.**
3525

36-
## Basic Setup Instructions
26+
## Basic Setup Instructions (for developers)
3727

3828
### Requirements
3929

4030
- **PostgreSQL**
4131
- **SSL password**
4232

4333

44-
### Spring Version
34+
### Technology Stack
4535

46-
**Spring 4.0.6**
36+
- Spring Framework 4.0.6
37+
- PostgreSQL
4738

4839
### Steps
4940

@@ -58,11 +49,54 @@ or desired, ensuring full control over data integrity for the end-user.
5849

5950
## Contact Information
6051

61-
For any questions or support, please reach out to:
52+
For questions, support, or contributions:
53+
54+
- **Peter**[@pwgit-create](https://github.com/pwgit-create)
55+
- **Stefan**[@lilstiffy](https://github.com/lilstiffy)
6256

63-
@pwgit-create Peter pwgit-create
64-
@lilstiffy Stefan lilstiffy
6557
### Discussion Forum
6658

6759
Please visit our discussion forum for project-related documentation and discussions: [Project Discussion
6860
Forum](https://github.com/orgs/pwssOrg/discussions/categories/file-integrity-scanner)
61+
62+
---
63+
64+
## Related Repositories
65+
66+
### [PWSS Release Repository](https://github.com/pwssOrg/PWSS-Release-File-Integrity-Scanner)
67+
68+
User-focused distribution of the Integrity Hash platform for Windows and Linux systems.
69+
70+
Designed for non-developers and system administrators who want a simplified installation and local file integrity monitoring experience without manually configuring backend services.
71+
<p align="center">
72+
<a href="https://youtu.be/DcZYuQVOpCQ">
73+
<img src="https://img.youtube.com/vi/DcZYuQVOpCQ/maxresdefault.jpg" alt="Titta på videon" width="100%" max-width="600px">
74+
</a>
75+
</p>
76+
Features:
77+
78+
* Easy setup
79+
* Local-only operation
80+
* PostgreSQL integration
81+
* Multi-algorithm hashing support
82+
* Privacy-focused design
83+
---
84+
85+
## System Architecture
86+
87+
The system is split into backend services, a GUI client, shared PWSS libraries, and an end-user distribution package. This modular architecture enables independent development of core security logic, user interface components, and deployment tooling for both technical and non-technical users. Each component can be developed and deployed independently while maintaining a shared security and hashing standard through the PWSS libraries.
88+
89+
### Components
90+
91+
- **Core Backend (FIM Engine)** – Handles hashing, integrity verification, and monitoring logic
92+
- **GUI Application** – User interface for managing scans and viewing results
93+
- **PWSS Libraries** – Shared components used across all PWSS projects
94+
- **PWSS Release Repository** – End-user distribution for Windows and Linux
95+
96+
### Architecture diagram
97+
This repository represents the backend layer of the File Integrity Scanner system and implements the core FIM engine.
98+
```
99+
GUI → Local Backend → PostgreSQL
100+
101+
PWSS Libraries (dependency)
102+
```

0 commit comments

Comments
 (0)