Skip to content

Latest commit

 

History

History
117 lines (84 loc) · 3.39 KB

setup.md

File metadata and controls

117 lines (84 loc) · 3.39 KB
Raw

Setup

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

Setup with Docker:

  • Docker (Tested working on v1.13.1)
  • Docker Compose (Tested working on v1.17.1)

Setup Without Docker:

  • NodeJS (Developed using NodeJS v6.11.4)
  • MySQL Server (Developed using MySQL 5.7)

Quick start

On a system with Docker installed, run

docker run --name dvna -p 9090:9090 -d appsecco/dvna:sqlite

Access the application at http://127.0.0.1:9090

Development Setup

If you do not have Docker and Docker Compose setup, then

Install Docker first and then Docker Compose on your system. Then follow the instructions below

Clone the repository

git clone https://github.com/appsecco/dvna; cd dvna

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

Start the application using Docker Compose

docker-compose up

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.

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

docker run --name dvna-mysql --env-file vars.env -d mysql:5.7

Start the application using the official image

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.

If you do not have NodeJS on your system, then Install NodeJS 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 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.

Clone the repository

git clone https://github.com/appsecco/dvna; cd dvna

Configure the environment variables with your database information. For Windows system, refer to the guide on Setting up environment variables

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

npm install

Start the application

npm start

Access the application at http://localhost:9090 and start practicing!