add instructions to manual build and test commands
This commit is contained in:
parent
f1e377eed1
commit
0ad4f70469
1 changed files with 41 additions and 5 deletions
46
README.md
46
README.md
|
@ -1,12 +1,48 @@
|
|||
Build status:
|
||||
- 
|
||||
- 
|
||||
- 
|
||||
- 
|
||||
|
||||
This repository contains a basic rest api for clamav which allows sites to scan files as they are uploaded
|
||||
|
||||
!! Project needs cleenup, Makefile and documentation oesn't match current status !!
|
||||
|
||||
Usage:
|
||||
|
||||
make build-container - this will build the docker container and link it up to a clamav container
|
||||
it exposes a rest api on port 9000
|
||||
build golang binary and docker image:
|
||||
```bash
|
||||
env GOOS=linux GOARCH=amd64 go build
|
||||
docker build . -t niilo/clamav-rest
|
||||
docker run -p 9000:9000 --rm -it niilo/clamav-rest
|
||||
```
|
||||
|
||||
make test - this will test against the rest api
|
||||
Run clamav-rest docker image:
|
||||
```bash
|
||||
docker run -p 9000:9000 --rm -it niilo/clamav-rest
|
||||
```
|
||||
|
||||
Test that service detects common test virus signature:
|
||||
```bash
|
||||
$ curl -i -F "file=@eicar.com.txt" http://localhost:9000/scan
|
||||
HTTP/1.1 100 Continue
|
||||
|
||||
HTTP/1.1 406 Not Acceptable
|
||||
Content-Type: application/json; charset=utf-8
|
||||
Date: Mon, 28 Aug 2017 20:22:34 GMT
|
||||
Content-Length: 56
|
||||
|
||||
{ Status: "FOUND", Description: "Eicar-Test-Signature" }
|
||||
```
|
||||
|
||||
Test that service returns 200 for clean file:
|
||||
```bash
|
||||
$ curl -i -F "file=@clamrest.go" http://localhost:9000/scan
|
||||
|
||||
HTTP/1.1 100 Continue
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json; charset=utf-8
|
||||
Date: Mon, 28 Aug 2017 20:23:16 GMT
|
||||
Content-Length: 33
|
||||
|
||||
{ Status: "OK", Description: "" }
|
||||
```
|
Loading…
Add table
Reference in a new issue