Skip to content

Commit e63886f

Browse files
docs: add readme
1 parent 353a88d commit e63886f

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# clamproxy
2+
3+
Clamproxy is a lighweight API on top of ClamAV that allows you to scan files for viruses via HTTP requests.
4+
5+
It was designed to be used as a microservice in containerized environments, making it easy to integrate virus scanning into your applications without the need to directly interact with ClamAV.
6+
7+
## Features
8+
9+
- Simple HTTP API for scanning files
10+
- It requires the files to be present on the local filesystem. In containerized environments, this can be achieved using shared volumes.
11+
- Returns JSON responses with scan results
12+
13+
## Building
14+
15+
To build the Clamproxy Docker image, use the following command:
16+
17+
```bash
18+
bazel build //...
19+
```
20+
21+
This will create a static linked binary including the HTTP API and the ClamAV engine.
22+
23+
## License
24+
25+
Clamproxy is licensed under the GNU General Public License v2.0. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)