Skip to content

Commit

Permalink
Update HOW-TO-USE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
preetkaran20 authored Oct 4, 2022
1 parent 815d53d commit 317b6c4
Showing 1 changed file with 21 additions and 18 deletions.
39 changes: 21 additions & 18 deletions docs/HOW-TO-USE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,32 @@ nav_order: 3

# How to run the project

## Running as full-fledged Vulnerable Application
1. It is very easy to run the VulnerableApp as full-fledged VulnerableApplication. Follow the steps mentioned at [Simple Start](https://github.com/SasanLabs/VulnerableApp-facade#simple-start) and it is quite straightforward.
## Running the project
There are 2 ways to run the project:
1. The simplest way to run the project is using Docker containers which will run the full-fleged VulnerableApplication with all the components. For running as Docker application, follow following steps:
1. Download and Install [Docker Compose](https://docs.docker.com/compose/install/)
2. Clone this Github repository
3. Open the terminal and Navigate to the Project root directory
4. Run the command ```docker-compose pull && docker-compose up```
5. Navigate to browser and visit `http://localhost` and this will give the User Interface for VulnerableApp.

**Note**: The above steps will run the latest unreleased VulnerableApp version. If you want to run the latest released version, please use docker **latest** tag.
2. Another way to run the VulnerableApp is as standalone Vulnerable Application is:
1. Navigate to [Releases Section](https://github.com/SasanLabs/VulnerableApp/releases) in github and download the Jar for the latest released version
2. Open the terminal and navigate to the project root directory
3. Run the command ```java -jar VulnerableApp-*```
4. Navigate to browser and visit `http://localhost:9090/VulnerableApp`. This will give the Legacy User Interface for the VulnerableApp.

## Running as standalone Vulnerable Application
1. Running it as a **docker container** in order to run it as docker container, you just need to run `docker run --rm -p 9090:9090 --name=owasp-vulnerableapp sasanlabs/owasp-vulnerableapp:latest`

2. Running it as an **executable**, download released jar from [Releases](https://github.com/SasanLabs/VulnerableApp/releases) and run the application by executing following command `java -jar VulnerableApp-1.0.0.jar`

3. Running it by **Building manually**, as VulnerableApp is a spring boot based application so for starting this application you need to import this project in IDE like eclipse or intellij. IDE should have buildship/gradle plugin. As this project is developed in eclipse so eclipse is recommended IDE for now.
After importing the project, run the app and it should start a server.

After starting the application, Navigate to `http://<base-url>:9090/VulnerableApp` , for eg: `http://localhost:9090/VulnerableApp` url and a User Interface will guide you to next steps. Running as standalone Vulnerable Application gives the **Legacy User Interface**

# How to build the project
## Building the project
There are 2 ways in which this project can be built and used:
1. As a SringBoot application which will run with the Legacy UI or Rest API but gives the benefit of debugging and solving issues. This is the simple way,
1. Import the project into your favorite IDE and run it
2. Navigate to browser and visit: `http://localhost:9090/VulnerableApp` and this will give the Legacy User Interface for VulnerableApp which you can use to debug and test.
2. As a Docker application which will help in running the full-fledged VulnerableApplication. For running as Docker application, follow following steps:
1. As a Docker application which will help in running the full-fledged VulnerableApplication. For running as Docker application, follow following steps:
1. Build the docker image by running `./gradlew jibDockerBuild`
2. Download [Docker-Compose](https://github.com/SasanLabs/VulnerableApp-facade/blob/main/docker-compose.yml) and run in the same directory `docker-compose up`
3. Navigate to browser and visit `http://localhost` and this will give the User Interface for VulnerableApp.

2. As a SpringBoot application which will run with the Legacy UI or Rest API but gives the benefit of debugging and solving issues. This is the simple way,
1. Import the project into your favorite IDE and run it
2. Navigate to browser and visit: `http://localhost:9090/VulnerableApp` and this will give the Legacy User Interface for VulnerableApp which you can use to debug and test.

## Glimpse of ReactJS based User Interface ##
![VulnerableApp-facade UI](https://raw.githubusercontent.com/SasanLabs/VulnerableApp-facade/main/docs/images/gif/VulnerableApp-Facade.gif)

Expand Down

0 comments on commit 317b6c4

Please sign in to comment.