{% extends "base.html" %} {% block title %}Help — BackupWatch{% endblock %} {% block main_class %}help3{% endblock %} {% block content %} {# ponytail: the full reference lives at help.backupwatch.app (Docs Site/ in the repo) — this page is a compact launcher: overview, guide links, and the five most common quick fixes. #} {% set HELP = "https://help.backupwatch.app" %}
USER GUIDE · V{{ APP_VERSION }}

Help

Open the full guide ↗

What BackupWatch does

BackupWatch watches the mailbox that receives your backup-notification emails — Veeam, DropSuite and others — and turns that inbox into a live dashboard of every client's backups. Each email is matched to a client and job, its status read automatically, and failures or missed backups trigger an alert; anything unrecognised waits in the Review queue for a human.

The full documentation lives at help.backupwatch.app — setup walkthroughs, a settings reference, and how the matching engine thinks.

New here since your last update? See what's changed — the release notes for v{{ APP_VERSION }} and every version before it.

Guides

Getting started
The setup wizard, and the guided path from empty to monitored.
Connecting your mailbox
Microsoft 365 (Azure app), Google Apps, or IMAP.
Alerts & notifications
Recipients, daily summary, watchdog — and outbound email via SMTP or the mailbox itself.
Clients & jobs
Email identifiers, schedules, grace windows and missed detection.
How matching works
Manual vs learned rules, ties, vendor detection, Test matching.
Review & learning
Triage batches, bulk actions, undo, and ignore rules.
Users & access
Roles, invites, client scoping, and password resets.
Settings reference
Every settings tab explained, including backup & restore and licence.
Operations
Reading the dashboard, mute & acknowledge, NOC display mode, audit log.
Best practices
Habits that keep the Review queue quiet and alerts honest.

Quick fixes

Nothing in the Review queue Only unread mail is imported — mark the test email unread, then Settings → Mailbox → Check mailbox now.
"Mailbox error" banner Settings → Mailbox → Test mailbox connection — a successful test clears it.
Alerts aren't arriving Settings → Notifications → Send test email, and check recipients and immediate alerts.
Email matched the wrong job Rules → Test matching shows exactly why — manual rules are AND, learned rules are OR.
Locked out entirely On the server: python -m app.reset_password you@example.com.
More troubleshooting ↗
{% endblock %}