Getting current release running is hard and obscure #308
- README.md for develop only contains 8.0 information (removed legacy information etc) - Docker image now contains tag for version 8.0
This commit is contained in:
Nanne Baars
parent
ee0d34e2ea
commit
9485362309
125
README.MD
125
README.MD
@ -6,12 +6,12 @@
|
||||
[](https://www.versioneye.com/user/projects/562da95ae346d7000e0369aa)
|
||||
[](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Labs_Projects)
|
||||
|
||||
# Important Information
|
||||
# Important
|
||||
|
||||
### The WebGoat Lesson Server, is currently **UNDER MAJOR DEVELOMENT**.
|
||||
As of November 2016, 7.1 is the current stable release and 8.x is under development ('develop') branch here.
|
||||
This is the development version of WebGoat 8, if you are looking for a released stable version please go to: https://github.com/WebGoat/WebGoat/wiki/Running-WebGoat
|
||||
|
||||
#### Older/Legacy version of WebGoat an be found at: [WebGoat-Legacy](https://github.com/WebGoat/WebGoat-Legacy)
|
||||
|
||||
# Introduction
|
||||
|
||||
WebGoat is a deliberately insecure web application maintained by [OWASP](http://www.owasp.org/) designed to teach web
|
||||
application security lessons.
|
||||
@ -42,99 +42,38 @@ you are caught engaging in unauthorized hacking, most companies will fire you.
|
||||
Claiming that you were doing security research will not work as that is the
|
||||
first thing that all hackers claim.*
|
||||
|
||||
# Easy Run ( For non-developers )
|
||||
# Run Instructions:
|
||||
|
||||
Every successful build of the WebGoat Lessons Container and the WebGoat Lessons in our Continuous Integration Server
|
||||
creates an "Easy Run" Executable WAR file, which contains the WebGoat Lessons Server, the lessons and a embedded Tomcat server.
|
||||
## 1. Run using Docker
|
||||
|
||||
You can check for the "Last Modified" date of our "Easy Run" war file [HERE](http://webgoat-war.s3-website-us-east-1.amazonaws.com/)
|
||||
|
||||
The "Easy Run" JAR file offers a no hassle approach to testing and running WebGoat. Follow these instructions if you
|
||||
wish to simply try/test/run the current development version of WebGoat
|
||||
|
||||
### Prerequisites:
|
||||
* Java VM 1.8 or Docker installed
|
||||
|
||||
## Easy Run Instructions:
|
||||
|
||||
#### 1. Docker image
|
||||
|
||||
The latest version of WebGoat is available at DockerHub, see [https://hub.docker.com/r/webgoat/webgoat-container/](https://hub.docker.com/r/webgoat/webgoat-container/).
|
||||
From time to time we publish a new development preview of WebGoat 8 on Docker HUB, you can download this version
|
||||
[https://hub.docker.com/r/webgoat/webgoat-8.0/](https://hub.docker.com/r/webgoat/webgoat-8.0/).
|
||||
First install Docker, then open a command shell/window and type:
|
||||
|
||||
```Shell
|
||||
docker pull webgoat/webgoat-container
|
||||
docker run -p 8080:8080 webgoat/webgoat-container
|
||||
docker pull webgoat/webgoat-8.0
|
||||
docker run -p 8080:8080 webgoat/webgoat-8.0
|
||||
```
|
||||
|
||||
Wait for the Docker container to start and go to step 3.
|
||||
Please note: this version may not be completely in sync with the develop branch.
|
||||
|
||||
#### 2. Download the easy run executable jar file which contains all the lessons and a embedded Tomcat server:
|
||||
|
||||
https://s3.amazonaws.com/webgoat-war/webgoat-standalone-7.1-SNAPSHOT-exec.jar
|
||||
|
||||
#### 3. Run it using java:
|
||||
|
||||
Open a command shell/window, browse to where you downloaded the easy run jar and type:
|
||||
|
||||
```Shell
|
||||
java -jar webgoat-standalone-7.0.1-exec.jar [-p | --p <port>] [-a | --address <address>]
|
||||
```
|
||||
|
||||
Using the `--help` option will show the allowed command line arguments.
|
||||
|
||||
#### 3. Browse to the url shown in the console and happy hacking !
|
||||
|
||||
## Vagrant
|
||||
|
||||
To run WebGoat with Vagrant you must first have Vagrant and Virtualbox installed.
|
||||
|
||||
```shell
|
||||
$ cd WebGoat/webgoat-images/vagrant-users
|
||||
$ vagrant up
|
||||
```
|
||||
|
||||
Once you see the message 'Browse to http://localhost:9999/WebGoat and happy hacking! you can open a
|
||||
browser.
|
||||
|
||||
|
||||
# For Developers
|
||||
|
||||
## Set up manual
|
||||
|
||||
Follow these instructions if you wish to run Webgoat and modify the source code as well.
|
||||
## 2. Run from the sources
|
||||
|
||||
### Prerequisites:
|
||||
|
||||
* Java 8
|
||||
* Maven > 3.2.1
|
||||
* Your favorite IDE, with Maven awareness: Netbeans/IntelliJ/Eclipse with m2e installed.
|
||||
* Your favorite IDE
|
||||
* Git, or Git support in your IDE
|
||||
|
||||
## The Easy Way: Developer Edition run using Linux or Mac
|
||||
The __webgoat_developer_bootstrap.sh__ script will clone the necessary repositories, call the maven goals in order
|
||||
launch Tomcat listening on localhost:8080
|
||||
|
||||
```Shell
|
||||
mkdir WebGoat-Workspace
|
||||
cd WebGoat-Workspace
|
||||
curl -o webgoat_developer_bootstrap.sh https://raw.githubusercontent.com/WebGoat/WebGoat/master/webgoat_developer_bootstrap.sh
|
||||
./webgoat_developer_bootstrap.sh
|
||||
```
|
||||
|
||||
## The Manual Way: Developer Edition!
|
||||
|
||||
#### Cloning the Lesson Server and the Lessons project:
|
||||
|
||||
Open a command shell/window, navigate to where you wish to download the source and type:
|
||||
mvn clean package
|
||||
mvn –pl webgoat-container spring-boot:run
|
||||
Open a command shell/window:
|
||||
|
||||
```Shell
|
||||
git clone git@github.com:WebGoat/WebGoat.git
|
||||
```
|
||||
|
||||
#### Now let's start by compiling the project.
|
||||
Now let's start by compiling the project.
|
||||
|
||||
```Shell
|
||||
cd WebGoat
|
||||
@ -142,13 +81,28 @@ git checkout develop
|
||||
mvn clean package
|
||||
```
|
||||
|
||||
#### Now we are ready to run the project. WebGoat 8.x is using Spring-Boot.
|
||||
Now we are ready to run the project. WebGoat 8.x is using Spring-Boot.
|
||||
|
||||
```Shell
|
||||
mvn -pl webgoat-container spring-boot:run
|
||||
```
|
||||
... you should be running webgoat on localhost:8080/WebGoat momentarily
|
||||
|
||||
## Building a new Docker image
|
||||
|
||||
# Vagrant
|
||||
|
||||
We supply a complete development environment using Vagrant, to run WebGoat with Vagrant you must first have Vagrant and Virtualbox installed.
|
||||
|
||||
```shell
|
||||
$ cd WebGoat/webgoat-images/vagrant-users
|
||||
$ vagrant up
|
||||
```
|
||||
|
||||
Once the provisioning is complete login to the Virtualbox with username vagrant and password vagrant.
|
||||
The source code will be available in the home directory.
|
||||
|
||||
|
||||
# Building a new Docker image
|
||||
|
||||
WebGoat now has Docker support you can build a container with the following commands:
|
||||
|
||||
@ -157,6 +111,7 @@ cd WebGoat/
|
||||
mvn package
|
||||
cd webgoat-container
|
||||
mvn docker:build
|
||||
docker tag webgoat/webgoat-8.0 webgoat/webgoat-8.0:8.0
|
||||
docker login
|
||||
docker push webgoat/webgoat-container
|
||||
```
|
||||
@ -164,20 +119,8 @@ docker push webgoat/webgoat-container
|
||||
With the following command you are able to run the Docker container on your local machine:
|
||||
|
||||
```Shell
|
||||
docker run -p 8080:8080 -t webgoat/webgoat-container
|
||||
docker run -p 8080:8080 -t webgoat/webgoat-8.0
|
||||
docker ps
|
||||
```
|
||||
|
||||
With the last command you are able to determine ip address to connect to.
|
||||
|
||||
## Vagrant
|
||||
|
||||
For an easy development experience you can use Vagrant. Note you should have Vagrant and Virtualbox installed on your system.
|
||||
|
||||
```shell
|
||||
$ cd WebGoat/webgoat-images/vagrant-developers
|
||||
$ vagrant up
|
||||
```
|
||||
|
||||
Once the provisioning is complete login to the Virtualbox with username vagrant and password vagrant.
|
||||
The source code will be available in the home directory.
|
||||
|
||||
@ -39,7 +39,7 @@
|
||||
<artifactId>docker-maven-plugin</artifactId>
|
||||
<version>0.4.10</version>
|
||||
<configuration>
|
||||
<imageName>webgoat/${project.artifactId}</imageName>
|
||||
<imageName>webgoat/webgoat-8.0</imageName>
|
||||
<dockerDirectory>src/main/docker</dockerDirectory>
|
||||
<resources>
|
||||
<resource>
|
||||
|
||||
@ -116,46 +116,6 @@ developer_bootstrap() {
|
||||
)
|
||||
fi
|
||||
|
||||
# Clone WebGoat-lessons from GitHub if they don't exist
|
||||
if [ ! -d "WebGoat-Lessons" ]; then
|
||||
horizontal_rule
|
||||
echo -e -e "$COL_CYAN Cloning the WebGoat Lessons repository $COL_RESET"
|
||||
git clone https://github.com/WebGoat/WebGoat-Lessons.git
|
||||
else
|
||||
horizontal_rule
|
||||
(
|
||||
echo -e "$COL_YELLOW The WebGoat Lesson repo has already been cloned before, pulling upstream changes. $COL_RESET"
|
||||
cd WebGoat-Lessons || {
|
||||
echo -e >&2 "$COL_RED *** ERROR: Could not cd into the WebGoat-Lessons Directory $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
git pull origin develop
|
||||
)
|
||||
fi
|
||||
|
||||
# Compile and Install the WebGoat lesson server
|
||||
horizontal_rule
|
||||
echo -e "$COL_BLUE Compiling and installing the WebGoat Container lesson server..... $COL_RESET"
|
||||
mvn -q -DskipTests -file WebGoat/pom.xml clean compile install || {
|
||||
echo -e >&2 "$COL_RED *** ERROR: Could not compile the WebGoat Container. $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
echo -e "$COL_GREEN SUCCESS: Compiled the WebGoat Container successfully! $COL_RESET"
|
||||
|
||||
# Compile and package the WebGoat Lessons
|
||||
horizontal_rule
|
||||
echo -e "$COL_BLUE Compiling and installing the WebGoat Lessons $COL_RESET"
|
||||
mvn -q -DskipTests -file WebGoat-Lessons/pom.xml package || {
|
||||
echo -e >&2 "$COL_RED *** ERROR: Could not compile the WebGoat Container. $COL_RESET"
|
||||
return 1
|
||||
}
|
||||
echo -e "$COL_GREEN SUCCESS: Compiled the WebGoat Lessons successfully! $COL_RESET"
|
||||
|
||||
# Copy the Lessons into the WebGoat-Container
|
||||
horizontal_rule
|
||||
echo -e "$COL_BLUE Copying the compiled lessons jars into the container so we can start the lesson server with some base lessons, $COL_RESET"
|
||||
cp -fa ./WebGoat-Lessons/target/plugins/*.jar ./WebGoat/webgoat-container/src/main/webapp/plugin_lessons/
|
||||
|
||||
# Start the embedded Tomcat server
|
||||
echo -e "$COL_MAGENTA"
|
||||
horizontal_rule
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user