Categorygithub.com/adevinta/vulcan-results
modulepackage
1.0.26
Repository: https://github.com/adevinta/vulcan-results.git
Documentation: pkg.go.dev

# README

Vulcan Results Service

Requirements

  • go 1.13.x

Build & Install

GO111MODULE=on go get github.com/adevinta/vulcan-results/cmd/vulcan-result

Build, regenerate code from Goa DSL & install in a Docker container

docker run -ti golang:1.13-alpine /bin/sh
apk add git
# Cloning out of the GOPATH
cd /tmp
git clone git://github.com/adevinta/vulcan-results.git
cd vulcan-results
go mod download
go install github.com/goadesign/goa/goagen
sh clean.sh
sh build.sh

Config file example:

config-example.toml

# File where result logs are stored.
# Leave empty (or remove) for STDOUT.
LogFile = ""
Port = 8888
Debug = true

[Storage]
Region = "eu-west-1"
BucketVulnerableReports = "my-vulnerable-reports-bucket"
BucketReports = "my-reports-bucket"
BucketLogs = "my-check-logs-bucket"
LinkBase = "http://example.com/v1"

Run

$GOPATH/bin/vulcan-results /path/to/config-example.toml

Docker execute

Those are the variables you have to use:

VariableDescriptionSample
PORTListen http port8080
DEBUGtrue
AWS_REGIONaws regioneu-west-1
BUCKET_REPORTSBucket name to store reportsbucket-reports
BUCKET_LOGSBuckent name to store logsbucket-logs
LINK_BASEURL used for TBDhttp://results/v1
docker build . -t vr

# Use the default config.toml customized with env variables.
docker run --env-file ./local.env vr

# Use custom config.toml
docker run -v `pwd`/custom.toml:/app/config.toml vr

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewHealthcheckController creates a healthcheck controller.
NewResultsController creates a Results controller.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
HealthcheckController implements the healthcheck resource.
ResultsController implements the Results resource.
No description provided by the author