v1.0

README.md

@@ -0,0 +1,38 @@
+![](img/pyrasp-agent.png)
+
+<p>
+    <img src="https://img.shields.io/badge/Version-1.0-green?style=for-the-badge" alt="version 1.0"/>
+    <a href="https://www.paracyberbellum.io">
+        <img src="https://img.shields.io/badge/A%20project%20by-ParaCyberBellum-blue?style=for-the-badge" alt="A project by ParaCyberBellum"/>
+    </a>
+    <a href="https://twitter.com/ParaCyberBellum">
+        <img src="https://img.shields.io/badge/Twitter-@ParaCyberBellum-yellow?style=for-the-badge&color=666666" alt="@ParaCyberBellum on Twitter"/>
+    </a>
+</p>
+
+# The Zero-Trust Agent for PyRASP
+
+> The agent is a browser plugin currently available only for Chromium-based browsers.
+
+## Installation
+1. Download unpacked version from [https://github.com/rbidou/pyrasp-agent](https://github.com/rbidou/pyrasp-agent)
+2. Go to the `chrome://extensions` or `edge://extensions` page
+3. Enable **Developper mode**
+4. Click **Load unpacked** button
+5. Select the directory where the unpacked agent was downloaded
+6. Agent is installed
+
+## Configuration
+To configure the agent:
+1. Click on the agent icon, greyed until configuration is set
+2. Enter the header name, application hostname (and port if non-standard) or URL, and the secret key
+3. Click the **Update ZTAA Settings** button
+4. Agent icon turns to blue
+
+# PyRASP Documentation
+[Full documentation](https://paracyberbellum.gitbook.io/pyrasp)
+<br>[Release Notes](https://github.com/rbidou/pyrasp/blob/main/RELEASE-NOTES.md)
+<br>[Web Site](https://pyrasp.paracyberbellum.io)
+
+# Contacts
+Renaud Bidou - [email protected]