PyGoat
Intentionally vulnerable web application security in Django.
Table of Contents
Installation
From Sources
To setup the project on your local machine:
First, Clone the repository using GitHub website or git in Terminal
git clone https://github.com/adeyosemanputra/pygoat.git
### To Download a specific branch
git clone -b <branch_name> https://github.com/adeyosemanputra/pygoat.git
Method 1
- Install all app and python requirements using installer file -
bash installer.sh
- Apply the migrations
python3 manage.py migrate
. - Finally, run the development server
python3 manage.py runserver
. - The project will be available at http://127.0.0.1:8000
Method 2
- Install python3 requirements
pip install -r requirements.txt
. - Apply the migrations
python3 manage.py migrate
. - Finally, run the development server
python3 manage.py runserver
. - The project will be available at http://127.0.0.1:8000
Method 3
- Install all app and python requirements using
setup.py
file -pip3 install .
- Apply the migrations
python3 manage.py migrate
. - Finally, run the development server
python3 manage.py runserver
. - The project will be available at http://127.0.0.1:8000
Docker Container
- Install Docker
- Run
docker pull pygoat/pygoat
ordocker pull pygoat/pygoat:latest
- Run
docker run --rm -p 8000:8000 pygoat/pygoat:latest
- Browse to http://127.0.0.1:8000
- Remove existing image using
docker image rm pygoat/pygoat
and pull again incase of any error
From Docker-Compose
- Install Docker
- Run
docker-compose up
ordocker-compose up -d
Build Docker Image and Run
- Clone the repository
git clone https://github.com/adeyosemanputra/pygoat.git
- Build the docker image from Dockerfile using
docker build -f Dockerfile -t pygoat .
- Run the docker image
docker run --rm -p 8000:8000 pygoat:latest
- Browse to http://127.0.0.1:8000 or http://0.0.0.0:8000
Installation video
- From Source using
installer.sh
- Without using
installer.sh
Uninstallation
On Debian/Ubuntu Based Systems
-
On Debian/Ubuntu based systems, you can use the
uninstaller.sh
script to uninstallpygoat
along with all it's dependencies. -
To uninstall
pygoat
, simply run:
bash ./uninstaller.sh
On Other Systems
-
On other systems, you can use the
uninstaller.py
script to uninstallpygoat
along with all it's dependencies -
To uninstall
pygoat
, simply run:
python3 uninstaller.py
Solutions
Contributors ✨
Thanks goes to these wonderful people (emoji key):
pwned-17 💻 |
Aman Singh 💻 |
adeyosemanputra 💻 📖 |
gaurav618618 💻 📖 |
MajAK 💻 |
JustinPerkins 💻 |
Liu Peng 💻 |
Metaphor 💻 |
whokilleddb 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!