diff --git a/site/content/docs/_index.md b/site/content/docs/_index.md index eae992274..6e8209a6e 100644 --- a/site/content/docs/_index.md +++ b/site/content/docs/_index.md @@ -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 diff --git a/site/content/docs/hud/_index.md b/site/content/docs/hud/_index.md new file mode 100644 index 000000000..a1db2de24 --- /dev/null +++ b/site/content/docs/hud/_index.md @@ -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 + + diff --git a/site/content/docs/hud/getting-started.md b/site/content/docs/hud/getting-started.md new file mode 100644 index 000000000..0633839f0 --- /dev/null +++ b/site/content/docs/hud/getting-started.md @@ -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.