From a14457e28356fe25032afc23a19b31585bd4153d Mon Sep 17 00:00:00 2001
From: Ivo Oskamp
Date: Sun, 8 Feb 2026 11:34:44 +0100
Subject: [PATCH] Add all documentation placeholder pages and fix content
errors
- Created placeholder pages for all 30 documentation pages across 9 sections
- Fixed content errors in getting-started pages based on user feedback:
- Corrected review process (all jobs reviewed, not just successful)
- Changed Autotask tickets from automatic to manual creation
- Updated mail import from IMAP to Graph API
- Fixed job creation workflow (from Inbox via Approve job, not manual)
- Added Reparse all functionality explanation
- Corrected Daily Jobs vs Run Checks distinction
- Added manual import recommendation before enabling automatic
- Added role-based menu visibility explanation
- Added news items feature explanation
- All navigation links now work without Internal Server Errors
Co-Authored-By: Claude Sonnet 4.5
---
.last-branch | 2 +-
.../autotask/company-mapping.html | 19 ++
.../autotask/creating-tickets.html | 19 ++
.../autotask/setup-configuration.html | 19 ++
.../autotask/ticket-management.html | 19 ++
.../backup-review/approving-backups.html | 19 ++
.../backup-review/daily-jobs.html | 19 ++
.../backup-review/overrides.html | 19 ++
.../backup-review/remarks-tickets.html | 19 ++
.../backup-review/run-checks-modal.html | 19 ++
.../customers-jobs/approved-jobs.html | 19 ++
.../customers-jobs/configuring-jobs.html | 19 ++
.../customers-jobs/job-schedules.html | 19 ++
.../customers-jobs/managing-customers.html | 19 ++
.../getting-started/first-login.html | 165 ++++++++++++++++--
.../getting-started/quick-start.html | 132 ++++++++++----
.../getting-started/what-is-backupchecks.html | 17 +-
.../mail-import/auto-import.html | 19 ++
.../mail-import/inbox-management.html | 19 ++
.../mail-import/mail-parsing.html | 19 ++
.../documentation/mail-import/setup.html | 19 ++
.../reports/creating-reports.html | 19 ++
.../documentation/reports/exporting-data.html | 19 ++
.../reports/relative-periods.html | 19 ++
.../documentation/reports/scheduling.html | 19 ++
.../settings/autotask-integration.html | 19 ++
.../documentation/settings/general.html | 19 ++
.../settings/mail-configuration.html | 19 ++
.../documentation/settings/maintenance.html | 19 ++
.../settings/reporting-settings.html | 19 ++
.../settings/user-management.html | 19 ++
.../troubleshooting/common-issues.html | 19 ++
.../documentation/troubleshooting/faq.html | 19 ++
.../troubleshooting/support-contact.html | 19 ++
.../users/login-authentication.html | 19 ++
.../documentation/users/profile-settings.html | 19 ++
.../documentation/users/users-and-roles.html | 19 ++
37 files changed, 887 insertions(+), 56 deletions(-)
create mode 100644 containers/backupchecks/src/templates/documentation/autotask/company-mapping.html
create mode 100644 containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html
create mode 100644 containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html
create mode 100644 containers/backupchecks/src/templates/documentation/autotask/ticket-management.html
create mode 100644 containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html
create mode 100644 containers/backupchecks/src/templates/documentation/backup-review/daily-jobs.html
create mode 100644 containers/backupchecks/src/templates/documentation/backup-review/overrides.html
create mode 100644 containers/backupchecks/src/templates/documentation/backup-review/remarks-tickets.html
create mode 100644 containers/backupchecks/src/templates/documentation/backup-review/run-checks-modal.html
create mode 100644 containers/backupchecks/src/templates/documentation/customers-jobs/approved-jobs.html
create mode 100644 containers/backupchecks/src/templates/documentation/customers-jobs/configuring-jobs.html
create mode 100644 containers/backupchecks/src/templates/documentation/customers-jobs/job-schedules.html
create mode 100644 containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html
create mode 100644 containers/backupchecks/src/templates/documentation/mail-import/auto-import.html
create mode 100644 containers/backupchecks/src/templates/documentation/mail-import/inbox-management.html
create mode 100644 containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html
create mode 100644 containers/backupchecks/src/templates/documentation/mail-import/setup.html
create mode 100644 containers/backupchecks/src/templates/documentation/reports/creating-reports.html
create mode 100644 containers/backupchecks/src/templates/documentation/reports/exporting-data.html
create mode 100644 containers/backupchecks/src/templates/documentation/reports/relative-periods.html
create mode 100644 containers/backupchecks/src/templates/documentation/reports/scheduling.html
create mode 100644 containers/backupchecks/src/templates/documentation/settings/autotask-integration.html
create mode 100644 containers/backupchecks/src/templates/documentation/settings/general.html
create mode 100644 containers/backupchecks/src/templates/documentation/settings/mail-configuration.html
create mode 100644 containers/backupchecks/src/templates/documentation/settings/maintenance.html
create mode 100644 containers/backupchecks/src/templates/documentation/settings/reporting-settings.html
create mode 100644 containers/backupchecks/src/templates/documentation/settings/user-management.html
create mode 100644 containers/backupchecks/src/templates/documentation/troubleshooting/common-issues.html
create mode 100644 containers/backupchecks/src/templates/documentation/troubleshooting/faq.html
create mode 100644 containers/backupchecks/src/templates/documentation/troubleshooting/support-contact.html
create mode 100644 containers/backupchecks/src/templates/documentation/users/login-authentication.html
create mode 100644 containers/backupchecks/src/templates/documentation/users/profile-settings.html
create mode 100644 containers/backupchecks/src/templates/documentation/users/users-and-roles.html
diff --git a/.last-branch b/.last-branch
index 5d6080d..2d75690 100644
--- a/.last-branch
+++ b/.last-branch
@@ -1 +1 @@
-v20260207-01-reports-improvements
+v20260207-02-wiki-documentation
diff --git a/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html b/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html
new file mode 100644
index 0000000..21cc65c
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/autotask/company-mapping.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Company Mapping
+
+
+ Map customers to Autotask companies.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html b/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html
new file mode 100644
index 0000000..5aee350
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/autotask/creating-tickets.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Creating Tickets
+
+
+ Manually create tickets for failed backups.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html b/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html
new file mode 100644
index 0000000..68c4fc9
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/autotask/setup-configuration.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Setup & Configuration
+
+
+ Configure Autotask PSA integration.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html b/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html
new file mode 100644
index 0000000..ee3bbff
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/autotask/ticket-management.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Ticket Management
+
+
+ Manage and track Autotask tickets.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html b/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html
new file mode 100644
index 0000000..ed64b6c
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/backup-review/approving-backups.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Approving Backups
+
+
+ Learn the backup review process.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/backup-review/daily-jobs.html b/containers/backupchecks/src/templates/documentation/backup-review/daily-jobs.html
new file mode 100644
index 0000000..4dbe464
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/backup-review/daily-jobs.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Daily Jobs View
+
+
+ View jobs expected to run today.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/backup-review/overrides.html b/containers/backupchecks/src/templates/documentation/backup-review/overrides.html
new file mode 100644
index 0000000..be93c39
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/backup-review/overrides.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Overrides & Exceptions
+
+
+ Configure override rules for special cases.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/backup-review/remarks-tickets.html b/containers/backupchecks/src/templates/documentation/backup-review/remarks-tickets.html
new file mode 100644
index 0000000..9e55b70
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/backup-review/remarks-tickets.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Remarks & Tickets
+
+
+ Manage remarks and tickets.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/backup-review/run-checks-modal.html b/containers/backupchecks/src/templates/documentation/backup-review/run-checks-modal.html
new file mode 100644
index 0000000..184fe21
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/backup-review/run-checks-modal.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Run Checks Modal
+
+
+ Review and mark backup runs as reviewed.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/customers-jobs/approved-jobs.html b/containers/backupchecks/src/templates/documentation/customers-jobs/approved-jobs.html
new file mode 100644
index 0000000..93fffd7
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/customers-jobs/approved-jobs.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Approved Jobs
+
+
+ View and manage approved backup jobs.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/customers-jobs/configuring-jobs.html b/containers/backupchecks/src/templates/documentation/customers-jobs/configuring-jobs.html
new file mode 100644
index 0000000..b58f72c
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/customers-jobs/configuring-jobs.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Configuring Jobs
+
+
+ Learn how to configure backup jobs.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/customers-jobs/job-schedules.html b/containers/backupchecks/src/templates/documentation/customers-jobs/job-schedules.html
new file mode 100644
index 0000000..aeeff19
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/customers-jobs/job-schedules.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Job Schedules
+
+
+ Understand how job schedules work.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html b/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html
new file mode 100644
index 0000000..80f3943
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/customers-jobs/managing-customers.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Managing Customers
+
+
+ Learn how to manage customer accounts.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/getting-started/first-login.html b/containers/backupchecks/src/templates/documentation/getting-started/first-login.html
index 71cf335..fa56bfc 100644
--- a/containers/backupchecks/src/templates/documentation/getting-started/first-login.html
+++ b/containers/backupchecks/src/templates/documentation/getting-started/first-login.html
@@ -7,11 +7,6 @@
Learn how to log in to BackupChecks and navigate the dashboard interface.
-
- 📝 Coming Soon:
- This page is under construction. Full content will be added in a future update.
-
-
Logging In
To access BackupChecks:
@@ -24,27 +19,159 @@
Dashboard Overview
-The dashboard provides a quick overview of your backup status:
+The dashboard is your starting point and provides:
- - Today's Jobs: Summary of backup jobs expected today
- - Recent Activity: Latest backup reports and reviews
- - Statistics: Success rates and trends
- - Quick Actions: Common tasks and shortcuts
+ - General Introduction: A brief explanation of what BackupChecks is and how it works
+ - News & Announcements: Important updates and notices posted by administrators
+ - Quick Overview: Summary of your backup monitoring status
-Navigation
+
+ 💡 Note:
+ Administrators can create and manage news items via Settings to keep all users informed about system updates, maintenance windows, or important changes.
+
-Use the navigation bar at the top to access different sections:
+Navigation Bar
+
+The navigation bar at the top of the page provides access to different sections of BackupChecks. The menu items you see depend on your assigned role.
+
+Role-Based Menu Visibility
+
+BackupChecks shows only the menu items relevant to your current role. This keeps the interface clean and focused on your tasks.
+
+
+ Example - Reporter Role:
+ If you log in as a Reporter, you will only see: Dashboard, Reports, Documentation, Changelog, and Feedback.
+
+
+Common Menu Items
+
+
+
+
+ | Menu Item |
+ Description |
+ Available To |
+
+
+
+
+ | Dashboard |
+ Home page with overview and news |
+ All roles |
+
+
+ | Inbox |
+ View all imported emails that are NOT yet linked to jobs (either because no parser exists or the job hasn't been created yet) |
+ Admin, Operator, Viewer |
+
+
+ | All Mail |
+ View all imported emails including linked ones |
+ Admin only |
+
+
+ | Deleted Mails |
+ View emails that have been deleted |
+ Admin only |
+
+
+ | Customers |
+ Manage customer accounts |
+ Admin, Operator, Viewer |
+
+
+ | Jobs |
+ Configure and manage backup jobs |
+ Admin, Operator, Viewer |
+
+
+ | Archived Jobs |
+ View jobs that have been archived |
+ Admin only |
+
+
+ | Daily Jobs |
+ View today's expected backup jobs and their status |
+ Admin, Operator, Viewer |
+
+
+ | Run Checks |
+ Review all backup runs (successful and failed) and mark them as reviewed - the goal is to clear this queue daily |
+ Admin, Operator |
+
+
+ | Tickets |
+ View and manage Autotask tickets |
+ Admin, Operator, Viewer |
+
+
+ | Overrides |
+ Configure rules to override backup status for specific cases |
+ Admin, Operator, Viewer |
+
+
+ | Reports |
+ Generate and view backup status reports |
+ All roles |
+
+
+ | Settings |
+ Configure system settings, mail import, Autotask integration |
+ Admin only |
+
+
+ | Logging |
+ View system audit log of important events |
+ Admin only |
+
+
+ | Parsers |
+ View and test email parsing configurations |
+ Admin only |
+
+
+ | Documentation |
+ Access this user documentation |
+ All roles |
+
+
+ | Changelog |
+ View recent changes and updates to BackupChecks |
+ All roles |
+
+
+ | Feedback |
+ Submit feedback and feature requests |
+ All roles |
+
+
+
+
+User Profile and Role Switching
+
+In the top-right corner of the navigation bar, you'll see:
- - Inbox: View incoming backup report emails
- - Customers: Manage customer accounts
- - Jobs: Configure backup jobs
- - Daily Jobs: Review today's backup status
- - Run Checks: Approve or reject backup runs
- - Reports: Generate and view reports
- - Settings: Configure system settings (admin only)
+ - Your username and current role: Click to access your profile settings
+ - Role selector: If you have multiple roles assigned, you can switch between them using the dropdown menu
+ - Theme selector: Choose between Light, Dark, or Auto theme
+ - Logout button: Sign out of BackupChecks
+
+
+
+ 💡 About Run Checks:
+ The Run Checks page is designed for operators to review all backup runs and mark them as reviewed. This serves as proof that backups have been manually checked. The system records who performed each review and when, creating an audit trail for compliance and quality assurance.
+
+
+Next Steps
+
+Now that you understand the interface, continue to:
+
+
{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/getting-started/quick-start.html b/containers/backupchecks/src/templates/documentation/getting-started/quick-start.html
index d4e4c1c..f611e78 100644
--- a/containers/backupchecks/src/templates/documentation/getting-started/quick-start.html
+++ b/containers/backupchecks/src/templates/documentation/getting-started/quick-start.html
@@ -9,7 +9,7 @@
📝 Coming Soon:
- This page is under construction. Full content will be added in a future update.
+ This page is under construction. Screenshots will be added in a future update.
Prerequisites
@@ -18,19 +18,25 @@
- Admin or Operator access to BackupChecks
- - Email credentials for the backup report mailbox
- - Information about your first customer and their backup software
+ - Microsoft Graph API credentials configured for email retrieval
+ - At least one backup report email already in the mailbox
Step 1: Configure Mail Import
- Navigate to Settings → Mail
- - Enter your IMAP server details (host, port, username, password)
- - Test the connection
- - Enable automatic mail import
+ - Enter your Microsoft Graph API details (Tenant ID, Client ID, Client Secret, Mailbox)
+ - Test the connection to verify the credentials are correct
+ - Go to Settings → Imports
+ - Click the Manual Import button to fetch emails from the mailbox
+
+ 💡 Recommended Approach:
+ Automatic mail import is disabled by default. Start by using the manual import button to test if everything works correctly. Once you're satisfied that emails are being imported and processed as expected, you can enable automatic mail import in Settings → Mail. This way, the system will automatically fetch new emails at the configured interval.
+
+
Step 2: Add a Customer
@@ -40,49 +46,115 @@
- Save the customer
-Step 3: Configure a Job
+
+ 💡 Note:
+ On the Customers page, you'll see the number of jobs linked to each customer. If no jobs are configured yet, you'll see 0 displayed in red and bold.
+
+
+Step 3: Create Your First Job from Inbox
+
+Jobs are created directly from the Inbox by approving backup report emails. The system uses Mail Parsers to extract job details automatically, ensuring consistency.
- - From the customer detail page, click New Job
- - Select the backup software type (Veeam, Synology, etc.)
- - Configure job matching rules (sender email, subject keywords)
- - Set the expected schedule
- - Save the job configuration
+ - Go to Inbox in the navigation menu
+ - Find a backup report email from your customer
+ - Click on the email to view its details
+ - In the Customer field, enter or select the customer name you created in Step 2
+ - Click Approve job (this button is only enabled when a customer is selected)
-Step 4: Import First Backup Report
+
+ ⚠️ Important:
+ You cannot manually configure job variables. All job details (backup software, backup type, sender, subject patterns, etc.) are automatically determined by the Mail Parsers based on the email content. This ensures all jobs are created consistently.
+
+
+Step 4: Process Similar Emails (Reparse All)
+
+After approving your first job, you can automatically process other emails that match the same pattern:
- - Go to Inbox
- - Click Import Now to fetch recent emails
- - Find your backup report email in the inbox
- - Click on the email to view details
- - Click Link to Job and select the job you created
-
-
-Step 5: Review and Approve
-
-
- - Navigate to Daily Jobs
- - You should see your job listed for today
- - Click Run Checks to review pending backups
- - Approve or reject the backup run
+ - At the top of the Inbox page, click Reparse all
+ - The system will scan all inbox emails and link any that match your newly approved job
+ - Matched emails are automatically removed from the inbox and linked to the job
💡 Tip:
- After completing these steps, your job will automatically process future backup reports from the same sender.
+ Use the Delete button on emails that are not backup reports. Deleted emails are moved to Deleted Mails (visible to admins only).
+Step 5: Review Backup Runs
+
+When a backup report email is processed, it creates a "run" in the system:
+
+
+ - Navigate to Run Checks in the navigation menu
+ - You should see the backup run(s) from your approved job
+ - Review each run (successful or failed) and mark it as reviewed
+ - The goal is to clear the Run Checks queue by reviewing all pending runs
+
+
+
+ 💡 About Daily Jobs:
+ The Daily Jobs page shows jobs expected to run today based on learned schedules. It takes a few days for the system to learn a job's schedule pattern. Once learned, jobs will appear in Daily Jobs on their expected days. Individual runs always appear immediately in Run Checks regardless of schedule.
+
+
+Understanding the Workflow
+
+Here's a summary of how BackupChecks processes backup reports:
+
+
+
+
+ | Step |
+ What Happens |
+ Where to See It |
+
+
+
+
+ | 1. Email arrives |
+ Backup report is sent to monitored mailbox |
+ Not visible yet |
+
+
+ | 2. Import runs |
+ System fetches email via Graph API |
+ Inbox (if no matching job exists) |
+
+
+ | 3. Job created |
+ You approve the email and create a job |
+ Jobs page |
+
+
+ | 4. Run created |
+ Email is parsed and a backup run is recorded |
+ Run Checks page |
+
+
+ | 5. Schedule learned |
+ After several runs, system learns the schedule |
+ Daily Jobs page |
+
+
+ | 6. Review |
+ Operator marks run as reviewed |
+ Run Checks queue is cleared |
+
+
+
+
Next Steps
Now that you have your first job configured, you can:
{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/getting-started/what-is-backupchecks.html b/containers/backupchecks/src/templates/documentation/getting-started/what-is-backupchecks.html
index 710b3f7..01de937 100644
--- a/containers/backupchecks/src/templates/documentation/getting-started/what-is-backupchecks.html
+++ b/containers/backupchecks/src/templates/documentation/getting-started/what-is-backupchecks.html
@@ -8,13 +8,18 @@
verify that backups are running successfully across their customer infrastructure.
+
+ 📝 Coming Soon:
+ This page is under construction. Screenshots and additional content will be added in future updates.
+
+
Key Features
- Automated Mail Parsing: Import backup reports via email and automatically parse results
- - Approval Workflow: Review and approve backup jobs on a daily basis
+ - Review Workflow: Review all backup jobs daily and mark them as reviewed (goal: clear the Run Checks queue)
- Customer Management: Organize backups by customer and manage multiple backup jobs per customer
- - Autotask Integration: Create tickets in Autotask PSA for failed backups
+ - Autotask Integration: Manually create tickets in Autotask PSA for failed backups requiring follow-up
- Reporting: Generate backup status reports with flexible scheduling
- Role-Based Access: Admin, Operator, Reporter, and Viewer roles
@@ -32,8 +37,8 @@
Import: Backup reports are sent via email to a configured mailbox
Parse: The system parses email content to extract backup status
Match: Reports are matched to configured jobs based on sender, subject, and content
- Review: Operators review backup status and approve successful jobs
- Alert: Failed backups can trigger Autotask tickets or manual follow-up
+ Review: Operators review all backup jobs (both successful and failed) and mark them as reviewed to clear the Run Checks queue
+ Ticket Creation: For failed backups requiring follow-up, operators manually create tickets in Autotask PSA
Report: Generate periodic reports to track backup health over time
@@ -106,8 +111,8 @@
- Backend: Flask (Python) application with PostgreSQL database
- Frontend: Bootstrap 5 for responsive UI
- - Mail Import: IMAP integration for automated email retrieval
- - Autotask API: Optional integration for ticket creation
+ - Mail Import: Microsoft Graph API integration for automated email retrieval
+ - Autotask API: Optional integration for manual ticket creation
- Reporting: Built-in report generation with scheduling
diff --git a/containers/backupchecks/src/templates/documentation/mail-import/auto-import.html b/containers/backupchecks/src/templates/documentation/mail-import/auto-import.html
new file mode 100644
index 0000000..ab3b4b3
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/mail-import/auto-import.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Auto-Import Configuration
+
+
+ Configure automatic mail import.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/mail-import/inbox-management.html b/containers/backupchecks/src/templates/documentation/mail-import/inbox-management.html
new file mode 100644
index 0000000..735a704
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/mail-import/inbox-management.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Inbox Management
+
+
+ Manage incoming backup report emails.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html b/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html
new file mode 100644
index 0000000..500c157
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Mail Parsing
+
+
+ Learn how email parsing works.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/mail-import/setup.html b/containers/backupchecks/src/templates/documentation/mail-import/setup.html
new file mode 100644
index 0000000..5bfbedd
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/mail-import/setup.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Mail Import Setup
+
+
+ Configure Microsoft Graph API integration.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/reports/creating-reports.html b/containers/backupchecks/src/templates/documentation/reports/creating-reports.html
new file mode 100644
index 0000000..2f39d48
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/reports/creating-reports.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Creating Reports
+
+
+ Generate backup status reports.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/reports/exporting-data.html b/containers/backupchecks/src/templates/documentation/reports/exporting-data.html
new file mode 100644
index 0000000..56c8142
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/reports/exporting-data.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Exporting Data
+
+
+ Export report data to various formats.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/reports/relative-periods.html b/containers/backupchecks/src/templates/documentation/reports/relative-periods.html
new file mode 100644
index 0000000..45cdaa6
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/reports/relative-periods.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Relative Periods
+
+
+ Use relative time periods in reports.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/reports/scheduling.html b/containers/backupchecks/src/templates/documentation/reports/scheduling.html
new file mode 100644
index 0000000..0d98f7a
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/reports/scheduling.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Report Scheduling
+
+
+ Schedule automatic report generation.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/settings/autotask-integration.html b/containers/backupchecks/src/templates/documentation/settings/autotask-integration.html
new file mode 100644
index 0000000..760f738
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/settings/autotask-integration.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Autotask Integration
+
+
+ Configure Autotask API settings.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/settings/general.html b/containers/backupchecks/src/templates/documentation/settings/general.html
new file mode 100644
index 0000000..d5d106d
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/settings/general.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+General Settings
+
+
+ Configure general system settings.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/settings/mail-configuration.html b/containers/backupchecks/src/templates/documentation/settings/mail-configuration.html
new file mode 100644
index 0000000..da5018c
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/settings/mail-configuration.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Mail Configuration
+
+
+ Configure Graph API mail settings.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/settings/maintenance.html b/containers/backupchecks/src/templates/documentation/settings/maintenance.html
new file mode 100644
index 0000000..44415b5
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/settings/maintenance.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Maintenance
+
+
+ System maintenance and data management.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/settings/reporting-settings.html b/containers/backupchecks/src/templates/documentation/settings/reporting-settings.html
new file mode 100644
index 0000000..ddef08d
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/settings/reporting-settings.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Reporting Settings
+
+
+ Configure reporting defaults.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/settings/user-management.html b/containers/backupchecks/src/templates/documentation/settings/user-management.html
new file mode 100644
index 0000000..d08426f
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/settings/user-management.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+User Management
+
+
+ Manage users and roles.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/troubleshooting/common-issues.html b/containers/backupchecks/src/templates/documentation/troubleshooting/common-issues.html
new file mode 100644
index 0000000..f3bad38
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/troubleshooting/common-issues.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Common Issues
+
+
+ Solutions to common problems.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/troubleshooting/faq.html b/containers/backupchecks/src/templates/documentation/troubleshooting/faq.html
new file mode 100644
index 0000000..42c450f
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/troubleshooting/faq.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+FAQ
+
+
+ Frequently asked questions.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/troubleshooting/support-contact.html b/containers/backupchecks/src/templates/documentation/troubleshooting/support-contact.html
new file mode 100644
index 0000000..ae5168f
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/troubleshooting/support-contact.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Support Contact
+
+
+ How to get help and support.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Content
+
+Detailed content will be added here in a future update.
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/users/login-authentication.html b/containers/backupchecks/src/templates/documentation/users/login-authentication.html
new file mode 100644
index 0000000..d3d325d
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/users/login-authentication.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Login & Authentication
+
+
+ Learn about login procedures and authentication in BackupChecks.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Authentication
+
+Content coming soon...
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/users/profile-settings.html b/containers/backupchecks/src/templates/documentation/users/profile-settings.html
new file mode 100644
index 0000000..5711718
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/users/profile-settings.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Profile Settings
+
+
+ Customize your profile settings and preferences.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+Profile
+
+Content coming soon...
+
+{% endblock %}
diff --git a/containers/backupchecks/src/templates/documentation/users/users-and-roles.html b/containers/backupchecks/src/templates/documentation/users/users-and-roles.html
new file mode 100644
index 0000000..ad1d6c1
--- /dev/null
+++ b/containers/backupchecks/src/templates/documentation/users/users-and-roles.html
@@ -0,0 +1,19 @@
+{% extends "documentation/base.html" %}
+
+{% block doc_content %}
+Users & Roles
+
+
+ Learn how to manage users and assign roles in BackupChecks.
+
+
+
+ 📝 Coming Soon:
+ This page is under construction. Full content will be added in a future update.
+
+
+User Management
+
+Content coming soon...
+
+{% endblock %}