Updated Docs

AndiPodgorica · Nov 24, 2017 · b482a3a · b482a3a
1 parent 6e02881
commit b482a3a
Show file tree

Hide file tree

Showing 6 changed files with 132 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -6,17 +6,25 @@ Damn Vulnerable NodeJS Application (DVNA) is a simple NodeJS application to demo
 
 The application is powered by commonly used libraries such as [express](https://www.npmjs.com/package/express), [passport](https://www.npmjs.com/package/passport), [sequelize](https://www.npmjs.com/package/sequelize), etc.
 
-The application comes with a developer friendly comprehensive guide which can be used to learn, avoid and fix the vulnerabilities. The guide will be made available and will contain the following
+The application comes with a developer friendly comprehensive guide which can be used to learn, avoid and fix the vulnerabilities. The guide available at https://appsecco.com/books/dvna-developers-security-guide/ covers the following
 
 1. Instructions for setting up DVNA
 2. Instructions on exploiting the vulnerabilities
 3. Vulnerable code snippets and instructions on fixing vulnerabilities
 4. Recommendations for avoid such vulnerabilities
 5. References for learning more
 
-## Quick Start
+## Getting Started
 
-Setting up the application using docker is the recommended procedure. For detailed instructions and manual setup and please refer to the guide.
+DVNA can be deployed in three ways
+
+1. For Developers, using docker-compose with auto-reload on code updates
+2. For Security Testers, using the Official image from Docker Hub
+3. For Advanced Users, using a fully manual setup
+
+Detailed instructions on setup and requirements are given in the Guide Gitbook
+
+### Development Setup
 
 Clone this repository
 ```bash
@@ -40,6 +48,58 @@ Access the application at http://127.0.0.1:9090/
 
 The application will automatically reload on code changes, so feel free to patch and play around with the application.
 
+### Using Official Docker Image
+
+Create a file named `vars.env` with the following configuration
+```
+MYSQL_USER=dvna
+MYSQL_DATABASE=dvna
+MYSQL_PASSWORD=passw0rd
+MYSQL_RANDOM_ROOT_PASSWORD=yes
+MYSQL_HOST=mysql-db
+MYSQL_PORT=3306
+```
+
+Start a MySQL container
+```bash
+docker run --name dvna-mysql --env-file vars.env -d mysql:5.7
+```
+
+Start the application using the official image
+```bash
+docker run --name dvna-app --env-file vars.env --link dvna-mysql:mysql-db -p 9090:9090 appsecco/dvna
+```
+
+Access the application at http://127.0.0.1:9090/ and start testing!
+
+### Manual Setup
+
+Clone the repository
+```bash
+git clone https://github.com/appsecco/dvna; cd dvna
+```
+
+Configure the environment variables with your database information
+```bash
+export MYSQL_USER=dvna
+export MYSQL_DATABASE=dvna
+export MYSQL_PASSWORD=passw0rd
+export MYSQL_HOST=127.0.0.1
+export MYSQL_PORT=3306
+```
+
+Install Dependencies
+```bash
+npm install
+```
+
+Start the application
+```bash
+npm start
+```
+
+Access the application at http://localhost:9090
+
 ## TODO
 
 - [ ] Link commits to fixes in documentation

diff --git a/docs/README.md b/docs/README.md
@@ -1,21 +1 @@
-# Damn Vulnerable NodeJS Application
-
-![dvna-logo](resources/dvna.png)
-
-[Damn Vulneable NodeJS Application (DVNA)](https://github.com/appsecco/dvna) is a simple NodeJS application to demonstrate [**OWASP Top 10 Vulnerabilities**](https://www.owasp.org/index.php/Category:OWASP_Top_Ten_Project#OWASP_Top_10_for_2013) and guide on fixing and avoiding these vulnerabilities. 
-
-The application is powered by commonly used libraries such as [express](https://www.npmjs.com/package/express), [passport](https://www.npmjs.com/package/passport), [sequelize](https://www.npmjs.com/package/sequelize), etc.
-
-It is aimed to be useful for developers with limited development expereience in NodeJS, and the fixes for the vulnerabilities will be available in the [fixes](https://github.com/appsecco/dvna/tree/fixes) branch in the repository.
-
-This guide contains the following
-
-1. Instructions for setting up DVNA
-2. Instructions on exploiting the vulnerabilities
-3. Vulnerable code snippets and instructions on fixing vulnerabilities
-4. Recommendations for avoid such vulnerabilities
-5. References for learning more
-
-#### Available on Github <i class="fa fa-github" aria-hidden="true"></i> [https://github.com/appsecco/dvna](https://github.com/appsecco/dvna)
-
-This gitbook was generated from https://github.com/appsecco/dvna/tree/master/docs
+![dvna](resources/cover.png)
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,10 +1,10 @@
 # Summary
 
-* [Cover](cover.md)
+* [Cover](README.md)
 
 ## Introduction
 
-* [Introduction](README.md)
+* [Introduction](intro.md)
 * [Setup](setup.md)
 
 ## Solution

diff --git a/docs/cover.md b/docs/cover.md
diff --git a/docs/intro.md b/docs/intro.md
@@ -0,0 +1,21 @@
+# Damn Vulnerable NodeJS Application
+
+![dvna-logo](resources/dvna.png)
+
+[Damn Vulneable NodeJS Application (DVNA)](https://github.com/appsecco/dvna) is a simple NodeJS application to demonstrate [**OWASP Top 10 Vulnerabilities**](https://www.owasp.org/index.php/Category:OWASP_Top_Ten_Project#OWASP_Top_10_for_2013) and guide on fixing and avoiding these vulnerabilities. 
+
+The application is powered by commonly used libraries such as [express](https://www.npmjs.com/package/express), [passport](https://www.npmjs.com/package/passport), [sequelize](https://www.npmjs.com/package/sequelize), etc.
+
+It is aimed to be useful for developers with limited development expereience in NodeJS, and the fixes for the vulnerabilities will be available in the [fixes](https://github.com/appsecco/dvna/tree/fixes) branch in the repository.
+
+This guide contains the following
+
+1. Instructions for setting up DVNA
+2. Instructions on exploiting the vulnerabilities
+3. Vulnerable code snippets and instructions on fixing vulnerabilities
+4. Recommendations for avoid such vulnerabilities
+5. References for learning more
+
+#### Available on Github <i class="fa fa-github" aria-hidden="true"></i> [https://github.com/appsecco/dvna](https://github.com/appsecco/dvna)
+
+This gitbook was generated from https://github.com/appsecco/dvna/tree/master/docs
diff --git a/docs/setup.md b/docs/setup.md
@@ -1,38 +1,44 @@
 # Setup
 
-It is recommeded to follow the Dockerized setup of the application unless a manual setup is required
+DVNA can be deployed in three ways
+
+1. For Developers, using docker-compose with auto-reload on code updates
+2. For Security Testers, using the Official image from Docker Hub
+3. For Advanced Users, using a fully manual setup
 
 ## Requirements
 
-Dockerized Setup:
+Setup with Docker:
 
 - Docker (Tested working on v1.13.1)
 - Docker Compose (Tested working on v1.17.1)
 
 Setup Without Docker:
 
-- NodeJS (Deveoped using NodeJS v6.11.4)
+- NodeJS (Developed using NodeJS v6.11.4)
 - MySQL Server (Developed using MySQL 5.7)
 
-## Decokerized setup
+### Development Setup
 
 If you do not have Docker and Docker Compose setup, then
 
 Install [Docker](https://docs.docker.com/engine/installation/) first and then 
 [Docker Compose](https://docs.docker.com/compose/install/) on your system. Then follow the instructions below
 
-1. Clone the respository
+Clone the repository
 ```bash
 git clone https://github.com/appsecco/dvna; cd dvna
 ```
-2. Create a file with name `vars.env` in the application's folder with the desired configuration like the example below
+
+Create a file with name `vars.env` in the application's folder with the desired configuration like the example below
 ```
 MYSQL_USER=dvna
 MYSQL_DATABASE=dvna
 MYSQL_PASSWORD=passw0rd
 MYSQL_RANDOM_ROOT_PASSWORD=yes
 ```
-3. Start the application using Docker Compose
+
+Start the application using Docker Compose
 ```bash
 docker-compose up
 ```
@@ -41,7 +47,31 @@ Access the application at http://localhost:9090 and start practicing!
 
 The application will automatically reload on code changes, so feel free to patch and play around.
 
-## Manual Setup
+### Using Official Docker Image
+
+Create a file named `vars.env` with the following configuration
+```
+MYSQL_USER=dvna
+MYSQL_DATABASE=dvna
+MYSQL_PASSWORD=passw0rd
+MYSQL_RANDOM_ROOT_PASSWORD=yes
+MYSQL_HOST=mysql-db
+MYSQL_PORT=3306
+```
+
+Start a MySQL container, unless you want to use your own, in which case configure in the env file above
+```bash
+docker run --name dvna-mysql --env-file vars.env -d mysql:5.7
+```
+
+Start the application using the official image
+```bash
+docker run --name dvna-app --env-file vars.env --link dvna-mysql:mysql-db -p 9090:9090 appsecco/dvna
+```
+
+Access the application at http://127.0.0.1:9090/ and start testing!
+
+### Manual Setup
 
 This is an advanced setup which requires you to have NodeJS setup on your system and access to a MySQL Database. Unless your requirements demands it, its recommended to go with the Dockerized Setup above.
 
@@ -50,23 +80,26 @@ Install [NodeJS](https://nodejs.org/en/download/package-manager/) first.
 
 If you do not have access to an existing MySQL server and would like to setup your own MySQL instance, then refer to this [Getting Started](https://dev.mysql.com/doc/mysql-getting-started/en/) guide. Once the MySQL Sever is setup, create a new database and user for DVNA. You will need to configure these in the environment variables before starting the application.
 
-1. Clone the repository
+Clone the repository
 ```bash
 git clone https://github.com/appsecco/dvna; cd dvna
 ```
-2. Configure the environment variables with your database information. For Windows system, refer to the guide on [Setting up environment variables](http://www.dowdandassociates.com/blog/content/howto-set-an-environment-variable-in-windows-command-line-and-registry/)
+
+Configure the environment variables with your database information. For Windows system, refer to the guide on [Setting up environment variables](http://www.dowdandassociates.com/blog/content/howto-set-an-environment-variable-in-windows-command-line-and-registry/)
 ```bash
 export MYSQL_USER=dvna
 export MYSQL_DATABASE=dvna
 export MYSQL_PASSWORD=passw0rd
 export MYSQL_HOST=127.0.0.1
 export MYSQL_PORT=3306
 ```
-3. Install Dependencies
+
+Install Dependencies
 ```bash
 npm install
 ```
-4. Start the application
+
+Start the application
 ```bash
 npm start
 ```