Documentation

Everything about vouchfx's opt-in telemetry.

These pages are rendered straight from the repository's markdown on every push, so they never drift from the service they describe.

For users

Should you opt in, what is collected, and your rights over your own data.

START

Why telemetry, and how to opt in

What is (and is never) collected, how to enable/disable, the local outbox, and the fail-silent guarantee.

POLICY

Privacy policy & data handling

The authoritative home of the 90-day retention window and the 30-day deletion commitment.

Reference

The frozen HTTP contract and the system design behind it.

API

Wire contract

The /v1/telemetry and /v1/telemetry/forget endpoints, the allowlisted TelemetryEvent schema, dedup and rate limiting.

DESIGN

Architecture & system design

The five-component service, the partitioned PostgreSQL schema, and the Azure infrastructure topology.

Operating

Running a backend — on Azure, or anywhere else.

RUNBOOK

Operations runbook (Azure pilot)

Deployment via Bicep, GitHub Actions secrets, configuration reference, monitoring, and troubleshooting.

GUIDE

Self-hosting without Azure

Docker, Docker Compose, and Kubernetes examples — bring your own PostgreSQL 16 and point the engine at it.

Project

How this repository is run.

README

Repository README

What the backend is, the repository layout, and the local build & test commands.

HOW

Contributing

Where discussion belongs, the quality bar, and the two load-bearing contracts that change only deliberately.

SEC

Security policy

How to report a suspected vulnerability — always via private reporting, never a public issue.

CoC

Code of conduct

The standards this community holds itself to.

Ecosystem

This is the server half of a two-repository system, alongside the community provider hub and the sample applications.

Live: vouchfx engine v1.0.0-alpha.9 · Vouchfx.Sdk 1.0.0-alpha.9 · community providers listed in the hub registry: 1 (latest: Vouchfx.Community.JsonRpc 1.0.0-alpha.1).

ENGINE