README: update

This commit is contained in:
Domingo Dirutigliano
2025-03-09 23:51:14 +01:00
parent 73c40d2f5d
commit 25d71c4b94
2 changed files with 7 additions and 4 deletions

View File

@@ -5,8 +5,8 @@
The backend of firegex is written with fastapi. The aim of the backend is to manage all the requests from the react front-end and manage also the proxy processes of the entire firewall. The fastapi webserver is responsable of deploying the react app.
![Firegex Working Scheme](../docs/FiregexInternals.png)
Schematic example about how firegex manage the TCP proxy filter
Schematic example about how firegex manage the filters
### Read the documentation of the API going at `/docs` path and see the automatic documentation generated by FastAPI
### Read the documentation of the API going at `/api/docs` path and see the swagger documentation of the API.
## [GO BACK](../README.md)