Skip to content

Commit

Permalink
#363: fix docker issues and README (#366)
Browse files Browse the repository at this point in the history
Co-authored-by: Praveen Darshanam <[email protected]>
  • Loading branch information
praveendhac and Praveen Darshanam authored Oct 19, 2020
1 parent 63ab89f commit 4a8dbaa
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.*
Dockerfile
docs
LICENSE
README.md
9 changes: 5 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:8-alpine
FROM node:lts-alpine3.12

# Define a build argment that can be supplied when building the container
# You can then do the following:
Expand All @@ -9,9 +9,10 @@ FROM node:8-alpine
# You could also use this to specify a particular version number.
ARG PACKAGENAME=cloudsploit

COPY . /var/scan/cloudsploit/

# Install cloudsploit/scan into the container using npm from NPM
RUN mkdir /var/scan \
&& cd /var/scan \
RUN cd /var/scan \
&& npm init --yes \
&& npm install ${PACKAGENAME}

Expand All @@ -23,5 +24,5 @@ ENV PATH "$PATH:/var/scan/node_modules/.bin"
# command line arguments to the run command to control how this executes.
# Thus, you can use the parameters that you would normally give to index.js
# when running in a container.
ENTRYPOINT ["cloudsploitscan"]
ENTRYPOINT ["cloudsploit-scan"]
CMD []
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,23 @@ CloudSploit by Aqua - Cloud Security Scans
[<img src="docs/console.png">](https://cloud.aquasec.com/signup)

## Quick Start
### Generic
```
$ git clone git@github.com:cloudsploit/scans.git
$ cd scans
$ git clone https://github.com/aquasecurity/cloudsploit.git
$ cd cloudsploit
$ npm install
$ ./index.js -h
```

### Docker
```
$ git clone https://github.com/aquasecurity/cloudsploit.git
$ cd cloudsploit
$ docker build . -t cloudsploit:0.0.1
$ docker run cloudsploit:0.0.1 -h
$ docker run -e AWS_ACCESS_KEY_ID=XX -e AWS_SECRET_ACCESS_KEY=YY cloudsploit:0.0.1 --compliance=pci
```

## Documentation
* [Background](#background)
* [Deployment Options](#deployment-options)
Expand Down

0 comments on commit 4a8dbaa

Please sign in to comment.