|
1 |
| -# Python_Example |
2 |
| -Intentionally vuln web Application Security in django. our roadmap build intentionally vuln web Application in django. The Vulnerability can based on OWASP top ten |
| 1 | +# PyGoat |
| 2 | +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
| 3 | +[](#contributors-) |
| 4 | +<!-- ALL-CONTRIBUTORS-BADGE:END --> |
| 5 | + |
| 6 | +intentionally vuln web Application Security in django. |
| 7 | +our roadmap build intentionally vuln web Application in django. The Vulnerability can based on OWASP top ten |
| 8 | +<br> |
| 9 | + |
| 10 | +Table of Contents |
| 11 | +================= |
| 12 | + |
| 13 | +* [pygoat](#pygoat) |
| 14 | + * [Installation](#installation) |
| 15 | + * [From Sources](#from-sources) |
| 16 | + * [Docker Container](#docker-container) |
| 17 | + * [Installation Video](#installation-video) |
| 18 | + * [Uninstallation](#uninstallation) |
| 19 | + * [Solutions](/Solutions/solution.md) |
| 20 | + * [For Developers](/docs/dev_guide.md) |
| 21 | + |
| 22 | +## Installation |
| 23 | + |
| 24 | +### From Sources |
| 25 | + |
| 26 | +To setup the project on your local machine: |
| 27 | +<br> |
| 28 | + |
| 29 | +First, Clone the repository using GitHub website or git in Terminal |
| 30 | +``` |
| 31 | + git clone https://github.com/adeyosemanputra/pygoat.git |
| 32 | + ### To Download a specific branch |
| 33 | + git clone -b <branch_name> https://github.com/adeyosemanputra/pygoat.git |
| 34 | +``` |
| 35 | + |
| 36 | +#### Method 1 |
| 37 | + |
| 38 | +1. Install all app and python requirements using installer file - `bash installer.sh` |
| 39 | +2. Apply the migrations `python3 manage.py migrate`.<br> |
| 40 | +3. Finally, run the development server `python3 manage.py runserver`.<br> |
| 41 | +4. The project will be available at <http://127.0.0.1:8000> |
| 42 | + |
| 43 | +#### Method 2 |
| 44 | + |
| 45 | +1. Install python3 requirements `pip install -r requirements.txt`.<br> |
| 46 | +2. Apply the migrations `python3 manage.py migrate`.<br> |
| 47 | +3. Finally, run the development server `python3 manage.py runserver`.<br> |
| 48 | +4. The project will be available at <http://127.0.0.1:8000> |
| 49 | + |
| 50 | +#### Method 3 |
| 51 | + |
| 52 | +1. Install all app and python requirements using `setup.py` file - `pip3 install .` |
| 53 | +2. Apply the migrations `python3 manage.py migrate`.<br> |
| 54 | +3. Finally, run the development server `python3 manage.py runserver`.<br> |
| 55 | +4. The project will be available at <http://127.0.0.1:8000> |
| 56 | + |
| 57 | +### Docker Container |
| 58 | +1. Install [Docker](https://www.docker.com) |
| 59 | +2. Run `docker pull pygoat/pygoat` or `docker pull pygoat/pygoat:latest` |
| 60 | +3. Run `docker run --rm -p 8000:8000 pygoat/pygoat:latest` |
| 61 | +4. Browse to <http://127.0.0.1:8000> |
| 62 | +5. Remove existing image using `docker image rm pygoat/pygoat` and pull again incase of any error |
| 63 | + |
| 64 | +### From Docker-Compose |
| 65 | +1. Install [Docker](https://www.docker.com) |
| 66 | +2. Run `docker-compose up` or `docker-compose up -d` |
| 67 | + |
| 68 | +### Build Docker Image and Run |
| 69 | +1. Clone the repository   `git clone https://github.com/adeyosemanputra/pygoat.git` |
| 70 | +2. Build the docker image from Dockerfile using   `docker build -f Dockerfile -t pygoat .` |
| 71 | +3. Run the docker image  `docker run --rm -p 8000:8000 pygoat:latest` |
| 72 | +4. Browse to <http://127.0.0.1:8000> or <http://0.0.0.0:8000> |
| 73 | + |
| 74 | +### Installation video |
| 75 | + |
| 76 | +1. From Source using `installer.sh` |
| 77 | + - [Installing PyGoat from Source](https://www.youtube.com/watch?v=7bYBJXG3FRQ) |
| 78 | +2. Without using `installer.sh` |
| 79 | + - [](http://www.youtube.com/watch?v=rfzQiMeiwso "Installation Pygoat") |
| 80 | +3. Install with Mac M1 (using Virtualenv) |
| 81 | + - [](https://youtu.be/a5UV7mUw580 "Install with Mac M1 - using Virtualenv") |
| 82 | + |
| 83 | + |
| 84 | +## Uninstallation |
| 85 | + |
| 86 | +### On Debian/Ubuntu Based Systems |
| 87 | +- On Debian/Ubuntu based systems, you can use the `uninstaller.sh` script to uninstall `pygoat` along with all it's dependencies. |
| 88 | +- To uninstall `pygoat`, simply run: |
| 89 | +```bash |
| 90 | +$ bash ./uninstaller.sh |
| 91 | +``` |
| 92 | + |
| 93 | +### On Other Systems |
| 94 | +- On other systems, you can use the `uninstaller.py` script to uninstall `pygoat` along with all it's dependencies |
| 95 | +- To uninstall `pygoat`, simply run: |
| 96 | +```bash |
| 97 | +$ python3 uninstaller.py |
| 98 | +``` |
| 99 | + |
| 100 | +## Solutions |
| 101 | +<a href="/Solutions/solution.md">Solutions to all challenges</a> |
| 102 | + |
| 103 | +## Contributors ✨ |
| 104 | + |
| 105 | +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): |
| 106 | + |
| 107 | +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
| 108 | +<!-- prettier-ignore-start --> |
| 109 | +<!-- markdownlint-disable --> |
| 110 | +<table> |
| 111 | + <tr> |
| 112 | + <td align="center"><a href="https://github.com/pwned-17"><img src="https://avatars.githubusercontent.com/u/61360833?v=4?s=100" width="100px;" alt=""/><br /><sub><b>pwned-17</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=pwned-17" title="Code">💻</a></td> |
| 113 | + <td align="center"><a href="https://github.com/prince-7"><img src="https://avatars.githubusercontent.com/u/53997924?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aman Singh</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=prince-7" title="Code">💻</a></td> |
| 114 | + <td align="center"><a href="https://github.com/adeyosemanputra"><img src="https://avatars.githubusercontent.com/u/24958168?v=4?s=100" width="100px;" alt=""/><br /><sub><b>adeyosemanputra</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=adeyosemanputra" title="Code">💻</a> <a href="https://github.com/adeyosemanputra/pygoat/commits?author=adeyosemanputra" title="Documentation">📖</a></td> |
| 115 | + <td align="center"><a href="https://github.com/gaurav618618"><img src="https://avatars.githubusercontent.com/u/29380890?v=4?s=100" width="100px;" alt=""/><br /><sub><b>gaurav618618</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=gaurav618618" title="Code">💻</a> <a href="https://github.com/adeyosemanputra/pygoat/commits?author=gaurav618618" title="Documentation">📖</a></td> |
| 116 | + <td align="center"><a href="https://github.com/kUSHAL0601"><img src="https://avatars.githubusercontent.com/u/29600964?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MajAK</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=kUSHAL0601" title="Code">💻</a></td> |
| 117 | + <td align="center"><a href="https://github.com/JustinDPerkins"><img src="https://avatars.githubusercontent.com/u/60413733?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JustinPerkins</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=JustinDPerkins" title="Code">💻</a></td> |
| 118 | + <td align="center"><a href="https://github.com/Hkakashi"><img src="https://avatars.githubusercontent.com/u/43193113?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Liu Peng</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=Hkakashi" title="Code">💻</a></td> |
| 119 | + </tr> |
| 120 | + <tr> |
| 121 | + <td align="center"><a href="https://github.com/RupakBiswas-2304"><img src="https://avatars.githubusercontent.com/u/75058161?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Metaphor</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=RupakBiswas-2304" title="Code">💻</a></td> |
| 122 | + <td align="center"><a href="https://whokilleddb.github.io"><img src="https://avatars.githubusercontent.com/u/56482137?v=4?s=100" width="100px;" alt=""/><br /><sub><b>whokilleddb</b></sub></a><br /><a href="https://github.com/adeyosemanputra/pygoat/commits?author=whokilleddb" title="Code">💻</a></td> |
| 123 | + </tr> |
| 124 | +</table> |
| 125 | + |
| 126 | +<!-- markdownlint-restore --> |
| 127 | +<!-- prettier-ignore-end --> |
| 128 | + |
| 129 | +<!-- ALL-CONTRIBUTORS-LIST:END --> |
| 130 | + |
| 131 | +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |
0 commit comments