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.

Contributor’s Guide

This guide will guide you through the process of either contributing to harp, or extending it with your own apps.

Harp development process heavily depends on containers, you should have a working docker environment first.

• Introduction
• Applications
  • Overview
  • Concepts
  • Guides
• Storage
  • Model
  • Protocol
• Dashboard
  • Unit Tests
  • End-to-End Tests
  • Recipes
• Testing
  • Database-related tests
• Releasing
  • Chores before releasing
  • Releasing a new source version
  • Releasing as a Python Package

Releases, Changes and Roadmap

• Changelogs
  • Version 0.5.0 (2024-06-16)
  • Version 0.4.0 (2024-01-21)
  • Version 0.3.2 (2024-01-02)
  • Version 0.3.1 (2023-12-27)
  • Version 0.3.0 (2023-12-27)
  • Version 0.2.3 (2023-12-18)
  • Version 0.2.2 (2023-12-18)
  • Version 0.2.1 (2023-12-16)
  • Version 0.2.0 (2023-12-15)
  • Version 0.1.3
• Roadmap
  • Version 0.3 (2023-12-15)
  • Version 0.4 (2023-01-12)
  • Version 0.5 (2024-01-26)
  • Version 0.6 (2024-02-09)
  • Version 0.7 (2024-02-23)
• Ideas

Todo

move changelog to root, it’ for more people than contributors, no need to hide it here.