Skip to content

Commit

Permalink
Merge pull request #241 from sadayuki-matsuno/fix-docker-readme-cation
Browse files Browse the repository at this point in the history
fix readme
  • Loading branch information
kotakanbe authored Nov 2, 2016
2 parents f50a39a + c5cfac6 commit f014f8f
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 0 deletions.
72 changes: 72 additions & 0 deletions setup/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,78 @@ This is the Git repo of the official Docker image for vuls.

This image version is same as the github repository version.

# Caution

This image is built per commit.
If you want to use the latest docker image, you should remove the existing image, and pull it once again.

1. Confirm your vuls version

- go-cve-dictionary

```console
$ docker run --rm vuls/go-cve-dictionary -v

go-cve-dictionary v0.0.xxx xxxx
```

- vuls

```console
$ docker run --rm vuls/vuls -v

vuls v0.0.xxx xxxx
```

2. Remove your old docker images

- go-cve-dictionary

```
$ docker rmi vuls/go-cve-dictionary
```

```
$ docker rmi vuls/vuls
```

- vuls

```
$ docker rmi vuls/vuls
```

3. Pull new vuls docker images

- go-cve-dictionary

```
$ docker pull vuls/go-cve-dictionary
```

- vuls

```
$ docker pull vuls/vuls
```

4. Confirm your vuls version

```console
$ docker run --rm vuls/go-cve-dictionary -v

go-cve-dictionary v0.1.xxx xxxx
```

- vuls

```console
$ docker run --rm vuls/vuls -v

vuls v0.1.xxx xxxx
```


# How to use this image

1. fetch nvd (vuls/go-cve-dictionary)
Expand Down
12 changes: 12 additions & 0 deletions setup/docker/go-cve-dictionary/latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ See the [Hub page](https://hub.docker.com/r/vuls/go-cve-dictionary/) for the ful
This image is built per commit.
If you want to use the latest docker image, you should remove the existing image, and pull it once again.

- Remove old docker image

```
$ docker rmi vuls/go-cve-dictionary
```

- Pull new docker image

```
$ docker pull vuls/go-cve-dictionary
```

# What is go-cve-dictionary?

This is tool to build a local copy of the NVD (National Vulnerabilities Database) [1] and the Japanese JVN [2], which contain security vulnerabilities according to their CVE identifiers [3] including exhaustive information and a risk score. The local copy is generated in sqlite format, and the tool has a server mode for easy querying.
Expand Down
12 changes: 12 additions & 0 deletions setup/docker/vuls/latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ See the [Hub page](https://hub.docker.com/r/vuls/vuls/) for the full readme on h
This image is built per commit.
If you want to use the latest docker image, you should remove the existing image, and pull it once again.

- Remove old docker image

```
$ docker rmi vuls/vuls
```

- Pull new docker image

```
$ docker pull vuls/vuls
```

# What is Vuls?

Vuls is the Vulnerability scanner for Linux/FreeBSD, agentless, written in golang.
Expand Down

0 comments on commit f014f8f

Please sign in to comment.