Update README (#387)

Update Tutorial in README
This commit is contained in:
Kota Kanbe
2017-03-21 10:47:19 +09:00
committed by GitHub
parent 58afcfc49a
commit af5a1204bc
4 changed files with 268 additions and 119 deletions

View File

@@ -85,7 +85,7 @@ vuls v0.1.xxx xxxx
1. fetch nvd (vuls/go-cve-dictionary)
1. configuration (vuls/vuls)
1. prepare (vuls/vuls)
1. configtest (vuls/vuls)
1. scan (vuls/vuls)
1. vulsrepo (vuls/vulsrepo)
@@ -113,7 +113,7 @@ port = "22"
user = "vuls-user"
keyPath = "/root/.ssh/id_rsa" # path to ssh private key in docker
```
 
```console
$ docker run --rm \
@@ -124,14 +124,14 @@ $ docker run --rm \
-config=./config.toml # path to config.toml in docker
```
## Step3. Prepare
## Step3. Configtest
```console
$ docker run --rm -it\
-v ~/.ssh:/root/.ssh:ro \
-v $PWD:/vuls \
-v $PWD/vuls-log:/var/log/vuls \
vuls/vuls prepare \
vuls/vuls configtest \
-config=./config.toml # path to config.toml in docker
```

View File

@@ -39,7 +39,7 @@ Please see the [Documentation](https://github.com/future-architect/vuls)
$ docker run --rm vuls/vuls -v
```
## configtest
## config
Create config.toml referring to [this](https://github.com/future-architect/vuls#configuration).
@@ -52,25 +52,16 @@ port = "22"
user = "vuls-user"
keyPath = "/root/.ssh/id_rsa" # path to ssh private key in docker
```
 
```console
$ docker run --rm \
-v ~/.ssh:/root/.ssh:ro \
-v $PWD:/vuls \
-v $PWD/vuls-log:/var/log/vuls \
vuls/vuls configtest
```
## prepare
## configtest
```console
$ docker run --rm -it \
-v ~/.ssh:/root/.ssh:ro \
-v $PWD:/vuls \
-v $PWD/vuls-log:/var/log/vuls \
vuls/vuls prepare \
vuls/vuls configtest \
-config=./config.toml # path to config.toml in docker
```