README.md
#  OWASP Juice Shop
[](https://owasp.org/projects/#sec-flagships)
[](https://github.com/juice-shop/juice-shop/releases/latest)
[](https://twitter.com/owasp_juiceshop)
[](https://reddit.com/r/owasp_juiceshop)
[](https://codeclimate.com/github/juice-shop/juice-shop/test_coverage)
[](https://codeclimate.com/github/juice-shop/juice-shop/maintainability)
[](https://codeclimate.com/github/juice-shop/juice-shop/trends/technical_debt)
[](https://dashboard.cypress.io/projects/3hrkhu/runs)
[](https://www.bestpractices.dev/projects/223)
[](CODE_OF_CONDUCT.md)
> [The most trustworthy online shop out there.](https://twitter.com/dschadow/status/706781693504589824)
> ([@dschadow](https://github.com/dschadow)) —
> [The best juice shop on the whole internet!](https://twitter.com/shehackspurple/status/907335357775085568)
> ([@shehackspurple](https://twitter.com/shehackspurple)) —
> [Actually the most bug-free vulnerable application in existence!](https://youtu.be/TXAztSpYpvE?t=26m35s)
> ([@vanderaj](https://twitter.com/vanderaj)) —
> [First you 😂😂then you 😢](https://twitter.com/kramse/status/1073168529405472768)
> ([@kramse](https://twitter.com/kramse)) —
> [But this doesn't have anything to do with juice.](https://twitter.com/coderPatros/status/1199268774626488320)
> ([@coderPatros' wife](https://twitter.com/coderPatros))
OWASP Juice Shop is probably the most modern and sophisticated insecure web application! It can be used in security
trainings, awareness demos, CTFs and as a guinea pig for security tools! Juice Shop encompasses vulnerabilities from the
entire
[OWASP Top Ten](https://owasp.org/www-project-top-ten) along with many other security flaws found in real-world
applications!
For a detailed introduction, full list of features and architecture overview please visit the official project page:
<https://owasp-juice.shop>
## Table of contents
- [Setup](#setup)
- [From Sources](#from-sources)
- [Packaged Distributions](#packaged-distributions)
- [Docker Container](#docker-container)
- [Vagrant](#vagrant)
- [Amazon EC2 Instance](#amazon-ec2-instance)
- [Azure Container Instance](#azure-container-instance)
- [Google Compute Engine Instance](#google-compute-engine-instance)
- [Heroku](#heroku)
- [Gitpod](#gitpod)
- [Demo](#demo)
- [Documentation](#documentation)
- [Node.js version compatibility](#nodejs-version-compatibility)
- [Troubleshooting](#troubleshooting)
- [Official companion guide](#official-companion-guide)
- [Contributing](#contributing)
- [References](#references)
- [Merchandise](#merchandise)
- [Donations](#donations)
- [Contributors](#contributors)
- [Licensing](#licensing)
## Setup
> You can find some less common installation variations in
> [the _Running OWASP Juice Shop_ documentation](https://pwning.owasp-juice.shop/companion-guide/latest/part1/running.html).
### From Sources
1. Install [node.js](#nodejs-version-compatibility)
2. Run `git clone https://github.com/juice-shop/juice-shop.git --depth 1` (or
clone [your own fork](https://github.com/juice-shop/juice-shop/fork)
of the repository)
3. Go into the cloned folder with `cd juice-shop`
4. Run `npm install` (only has to be done before first start or when you change the source code)
5. Run `npm start`
6. Browse to <http://localhost:3000>
### Packaged Distributions
[](https://github.com/juice-shop/juice-shop/releases/latest)
[](https://sourceforge.net/projects/juice-shop/)
[](https://sourceforge.net/projects/juice-shop/)
1. Install a 64bit [node.js](#nodejs-version-compatibility) on your Windows, MacOS or Linux machine
2. Download `juice-shop-<version>_<node-version>_<os>_x64.zip` (or
`.tgz`) attached to
[latest release](https://github.com/juice-shop/juice-shop/releases/latest)
3. Unpack and `cd` into the unpacked folder
4. Run `npm start`
5. Browse to <http://localhost:3000>
> Each packaged distribution includes some binaries for `sqlite3` and
> `libxmljs` bound to the OS and node.js version which `npm install` was
> executed on.
### Docker Container
[](https://hub.docker.com/r/bkimminich/juice-shop)
[](https://microbadger.com/images/bkimminich/juice-shop
"Get your own image badge on microbadger.com")
[](https://microbadger.com/images/bkimminich/juice-shop
"Get your own version badge on microbadger.com")
1. Install [Docker](https://www.docker.com)
2. Run `docker pull bkimminich/juice-shop`
3. Run `docker run --rm -p 127.0.0.1:3000:3000 bkimminich/juice-shop`
4. Browse to <http://localhost:3000> (on macOS and Windows browse to
<http://192.168.99.100:3000> if you are using docker-machine instead of the native docker installation)
### Vagrant
1. Install [Vagrant](https://www.vagrantup.com/downloads.html) and
[Virtualbox](https://www.virtualbox.org/wiki/Downloads)
2. Run `git clone https://github.com/juice-shop/juice-shop.git` (or
clone [your own fork](https://github.com/juice-shop/juice-shop/fork)
of the repository)
3. Run `cd vagrant && vagrant up`
4. Browse to [192.168.56.110](http://192.168.56.110)
### Amazon EC2 Instance
1. In the _EC2_ sidenav select _Instances_ and click _Launch Instance_
2. In _Step 1: Choose an Amazon Machine Image (AMI)_ choose an _Amazon Linux AMI_ or _Amazon Linux 2 AMI_
3. In _Step 3: Configure Instance Details_ unfold _Advanced Details_ and copy the script below into _User Data_
4. In _Step 6: Configure Security Group_ add a _Rule_ that opens port 80 for HTTP
5. Launch your instance
6. Browse to your instance's public DNS
```
#!/bin/bash
yum update -y
yum install -y docker
service docker start
docker pull bkimminich/juice-shop
docker run -d -p 80:3000 bkimminich/juice-shop
```
### Azure Container Instance
1. Open and login (via `az login`) to your
[Azure CLI](https://azure.github.io/projects/clis/) **or** login to the [Azure Portal](https://portal.azure.com),
open the _CloudShell_
and then choose _Bash_ (not PowerShell).
2. Create a resource group by running `az group create --name <group name> --location <location name, e.g. "centralus">`
3. Create a new container by
running `az container create --resource-group <group name> --name <container name> --image bkimminich/juice-shop --dns-name-label <dns name label> --ports 3000 --ip-address public`
4. Your container will be available at `http://<dns name label>.<location name>.azurecontainer.io:3000`
### Google Compute Engine Instance
1. Login to the Google Cloud Console and
[open Cloud Shell](https://console.cloud.google.com/home/dashboard?cloudshell=true).
2. Launch a new GCE instance based on the juice-shop container. Take note of the `EXTERNAL_IP` provided in the output.
```
gcloud compute instances create-with-container owasp-juice-shop-app --container-image bkimminich/juice-shop
```
3. Create a firewall rule that allows inbound traffic to port 3000
```
gcloud compute firewall-rules create juice-rule --allow tcp:3000
```
4. Your container is now running and available at
`http://<EXTERNAL_IP>:3000/`
### Heroku
1. [Sign up to Heroku](https://signup.heroku.com/) and
[log in to your account](https://id.heroku.com/login)
2. Click the button below and follow the instructions
[](https://heroku.com/deploy)
If you have forked the Juice Shop repository on GitHub, the _Deploy to
Heroku_ button will deploy your forked version of the application.
## Demo
Feel free to have a look at the latest version of OWASP Juice Shop:
<http://demo.owasp-juice.shop>
> This is a deployment-test and sneak-peek instance only! You are __not
> supposed__ to use this instance for your own hacking endeavours! No
> guaranteed uptime! Guaranteed stern looks if you break it!
## Documentation
### Node.js version compatibility
OWASP Juice Shop officially supports the following versions of
[node.js](http://nodejs.org) in line with the official
[node.js LTS schedule](https://github.com/nodejs/LTS) as close as possible. Docker images and packaged distributions are
offered accordingly.
| node.js | Supported | Tested | [Packaged Distributions](#packaged-distributions) | [Docker images](#docker-container) from `master` | [Docker images](#docker-container) from `develop` |
|:--------|:------------------------|:----------------------------------------------------------|:--------------------------------------------------|:-------------------------------------------------|:--------------------------------------------------|
| 22.x | :x: | :x: | | | |
| 21.x | ( :heavy_check_mark: ) | :heavy_check_mark: | Windows (`x64`), MacOS (`x64`), Linux (`x64`) | | |
| 20.x | :heavy_check_mark: | :heavy_check_mark: | Windows (`x64`), MacOS (`x64`), Linux (`x64`) | `latest` (`linux/amd64`, `linux/arm64`) | `snapshot` (`linux/amd64`, `linux/arm64`) |
| 20.6.0 | :x: | :bug: https://github.com/angular/angular-cli/issues/25782 | | | |
| 19.x | ( :heavy_check_mark: ) | :x: | | | |
| 18.x | :heavy_check_mark: | :heavy_check_mark: | Windows (`x64`), MacOS (`x64`), Linux (`x64`) | | |
| <18.x | :x: | :x: | | | |
Juice Shop is automatically tested _only on the latest `.x` minor version_ of each node.js version mentioned above!
There is no guarantee that older minor node.js releases will always work with Juice Shop!
Please make sure you stay up to date with your chosen version.
### Troubleshooting
[](https://gitter.im/bkimminich/juice-shop)
If you need help with the application setup please check our
[our existing _Troubleshooting_](https://pwning.owasp-juice.shop/appendix/troubleshooting.html)
guide. If this does not solve your issue please post your specific problem or question in the
[Gitter Chat](https://gitter.im/bkimminich/juice-shop) where community members can best try to help you.
:stop_sign: **Please avoid opening GitHub issues for support requests or questions!**
### Official companion guide
[](https://www.goodreads.com/review/edit/49557240)
OWASP Juice Shop comes with an official companion guide eBook. It will give you a complete overview of all
vulnerabilities found in the application including hints how to spot and exploit them. In the appendix you will even
find complete step-by-step solutions to every challenge. Extensive documentation of
[custom re-branding](https://pwning.owasp-juice.shop/part1/customization.html),
[CTF-support](https://pwning.owasp-juice.shop/part1/ctf.html),
[trainer's guide](https://pwning.owasp-juice.shop/appendix/trainers.html)
and much more is also included.
[Pwning OWASP Juice Shop](https://leanpub.com/juice-shop) is published under
[CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)
and is available **for free** in PDF, Kindle and ePub format on LeanPub. You can also
[browse the full content online](https://pwning.owasp-juice.shop)!
[<img alt="Pwning OWASP Juice Shop cover" src="https://raw.githubusercontent.com/juice-shop/pwning-juice-shop/master/docs/modules/ROOT/assets/images/cover.jpg" width="200"/>](https://leanpub.com/juice-shop)
[<img alt="Pwning OWASP Juice Shop back cover" src="https://raw.githubusercontent.com/juice-shop/pwning-juice-shop/master/docs/modules/ROOT/assets/images/introduction/back.jpg" width="200"/>](https://leanpub.com/juice-shop)
## Contributing
[](https://github.com/juice-shop/juice-shop/graphs/contributors)
[](http://standardjs.com/)
[](https://crowdin.com/project/owasp-juice-shop)
We are always happy to get new contributors on board! Please check
[CONTRIBUTING.md](CONTRIBUTING.md) to learn how to
[contribute to our codebase](CONTRIBUTING.md#code-contributions) or the
[translation into different languages](CONTRIBUTING.md#i18n-contributions)!
## References
Did you write a blog post, magazine article or do a podcast about or mentioning OWASP Juice Shop? Or maybe you held or
joined a conference talk or meetup session, a hacking workshop or public training where this project was mentioned?
Add it to our ever-growing list of [REFERENCES.md](REFERENCES.md) by forking and opening a Pull Request!
## Merchandise
* On [Spreadshirt.com](http://shop.spreadshirt.com/juiceshop) and
[Spreadshirt.de](http://shop.spreadshirt.de/juiceshop) you can get some swag (Shirts, Hoodies, Mugs) with the official
OWASP Juice Shop logo
* On
[StickerYou.com](https://www.stickeryou.com/products/owasp-juice-shop/794)
you can get variants of the OWASP Juice Shop logo as single stickers to decorate your laptop with. They can also print
magnets, iron-ons, sticker sheets and temporary tattoos.
The most honorable way to get some stickers is to
[contribute to the project](https://pwning.owasp-juice.shop/part3/contribution.html)
by fixing an issue, finding a serious bug or submitting a good idea for a new challenge!
We're also happy to supply you with stickers if you organize a meetup or conference talk where you use or talk about or
hack the OWASP Juice Shop! Just
[contact the mailing list](mailto:owasp_juice_shop_project@lists.owasp.org)
or [the project leader](mailto:bjoern.kimminich@owasp.org) to discuss your plans!
## Donations
[](https://owasp.org/donate/?reponame=www-project-juice-shop&title=OWASP+Juice+Shop)
The OWASP Foundation gratefully accepts donations via Stripe. Projects such as Juice Shop can then request reimbursement
for expenses from the Foundation. If you'd like to express your support of the Juice Shop project, please make sure to
tick the "Publicly list me as a supporter of OWASP Juice Shop" checkbox on the donation form. You can find our more
about donations and how they are used here:
<https://pwning.owasp-juice.shop/part3/donations.html>
## Contributors
The OWASP Juice Shop core project team are:
- [Björn Kimminich](https://github.com/bkimminich) aka `bkimminich`
([Project Leader](https://www.owasp.org/index.php/Projects/Project_Leader_Responsibilities))
[](https://keybase.io/bkimminich)
- [Jannik Hollenbach](https://github.com/J12934) aka `J12934`
- [Timo Pagel](https://github.com/wurstbrot) aka `wurstbrot`
- [Shubham Palriwala](https://github.com/ShubhamPalriwala) aka `ShubhamPalriwala`
For a list of all contributors to the OWASP Juice Shop please visit our
[HALL_OF_FAME.md](HALL_OF_FAME.md).
## Licensing
[](LICENSE)
This program is free software: you can redistribute it and/or modify it under the terms of the [MIT license](LICENSE).
OWASP Juice Shop and any contributions are Copyright © by Bjoern Kimminich & the OWASP Juice Shop contributors
2014-2024.
