From 34131196f7db9fbefa6bd96265e5e6bf538e4f27 Mon Sep 17 00:00:00 2001
From: Ryan Leonard <3-rleonard@users.noreply.gitlab.ipa.securecompliance.co>
Date: Thu, 29 Aug 2019 16:19:44 -0500
Subject: [PATCH] Update Readme.md

---
 Readme.md | 50 ++++++++++++++++++++++++++++----------------------
 1 file changed, 28 insertions(+), 22 deletions(-)

diff --git a/Readme.md b/Readme.md
index 89a02594..64345d45 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,21 +1,38 @@
 # Openvas 10 Docker Image
 
-This docker image is based on Openvas 10 but with a few package modifications. After years of using openvas8 and openvas9 on kali we started having issues running scans with the openvas package maintained by the kali project. We have decided to maintain our own build and streamline the installation and cleanup.
-
+This docker image is based on Openvas 10 but with a few package modifications. After years of successfully using the OpenVAS 8/9 package, maintained by the Kali project, we started having scanning and performance issues. After months of trying to tweak/stablize OpenVAS, with varying and short lived success, we decided to maintain our own modified version of OpenVAS 10 to streamline the installation and cleanup while greatly increasing reliability.
 
 ## Deployment
 
-Install docker (google is your friend) and run our container.
+**Install docker**
+
+If you have Kali or Ubuntu you can use the docker.io package.
+```
+apt install docker.io
+```
+
+If you are using any debian based OS that does not have the docker.io package, you can follow [this guide](https://docs.docker.com/install/linux/docker-ce/debian/) 
+
+You can also use the docker install script by running:
+```
+curl https://get.docker.com | sh
+```
+
+**Run our container**
+
+This command will pull, create, and start the container:
 ```
 docker run -d -p 8080:9392 securecompliance/openvas --name openvas
 ```
-You can use whatever `--name` you'd like but for the sake of this guide we're keeping it simple.
+You can use whatever `--name` you'd like but for the sake of this guide we're using openvas.
 
-This will pull the image from our docker repo and port forwarding 9392 (OpenVAS default web interface) to 8080 to make it accessible on the host IP. Depending on your hardware, it can take anyhwere from a few seconds to 10 minutes while the NVTs are scanned and the database is rebuilt. The default user account is created after this process has completed. If you are unable to login, it means it is still loading. (be patient)
+The `-p 8080:9392` switch will port forward 8080 on the host to 9392 (OpenVAS default web interface) in the docker container. Port 8080 was chosen only to avoid conflicts with any existing OpenVAS installation. You can change 8080 to any available port that you'd like.
+
+Depending on your hardware, it can take anyhwere from a few seconds to 10 minutes while the NVTs are scanned and the database is rebuilt. **The default user account is created after this process has completed. If you are unable to login, it means it is still loading (be patient).**
 
 **Checking Deployment Progress**
 
-There is no easy way to estimate the remaining NVT loading time, but you can check if the NVTs have finished loading by running 
+There is no easy way to estimate the remaining NVT loading time, but you can check if the NVTs have finished loading by running:
 ```
 docker logs openvas
 ```
@@ -33,32 +50,21 @@ Password: admin
 
 ## Monitoring Scan Progress
 
-This command will show you the running OpenVAS processes in the container
+This command will show you the OpenVAS processes running inside the container:
 ```
 docker top openvas
 ```
 
 ## Checking the OpenVAS Logs
 
-We are tailing all the logs from /usr/local/var/log/gvm/*
-You can view them by running
+All the logs from /usr/local/var/log/gvm/* can be viewed by running:
 ```
 docker logs openvas
 ```
 
 ## Updating the NVTs
-The NVTs will update every time the container starts. If you leave your container running 24/7, you will need to periodically update the NVTs using the following commands:
-```
-docker exec -it openvas bash
-```
-Once inside the container run:
+
+The NVTs will update every time the container starts. Even if you leave your container running 24/7, the easiest way to update your NVTs is to restart the container.
 ```
-greenbone-nvt-sync
-openvasmd --rebuild --progress
-greenbone-certdata-sync
-greenbone-scapdata-sync
-openvasmd --update --verbose --progress
-/etc/init.d/openvas-manager restart
-/etc/init.d/openvas-scanner restart
+docker restart openvas
 ```
-