Attention

This is the documentation for HARP Proxy, actually published as an early preview. Both the software and documentation are a work in progress, and although we already use it on various production servers, they may contain inaccuracies, typographical errors, huge mistakes and empty pages. We work hard to eradicate all mistakes and implement stuff, but it is a long and tedious process. We appreciate your patience and understanding. Of course, any help will be greatly appreciated.

Getting Started

This guide contains eveything you need to get started using the software, from a technical point of view. If you just want to use the dashboard, you may be looking for the User’s Guide.

• Quick start
  • Installation
  • First glance
  • Next steps

Installation

A few different options to install harp on your development machine exist. The most reliable installation method is to use containers, as it ensures you have the very exact set of dependencies, including the system, that we battle tested. It also have the advantage of not requiring a python enviroment, nor python knowledge.

For advanced users and fellow pythonistas, you can use pip. But maybe, you’ll prefer containers too.

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

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