justin
b6e642da04
The AD password reset endpoint was a poor fit for what people actually need this server for. Replaced with a realistic Zerto post-failover example that's much closer to the project's purpose: - Update DNS A records for failed-over hostnames - Wait for the VM to come up at the DR site - PowerShell-remote into the VM and check / start critical services - Notify Teams with the result The flagship pattern is now: Zerto post-script (curl, fire-and-forget) calls an Async webhook endpoint -> 202 in milliseconds -> Zerto's failover sequence is never blocked. The server runs the actual work in the background, with full output captured in the daily log. A ready-to-use Zerto-side script ships at scripts/examples/zerto-post-failover.ps1 - pure curl.exe (no PowerShell modules), reads the bearer token from a file the ZVM service account can read. The installer now bundles scripts/examples/ alongside docs/ so the example is also available locally at C:\Program Files\WebhookServer\scripts\examples\. Removed: docs/recipes/ad-password-reset.md. Updated: docs/README.md, README.md, the recipe content itself. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
33 lines
1.7 KiB
Markdown
33 lines
1.7 KiB
Markdown
# Webhook Server documentation
|
|
|
|
Webhook Server is a Windows service that runs a script (PowerShell, cmd, or any executable) when an HTTP request hits a URL you choose. It's designed for sysadmins who want to wire a tool like **Zerto pre/post scripts**, GitHub Actions, a monitoring system, or a backup tool into a Windows-side automation step — without writing a custom listener every time.
|
|
|
|
## New here? Start with these
|
|
|
|
1. [Concepts](concepts.md) — five-minute read on what a webhook is and how this server uses one
|
|
2. [Installation](installation.md) — download, install, first endpoint
|
|
3. [Recipe: Zerto failover post-script → DNS + service checks](recipes/zerto-pre-post-scripts.md) — the canonical reason this exists
|
|
|
|
## Topical
|
|
|
|
- [Upgrading](upgrading.md)
|
|
- [Uninstalling](uninstalling.md)
|
|
- [Run As modes — when to use which](runas-modes.md)
|
|
- [Service account & Active Directory](service-account-and-ad.md)
|
|
- [Network & security](network-and-security.md)
|
|
- [Troubleshooting](troubleshooting.md)
|
|
|
|
## Recipes (cookbook style)
|
|
|
|
- [Zerto failover post-script → DNS + service checks](recipes/zerto-pre-post-scripts.md) ← canonical use case
|
|
- [GitHub-style HMAC-signed webhook](recipes/github-style-hmac.md)
|
|
- [Pop UI on the user's desktop](recipes/ui-on-desktop.md)
|
|
|
|
The flagship Zerto recipe also ships with a **ready-to-use Zerto-side post-script** at [`scripts/examples/zerto-post-failover.ps1`](../scripts/examples/zerto-post-failover.ps1).
|
|
|
|
## Reference
|
|
|
|
- [GitHub repo](https://github.com/recklessop/webhook-server)
|
|
- [Latest release](https://github.com/recklessop/webhook-server/releases/latest)
|
|
- [Issue tracker](https://github.com/recklessop/webhook-server/issues)
|