| 1 |
a290ec5e
|
Matěj Zeman
|
# Automatic detection and documentation of connected USB devices - Server - Bug Thugs
|
| 2 |
|
|
|
| 3 |
|
|
---
|
| 4 |
|
|
|
| 5 |
|
|
- [Description](#description)
|
| 6 |
|
|
- [Build](#build)
|
| 7 |
|
|
- [Execution](#execution)
|
| 8 |
|
|
|
| 9 |
|
|
---
|
| 10 |
|
|
|
| 11 |
|
|
## Description
|
| 12 |
|
|
|
| 13 |
|
|
This server application provides data via endpoints defined in **sql_app.api** package. Files in this package are divided by their respetive funcionality. File **usb_logs_web.py** provides endpoints and methods for main web view **/api/v1/logs-web**, file **usb_logs.py** provides endpoints and methods for client applications.
|
| 14 |
|
|
|
| 15 |
|
|
**sql_app** package contains files for database communication. **models.py** and **schemas.py** provides classes for mapping objects to database table entries, **database.py** defines database communication session and **crud.py** contains methods with database queries for reading, updating and saving data from client applications and web interfaces.
|
| 16 |
|
|
|
| 17 |
|
|
|
| 18 |
|
|
## Build
|
| 19 |
|
|
|
| 20 |
|
|
Server application comes with dockerFile and docker compose file so build is quite simple. In the server folder run command
|
| 21 |
|
|
|
| 22 |
|
|
```bash
|
| 23 |
|
|
docker-compose up
|
| 24 |
|
|
```
|
| 25 |
|
|
|
| 26 |
|
|
And docker will create image for server application and postgresql database. Database files are stored in own folder, so saved data will be persistent even if docker daemon would unexpectedly shut down.
|
| 27 |
|
|
|
| 28 |
|
|
## Web Views
|
| 29 |
|
|
|
| 30 |
|
|
Data from database are easily accesibly from web browser. Main web views url is
|
| 31 |
|
|
|
| 32 |
|
|
```bash
|
| 33 |
709c735b
|
Matěj Zeman
|
http://localhost:8000/
|
| 34 |
a290ec5e
|
Matěj Zeman
|
```
|
| 35 |
|
|
|
| 36 |
|
|
On this page there is select box at the top of the page for accessing different views on other data in database as well as creating new ones
|