a README has been added

This commit is contained in:
Владислав Царёв 2024-12-19 15:40:00 +03:00
parent d45c913be2
commit 247b3591be

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# vuln-aggregator
`vuln-aggregator` is a service that helps identify which container images have vulnerabilities that can be fixed simply by reassembling the image. No other actions are required.
## Installation
1. Download the release tar file.
2. In the directory where the `.tar` file is located, run the following command to load the image:
```bash
podman load -i vuln-aggregator.tar
```
3. After loading the image, run the container using the following command:
```bash
podman run -p 3000:3000 vuln-aggregator:v0.2.0
```
If you need debug information, you can run it with the debug log enabled:
```bash
podman run -e RUST_LOG=debug -p 3000:3000 vuln-aggregator:v0.2.0
```
Now, your service should be up and running on port 3000. You can send a request along the route `images_that_vulnerabilities_are_eliminated_by_reassembly`