Files

cproudlock 534f179ee6 Make main the lean product a site receives

main was 16 days and 259 commits behind the line the product is actually built
on, at contract 0.30.0 against 0.35.0, with no per-PC credential code at all. It
was neither current nor curated - just stale. This brings it forward and, at the
same time, makes it mean something: main is what a receiving site installs, and
nothing else.

WHAT IT CARRIES. Twelve plugins - backups, computers, endpoints, guides,
knowledgebase, machines, network, notifications, printers, slides, tools,
warranty - plus applications, which is manifest-less core and always ships. The
only manifest dependency inside that set is endpoints on computers, and both are
in it, so the closure is self-contained.

WHAT IT DOES NOT. employees, geenforce, measuringtools, printedparts and usb
stay on the site line. So do the Windows installer tree, the VM rehearsal
helpers, the agent tooling config, one site's data loader, the internal audit
and findings records, and the planner spreadsheet. 1,135 tracked files against
1,438.

A REMOVAL THAT BREAKS THE APP IS NOT A REMOVAL, and two nearly shipped:

deploy/site-profile-universal.json still named all seventeen plugins. It is the
file docs/DEPLOY.md tells a site to provision from, so a fresh install would
have failed at `flask plugin apply-profile` with PluginError - the first thing a
receiving site does, broken by the branch meant to serve them. It now names the
twelve that exist, and its comment says the two must agree.

agent/ was never refreshed. Whoever populated this branch copied shopdb/,
plugins/, frontend/ and tests/ from the site line and left the agent tree at its
September state: 22 C# and PowerShell sources missing, including AgentCredentials,
EnrollmentService, AgentHttpFactory and the fleet-alert client, plus one file the
site line had deleted still present. The old tree is internally consistent, so it
compiles, and nothing in CI builds it - every gate was green over a server that
speaks enrollment and per-PC credentials to a bundled agent source that cannot.
Resynced whole.

DECISIONS THIS ENCODES, rather than defers:

- The plugin-authoring lab builds printedparts, whose manifest depends on
  employees, so it could not stay. The lab remains on the site line and main
  ships no build-along tutorial. That is a real loss for an adopting developer
  and is recorded here rather than discovered later.
- Recognition, Training and Recertification notifications are no longer seeded.
  Each splits one notification into a card per employee and renders a photo,
  which needs a plugin this branch does not bundle. Seeding them would offer an
  author a type that cannot resolve anybody. A site that installs employees gets
  them from that plugin's own seed.
- Windows/IIS is documented as the legacy path throughout, and the README leads
  with Docker, because that is what a receiving site gets.

The API description is regenerated for THIS branch - 347 paths and 483
operations, down from 415 and 573 - so the published contract describes what is
here rather than what the site line serves. docs/CONFIG.md lost the two
measuring-tool label keys the code no longer declares, which two lanes had
decided opposite ways.

Suite: 3124 passed, 6 skipped. Naming and style gates pass. The docs gates run
rather than skip, and every index line count is derived from the file it names.

2026-09-19 11:24:40 -04:00

2.6 KiB

Raw Blame History

ShopDB Backup & Restore

The backup system provides automated database and instance backups with restore capability.

Quick Start

# Trigger a backup via docker-compose
docker compose -f docker-compose.backup.yml up backup

# Or via API (requires admin JWT token)
curl -X POST http://localhost:5001/api/shopdbbackups \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Configuration

By default, backups are stored in /backups volume (local to Docker host).

For production, configure storage in Settings > Backups web UI:

Local: Default, no configuration needed
SMB: Network share (requires hostname, share, credentials)
AWS S3: Cloud storage (requires region, bucket, credentials)

Retention Policy

5 daily backups
4 weekly backups
6 monthly backups

Backup Contents

Each backup set includes:

db.sql.gz - Compressed MySQL dump
instance/ - Uploaded files, branding, floor plans, maps
manifest.json - Schema revisions for compatibility checking

Restore

Go to Settings > Backups in web UI
Select a backup set
Click Restore
System validates schema compatibility and restores database + files

Local Development Setup

For local dev on Windows, configure a local backup directory:

Add to .env:

SHOPDB_BACKUPS_ROOT=C:/Users/YOUR_USERNAME/Documents/github/flask-shopdb/backups

Create the directory:
```
mkdir backups
```
Restart Flask

Note: Actual backup execution requires Docker (the backup container). The API can queue backups but won't execute them without the sidecar container.

First Deployment

On fresh install, /api/shopdbbackups returns empty list - this is normal. No backups exist until first backup runs.

Troubleshooting

"No backups found"

Check /backups volume is mounted
Verify backup container ran: docker logs shopdb-backup-1

"500 error on backup endpoint"

Must be logged in as admin
Check Flask logs for details

"Restore failed: incompatible schema"

Backup is from newer ShopDB version
Update code first, then restore

API Endpoints

All require admin role:

GET /api/shopdbbackups - List backups
POST /api/shopdbbackups - Trigger backup
POST /api/shopdbbackups/<id>/restore - Restore backup
GET /api/shopdbbackups/status - Current status
GET /api/shopdbbackups/history - Backup history

Security

Backups contain sensitive data (DB dump, uploads)
Secure /backups volume with appropriate permissions
Use encrypted storage for offsite backups
Only admin role can access backup endpoints

2.6 KiB Raw Blame History