Skip to content

SUPPORT.md

Latest commit

 

History

History
84 lines (59 loc) · 3.11 KB

SUPPORT.md

File metadata and controls

84 lines (59 loc) · 3.11 KB
Raw

Support

PatchPanel is maintained by a single person with limited time. Most help flows through GitHub. This document outlines what to use, what to expect, and what's out of scope.

Where to ask

Bugs and feature requests

GitHub Issues — use the appropriate template (bug report, feature request, question). Search first.

For a bug report, include:

  • Deployment surface (Home Assistant add-on or standalone Debian package)
  • PatchPanel version, HAProxy version, Node.js version, Debian/Ubuntu/HAOS version
  • Reproduction steps with expected vs. actual behaviour
  • The relevant chunk of audit log + journalctl -u patchpanel (or HA add-on log)
  • A sanitized copy of your state.json (or haproxy.cfg) when the bug is config-shaped

Questions and discussion

GitHub Discussions — ask before opening an issue if you're not sure something is a bug.

Security vulnerabilities

Do not open a public issue. See SECURITY.md for the private reporting flow.

Documentation

  • Architecture — components, data flow, the render-validate-swap loop
  • API reference — OpenAPI spec, interactive Swagger UI
  • Releases — download the latest .deb, view the changelog
  • README — install steps for both deployment surfaces

Response expectations

This is a side-project. Realistic timelines:

  • Bug acknowledgement: a few days
  • Critical security issue: highest priority, days
  • Stability bug: high priority, 1–2 weeks
  • Feature request: evaluated against current scope; may not land
  • Documentation fix: usually merged quickly

PRs move faster than issues. If you can fix it, please do — see CONTRIBUTING.md.

Out of scope

  • Bespoke development or one-on-one consulting
  • Forks and modified builds — please reproduce the bug on a clean install of the published .deb or add-on before reporting
  • Integration work for third-party billing/monitoring/orchestration systems beyond what the documented API already supports
  • 24/7 emergency response

Upstream resources

PatchPanel renders config for, but does not replace, HAProxy. For questions about HAProxy's directive semantics, runtime API, or expected behaviour, go to the source:

For ACME / Let's Encrypt issues (rate limits, DNS-01 plugin specifics, EAB credentials):

For the add-on surface specifically: