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 %} +
+ Map customers to Autotask companies. +
+ +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 %} ++ Manually create tickets for failed backups. +
+ +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 %} ++ Configure Autotask PSA integration. +
+ +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 %} ++ Manage and track Autotask tickets. +
+ +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 %} ++ Learn the backup review process. +
+ +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 %} ++ View jobs expected to run today. +
+ +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 %} ++ Configure override rules for special cases. +
+ +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 %} ++ Manage remarks and tickets. +
+ +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 %} ++ Review and mark backup runs as reviewed. +
+ +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 %} ++ View and manage approved backup jobs. +
+ +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 %} ++ Learn how to configure backup jobs. +
+ +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 %} ++ Understand how job schedules work. +
+ +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 %} ++ Learn how to manage customer accounts. +
+ +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. -To access BackupChecks:
@@ -24,27 +19,159 @@The dashboard provides a quick overview of your backup status:
+The dashboard is your starting point and provides:
Use the navigation bar at the top to access different sections:
+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.
+ +BackupChecks shows only the menu items relevant to your current role. This keeps the interface clean and focused on your tasks.
+ +| 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 | +
In the top-right corner of the navigation bar, you'll see:
Now that you understand the interface, continue to:
+ +Jobs are created directly from the Inbox by approving backup report emails. The system uses Mail Parsers to extract job details automatically, ensuring consistency.
After approving your first job, you can automatically process other emails that match the same pattern:
When a backup report email is processed, it creates a "run" in the system:
+ +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 | +
Now that you have your first job configured, you can:
+ Configure automatic mail import. +
+ +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 %} ++ Manage incoming backup report emails. +
+ +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 %} ++ Learn how email parsing works. +
+ +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 %} ++ Configure Microsoft Graph API integration. +
+ +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 %} ++ Generate backup status reports. +
+ +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 %} ++ Export report data to various formats. +
+ +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 %} ++ Use relative time periods in reports. +
+ +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 %} ++ Schedule automatic report generation. +
+ +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 %} ++ Configure Autotask API settings. +
+ +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 %} ++ Configure general system settings. +
+ +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 %} ++ Configure Graph API mail settings. +
+ +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 %} ++ System maintenance and data management. +
+ +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 %} ++ Configure reporting defaults. +
+ +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 %} ++ Manage users and roles. +
+ +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 %} ++ Solutions to common problems. +
+ +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 %} ++ Frequently asked questions. +
+ +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 %} ++ How to get help and support. +
+ +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 %} ++ Learn about login procedures and authentication in BackupChecks. +
+ +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 %} ++ Customize your profile settings and preferences. +
+ +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 %} ++ Learn how to manage users and assign roles in BackupChecks. +
+ +Content coming soon...
+ +{% endblock %}