Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add HUD documentation #2158

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions site/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ groups:
link: /docs/constants/
desc: defined in the ZAP codebase that are exposed via the API and/or scripts

- name: 'Heads Up Display (HUD)'
link: /docs/hud/
desc: detailed information on the HUD

- name: 'Internal Events'
link: /docs/internal-events/
desc: detailed information on the internal events ZAP publishes
Expand Down
16 changes: 16 additions & 0 deletions site/content/docs/hud/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "ZAP HUD"
type: page
layout: links
links:
- name: 'Getting Started'
link: getting-started/
desc: a good place to start if you are new to ZAP's HUD
- name: 'Using the HUD'
link: using-the-hud/
desc: a guide to using the HUD
---

Welcome to the ZAP HUD (Heads Up Display) documentation. With the HUD, you can use your favorite ZAP features, right in the browser. Following are the links that explain various areas of HUD


17 changes: 17 additions & 0 deletions site/content/docs/hud/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Getting Started"
---


The HUD is an extension to ZAP, so to run the HUD you need to first start ZAP. There are two ways to start ZAP:
1. Run from HUD directory with gradle

```
git clone https://github.com/zaproxy/zap-hud.git
cd zap-hud
./gradlew runZap
```

2. Download ZAP from https://www.zaproxy.org/download/

After starting ZAP press "Manually Explore", make sure the "Enable HUD" checkbox is checked, and press "Start Browsing" to launch a browser with the HUD enabled.
Loading