{% extends "documentation/base.html" %}

{% block doc_content %}
<h1>What is BackupChecks?</h1>

<p class="lead">
  BackupChecks is a backup monitoring and validation system designed to help IT teams
  verify that backups are running successfully across their customer infrastructure.
</p>

<h2>Key Features</h2>

<ul>
  <li><strong>Automated Mail Parsing:</strong> Import backup reports via email and automatically parse results</li>
  <li><strong>API Integrations:</strong> Direct API import for Cove Data Protection (N-able) and Veeam Cloud Connect — no email needed</li>
  <li><strong>Review Workflow:</strong> Review all backup jobs daily and mark them as reviewed (goal: clear the Run Checks queue)</li>
  <li><strong>Customer Management:</strong> Organize backups by customer and manage multiple backup jobs per customer</li>
  <li><strong>Autotask Integration:</strong> Manually create tickets in Autotask PSA for failed backups requiring follow-up</li>
  <li><strong>Reporting:</strong> Generate backup status reports with flexible scheduling</li>
  <li><strong>Role-Based Access:</strong> Admin, Operator, Reporter, and Viewer roles</li>
</ul>

<h2>How It Works</h2>

<p>BackupChecks follows a simple workflow:</p>

<ol>
  <li><strong>Import:</strong> Backup reports are sent via email to a configured mailbox</li>
  <li><strong>Parse:</strong> The system parses email content to extract backup status</li>
  <li><strong>Match:</strong> Reports are matched to configured jobs based on sender, subject, and content</li>
  <li><strong>Review:</strong> Operators review all backup jobs (both successful and failed) and mark them as reviewed to clear the Run Checks queue</li>
  <li><strong>Ticket Creation:</strong> For failed backups requiring follow-up, operators manually create tickets in Autotask PSA</li>
  <li><strong>Report:</strong> Generate periodic reports to track backup health over time</li>
</ol>

<div class="doc-callout doc-callout-tip">
  <strong>💡 Tip:</strong>
  Start with the <a href="{{ url_for('documentation.page', section='getting-started', page='quick-start') }}">Quick Start Checklist</a>
  to get your first customer and job configured.
</div>

<h2>Who Should Use BackupChecks?</h2>

<p>BackupChecks is designed for:</p>

<ul>
  <li><strong>Managed Service Providers (MSPs):</strong> Monitor backups across multiple customer environments</li>
  <li><strong>IT Departments:</strong> Track backup compliance for internal infrastructure</li>
  <li><strong>Backup Administrators:</strong> Centralize backup verification from multiple backup solutions</li>
</ul>

<h2>Supported Backup Software</h2>

<p>BackupChecks ships with the following parsers and API integrations:</p>

<table>
  <thead>
    <tr>
      <th>Source</th>
      <th>Type</th>
      <th>Notes</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Veeam Backup & Replication</td>
      <td>Email parser</td>
      <td>Detailed per-object job results</td>
    </tr>
    <tr>
      <td>Veeam Cloud Connect</td>
      <td>Email parser</td>
      <td>Daily provider report; per-tenant inbox flow</td>
    </tr>
    <tr>
      <td>Cove Data Protection (N-able)</td>
      <td>API integration</td>
      <td>JSON-RPC API; account-based inbox flow + 28-day colorbar history</td>
    </tr>
    <tr>
      <td>NAKIVO Backup & Replication</td>
      <td>Email parser</td>
      <td>Job completion reports</td>
    </tr>
    <tr>
      <td>Synology Active Backup / Hyper Backup</td>
      <td>Email parser</td>
      <td>Task result notifications</td>
    </tr>
    <tr>
      <td>QNAP Hybrid Backup Sync</td>
      <td>Email parser</td>
      <td>Job completion emails</td>
    </tr>
    <tr>
      <td>Syncovery</td>
      <td>Email parser</td>
      <td>Profile result notifications</td>
    </tr>
    <tr>
      <td>BoxAfe (Microsoft 365 backup)</td>
      <td>Email parser</td>
      <td>Tenant-level result reports</td>
    </tr>
    <tr>
      <td>R-Drive Image</td>
      <td>Email parser</td>
      <td>Workstation/server image backup reports</td>
    </tr>
    <tr>
      <td>3CX</td>
      <td>Email parser</td>
      <td>3CX phone system backup notifications</td>
    </tr>
    <tr>
      <td>NTFS Auditing</td>
      <td>Email parser</td>
      <td>File-system audit reports</td>
    </tr>
    <tr>
      <td>Custom / Other</td>
      <td>Manual</td>
      <td>Manual job configuration for non-standard formats</td>
    </tr>
  </tbody>
</table>

<div class="doc-callout doc-callout-warning">
  <strong>⚠️ Important:</strong>
  BackupChecks monitors backup <em>reports</em>, not the backup data itself. Ensure your backup software is configured to send email notifications on job completion.
</div>

<h2>Architecture Overview</h2>

<p>BackupChecks is a web-based application with the following components:</p>

<ul>
  <li><strong>Backend:</strong> Flask (Python) application with PostgreSQL database</li>
  <li><strong>Frontend:</strong> Bootstrap 5 for responsive UI</li>
  <li><strong>Mail Import:</strong> Microsoft Graph API integration for automated email retrieval</li>
  <li><strong>Cove Data Protection:</strong> JSON-RPC API integration with background polling</li>
  <li><strong>Veeam Cloud Connect:</strong> Email-based per-tenant import with separate inbox flow</li>
  <li><strong>Autotask API:</strong> Optional integration for manual ticket creation</li>
  <li><strong>Reporting:</strong> Built-in report generation with scheduling</li>
</ul>

<h2>User Roles</h2>

<p>BackupChecks supports four user roles with different permissions:</p>

<table>
  <thead>
    <tr>
      <th>Role</th>
      <th>Permissions</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><strong>Admin</strong></td>
      <td>Full access to all features, settings, and configuration</td>
    </tr>
    <tr>
      <td><strong>Operator</strong></td>
      <td>Can review and approve backups, manage customers and jobs, create tickets</td>
    </tr>
    <tr>
      <td><strong>Reporter</strong></td>
      <td>Can view and generate reports, no access to operational features</td>
    </tr>
    <tr>
      <td><strong>Viewer</strong></td>
      <td>Read-only access to customers, jobs, and reports</td>
    </tr>
  </tbody>
</table>

<div class="doc-callout doc-callout-info">
  <strong>💡 Note:</strong>
  Users can be assigned multiple roles and can switch between them using the role selector in the navigation bar.
</div>

<h2>Next Steps</h2>

<p>Ready to get started? Continue to:</p>

<ul>
  <li><a href="{{ url_for('documentation.page', section='getting-started', page='first-login') }}">First Login & Dashboard</a> - Learn about the dashboard interface</li>
  <li><a href="{{ url_for('documentation.page', section='getting-started', page='quick-start') }}">Quick Start Checklist</a> - Set up your first customer and job</li>
  <li><a href="{{ url_for('documentation.page', section='mail-import', page='setup') }}">Mail Import Setup</a> - Configure email integration</li>
</ul>

{% endblock %}