Getting Started

This guide contains eveything you need to download install and run HARP Proxy.

Note

If you’re looking for help with using the dashboard, you may be looking for the User Guide.

• Quick start
  • Installation
  • First glance
  • Next steps

Installation

Several options exist to install HARP Proxy on your development machine.

The easiest and most reliable method is using (docker) containers, ensuring you have the exact set of dependencies, including the system, that we have battle-tested.

For advanced users and fellow pythonistas, you can choose to install from PyPI, using pip. This method is more flexible but requires a working Python environment and some knowledge of Python.

If you want to extend or contribute to HARP, consider installing from sources.

---

Contents

• Docker & Docker Compose
  • Download the image
  • Start a proxy
  • Use docker compose
• Python & PIP
  • Install with PIP
  • Start a proxy
• Sources

What next?

Once you’re able to successfully run the proxy, you may want to head over to the Configuration section of the Operator Guide.

You can also jump to one of the following guides:

Start Guide Install and run your first proxy. Quick start Using Docker Using Python From Sources
Features Guide Discover HARP Proxy, feature by feature. Configuration Proxy Cache Circuit Breaker Probes Audit Log Rules Engine
User’s Guide Explore the user interface. Overview Transactions System Performances	Operator’s Guide Configure and watch. Configuration Run
Developer’s Guide Enhance and extend. Run Customize Extend	Contributor’s Guide Dive in the internals. Introduction Overview Dependency Injection Event Dispatcher Application Protocol
Reference Exhaustive reference list and description of commands, functions, classes, settings, etc. Core Reference Applications Reference Configuration Reference Command Line Reference