hippogrief/pobsync
1
0
Fork 0
Code Issues 21 Pull Requests Actions Packages Projects Releases 3 Wiki Activity
Files
3cac7b61aca015962596e506bb7ccb65304dbfcd
pobsync/src/pobsync_server/urls.py

58 lines
3.2 KiB
Python
Raw Normal View History

feat: add Django backend foundation and Docker runtime Add a Django admin-backed management layer for pobsync configs, runs, snapshots, and schedules. Keep the existing CLI engine as the execution source of truth, add import/run management commands, and provide SQLite default plus optional MariaDB Docker Compose support.
2026-05-19 04:48:13 +02:00
from __future__ import annotations
from django.contrib import admin
from django.urls import path
(feature) Add staff-only Django dashboard views Add a small template-based UI for inspecting pobsync state through Django. The dashboard shows host, schedule, snapshot, and backup run summaries, while host detail pages show config, schedule, recent runs, and discovered snapshots. Keep the views read-only and staff-protected, document the new dashboard URL, and cover the routes with focused view tests.
2026-05-19 11:53:32 +02:00
from pobsync_backend import api, views
(feature) Add staff-only JSON inspection API Expose lightweight Django JSON endpoints for hosts, snapshots, and backup runs using the existing admin/staff authentication boundary. Include filters for snapshot and run inspection, return resolved snapshot base metadata, and document the new /api/ entrypoint. Add endpoint tests for authentication, host summaries, snapshot lineage payloads, and run filtering.
2026-05-19 11:43:50 +02:00
feat: add Django backend foundation and Docker runtime Add a Django admin-backed management layer for pobsync configs, runs, snapshots, and schedules. Keep the existing CLI engine as the execution source of truth, add import/run management commands, and provide SQLite default plus optional MariaDB Docker Compose support.
2026-05-19 04:48:13 +02:00
urlpatterns = [
(feature) Add staff-only Django dashboard views Add a small template-based UI for inspecting pobsync state through Django. The dashboard shows host, schedule, snapshot, and backup run summaries, while host detail pages show config, schedule, recent runs, and discovered snapshots. Keep the views read-only and staff-protected, document the new dashboard URL, and cover the routes with focused view tests.
2026-05-19 11:53:32 +02:00
path("", views.dashboard, name="dashboard"),
(release) Add Django changelog page Expose the repository CHANGELOG.md through a staff-only Django view and link it from the main navigation. Render a small safe subset of Markdown without adding a runtime dependency, copy the changelog into the Docker image, and cover the page with view tests.
2026-05-21 03:10:31 +02:00
path("changelog/", views.changelog, name="changelog"),
(feature) Add full native installer and self-check page Expand the systemd installer so it can perform a complete native installation with sensible defaults: copy the checkout into the target app directory, create runtime directories, write the environment file, install dependencies, configure systemd units, and optionally configure nginx. Add a staff-only Django self-check page that verifies runtime settings, required binaries, writable paths, database connectivity, global config state, and systemd service status when available. Document installer overrides and expose the self-check from the main navigation.
2026-05-19 16:05:03 +02:00
path("self-check/", views.self_check, name="self_check"),
(feature) Add host doctor checks and Django log viewer Add host-level checks for address, enabled state, SSH credential selection, and backup directory readiness, and show them on the host detail page. Create host backup directories during host creation and prefill new hosts from the default global config. Add a staff-only logs view backed by journalctl with filtering by pobsync unit, priority, and message text. Improve runtime checks for gunicorn in virtualenv installs and ensure the native installer grants the service user access to the backup root.
2026-05-19 19:11:57 +02:00
path("logs/", views.logs, name="logs"),
(release) Add purged snapshot audit overview Record snapshot purge history whenever retention or incomplete cleanup removes snapshot directories and SQL records. Store the purge reason, original kind, path, action source, and triggering operator so manual, scheduled, CLI, and incomplete cleanup actions remain auditable after the original snapshot record is deleted. Add a staff-only Purged Snapshots page with host/action filters and register the audit model in Django admin. Refs #16 Refs #8
2026-05-21 03:46:38 +02:00
path("purged-snapshots/", views.purged_snapshots, name="purged_snapshots"),
(ui) Add schedule overview for dashboard drill-down Add a staff-only schedules page with filters for host, enabled state, and prune state, including next run and last scheduler state. Wire the dashboard Schedules metric to the new overview so all primary dashboard count cards have useful destinations. Refs #23
2026-05-21 12:39:57 +02:00
path("schedules/", views.schedules_list, name="schedules_list"),
(feature) add Django setup flow for initial pobsync configuration Add staff-only UI routes for creating/editing the default GlobalConfig and creating the first HostConfig from the dashboard. Improve the empty dashboard state so a fresh database guides the user towards the next useful setup action instead of only showing empty tables. Cover the setup flow with view tests for empty state prompts, global config creation, and host creation.
2026-05-19 12:25:45 +02:00
path("config/global/", views.edit_global_config, name="edit_global_config"),
(feature) Add Django-managed SSH credentials Add SSH credentials as first-class Django data so backup keys can be uploaded through the control panel instead of mounted into containers. Credentials can be selected globally or overridden per host. At runtime the selected key is materialized inside the container with restrictive file permissions and injected into the rsync SSH command via IdentityFile. Known hosts entries are handled the same way when configured. Add control panel views for creating and listing SSH keys, expose the fields in config forms and admin, document the workflow, and cover global and host credential selection with tests.
2026-05-19 14:37:38 +02:00
path("ssh-credentials/", views.ssh_credentials, name="ssh_credentials"),
path("ssh-credentials/new/", views.create_ssh_credential, name="create_ssh_credential"),
(feature) Generate filesystem-backed SSH credentials Add filesystem-backed SSH credentials for the native systemd deployment path. Generated keys are stored below POBSYNC_HOME with 0600 permissions, while Django keeps the public key, fingerprint, path, and selection metadata. Add a Django SSH key generation view, delete action for unused generated keys, and a management command used by the installer to ensure a default backup key exists. Update runtime config to use generated key paths directly as IdentityFile, extend host checks to verify key readability, and keep legacy uploaded keys available for compatibility.
2026-05-19 19:41:40 +02:00
path("ssh-credentials/generate/", views.generate_ssh_credential, name="generate_ssh_credential"),
(bugfix) Validate Django-managed SSH private keys Validate uploaded SSH private keys with ssh-keygen before saving them so invalid, malformed, or unsupported key material is rejected in the control panel instead of failing later during rsync. Auto-populate the public key when it is omitted, add an edit flow for existing SSH credentials, and cover create, update, and invalid-key paths with view tests.
2026-05-19 15:22:40 +02:00
path("ssh-credentials/<int:credential_id>/", views.edit_ssh_credential, name="edit_ssh_credential"),
(feature) Generate filesystem-backed SSH credentials Add filesystem-backed SSH credentials for the native systemd deployment path. Generated keys are stored below POBSYNC_HOME with 0600 permissions, while Django keeps the public key, fingerprint, path, and selection metadata. Add a Django SSH key generation view, delete action for unused generated keys, and a management command used by the installer to ensure a default backup key exists. Update runtime config to use generated key paths directly as IdentityFile, extend host checks to verify key readability, and keep legacy uploaded keys available for compatibility.
2026-05-19 19:41:40 +02:00
path("ssh-credentials/<int:credential_id>/delete/", views.delete_ssh_credential, name="delete_ssh_credential"),
(feature) add Django setup flow for initial pobsync configuration Add staff-only UI routes for creating/editing the default GlobalConfig and creating the first HostConfig from the dashboard. Improve the empty dashboard state so a fresh database guides the user towards the next useful setup action instead of only showing empty tables. Cover the setup flow with view tests for empty state prompts, global config creation, and host creation.
2026-05-19 12:25:45 +02:00
path("hosts/new/", views.create_host_config, name="create_host_config"),
(feature) Add staff-only Django dashboard views Add a small template-based UI for inspecting pobsync state through Django. The dashboard shows host, schedule, snapshot, and backup run summaries, while host detail pages show config, schedule, recent runs, and discovered snapshots. Keep the views read-only and staff-protected, document the new dashboard URL, and cover the routes with focused view tests.
2026-05-19 11:53:32 +02:00
path("hosts/<str:host>/", views.host_detail, name="host_detail"),
(feature) Add host config editing view Add a staff-only Django form for editing operational host settings while keeping host identity stable. Support address, enablement, SSH/source overrides, include/exclude lists, rsync extra args, and retention settings using the same SQL-backed HostConfig model consumed by backup and scheduler flows. Parse newline-separated list fields into JSON lists, preserve nullable excludes_replace semantics, and cover rendering plus update behavior with view tests.
2026-05-19 12:17:17 +02:00
path("hosts/<str:host>/config/", views.edit_host_config, name="edit_host_config"),
(bugfix) Grant service user backup and journal access Update the native installer so the pobsync service user gets journal read access when the host exposes systemd-journal or adm groups. Apply ownership and private directory modes to the configured backup root, and reuse the existing environment backup root on reinstall so production updates do not fall back to /backups. Add a self-check for journal access and a host detail action that can prepare missing backup directories for existing host configurations.
2026-05-19 19:25:05 +02:00
path("hosts/<str:host>/prepare-directories/", views.prepare_host_directories, name="prepare_host_directories"),
(feature) Add host key scanning for SSH credentials Add a host detail action that scans the target SSH host key with ssh-keyscan and stores it on the selected SSH credential. Merge scanned known_hosts entries without duplicates and let the existing runtime config pass them through as UserKnownHostsFile for unattended rsync over SSH. Extend host checks to warn when the selected credential has no known_hosts entries, making host key verification failures actionable from Django.
2026-05-19 19:55:40 +02:00
path("hosts/<str:host>/scan-known-key/", views.scan_host_known_key, name="scan_host_known_key"),
(feature) Add remote host connection preflight Add an on-demand host preflight action that verifies SSH reachability, remote rsync availability, and remote source root access. Persist the latest preflight result on the host config, render it in Django, and block real backups when the last remote preflight failed.
2026-05-21 00:50:05 +02:00
path("hosts/<str:host>/preflight/", views.run_host_preflight, name="run_host_preflight"),
(feature) queue manual backups from the Django host page Add a staff-only manual backup form to host detail pages with safe dry-run defaults and optional retention settings. Queue manual BackupRun records through the existing worker-backed runner path instead of executing backups inside the web request. Validate disabled hosts, missing global config, and invalid methods with view tests covering the new UI flow.
2026-05-19 13:04:50 +02:00
path("hosts/<str:host>/queue-backup/", views.queue_manual_backup, name="queue_manual_backup"),
(feature) Add snapshot discovery action to host view Add a staff-only POST action on host detail pages to discover existing snapshots for that host and record them into SQL. Show success or failure feedback through Django messages, and keep the action non-destructive before adding heavier backup or retention controls. Cover the action with view tests for successful discovery, redirect behavior, and method safety.
2026-05-19 11:56:45 +02:00
path("hosts/<str:host>/discover-snapshots/", views.discover_host_snapshots, name="discover_host_snapshots"),
(feature) Add Django retention apply flow Expose retention apply from the host retention plan page so planned snapshot deletions can be executed from the Django UI. The form requires explicit host confirmation, carries through the selected retention kind and base-protection setting, and uses max_delete as a deletion guard. The view delegates to the SQL retention apply service and reports predictable pobsync errors back through Django messages instead of surfacing a server error. Add view coverage for confirmed deletion, invalid confirmation, and POST-only enforcement.
2026-05-19 13:54:15 +02:00
path("hosts/<str:host>/retention-apply/", views.apply_host_retention, name="apply_host_retention"),
(feature) Add read-only retention plan view Add a staff-only retention plan page for each host using the SQL-backed retention service. Link it from the host detail page and show policy settings, keep reasons, and snapshots that would be deleted for scheduled, manual, or all snapshot kinds. Keep the flow non-destructive for now, validate query parameters, and cover the view with tests for rendering, base protection, and invalid kind handling.
2026-05-19 12:00:19 +02:00
path("hosts/<str:host>/retention-plan/", views.host_retention_plan, name="host_retention_plan"),
(release) Add explicit incomplete snapshot cleanup Add a dedicated cleanup path for incomplete snapshots instead of letting retention prune them implicitly. The retention plan now exposes a guarded form that requires host and delete-count confirmation before removing .incomplete snapshot directories and their SQL records. Keep scheduled/manual retention behavior unchanged, add path safety checks, and cover cleanup success, confirmation failures, max-delete limits, and unexpected paths in tests. Refs #10
2026-05-21 03:26:21 +02:00
path(
"hosts/<str:host>/incomplete-cleanup/",
views.cleanup_host_incomplete_snapshots,
name="cleanup_host_incomplete_snapshots",
),
(feature) Add schedule editing view for hosts Add a staff-only Django form for creating and updating host schedules using the SQL-backed ScheduleConfig model. Link the form from host detail pages, validate cron expressions with the existing scheduler parser, and preserve scheduler/CLI behavior by writing to the same source of truth. Cover default rendering, schedule creation, updates, and invalid cron handling with view tests.
2026-05-19 12:13:12 +02:00
path("hosts/<str:host>/schedule/", views.edit_host_schedule, name="edit_host_schedule"),
(ui) Add dashboard-linked run and snapshot lists Add staff-only list pages for backup runs and snapshots with practical filters, then wire the dashboard summary cards and latest-runs panel to those overviews. This gives the dashboard real drill-down paths for run and snapshot counts instead of leaving the data only partially visible on the first screen. Refs #23
2026-05-21 11:52:35 +02:00
path("runs/", views.runs_list, name="runs_list"),
(feature) add Django detail views for backup runs and snapshots Add staff-only run and snapshot detail pages so scheduler and command output can be inspected from the Django UI. Link dashboard and host detail tables to the new detail views, including snapshot/base relationships and linked backup runs. Render stored result and metadata JSON in readable form and cover the new inspection views with tests.
2026-05-19 12:31:47 +02:00
path("runs/<int:run_id>/", views.run_detail, name="run_detail"),
(feature) Add live refresh for run detail status Add a server-rendered run detail partial and a small vanilla JavaScript refresh hook so active backup runs update status, controls, timing, and rsync log output without a full page reload. Document the Django-template-first refresh pattern for future control panel work. Refs #36
2026-05-21 15:10:37 +02:00
path("runs/<int:run_id>/live/", views.run_detail_live, name="run_detail_live"),
(feature) Link rsync logs from backup run detail Record the final rsync log path for successful real backup runs, matching the existing dry-run and failure result payloads. Add a staff-only run log endpoint and surface the link on run detail pages, including fallback log discovery for older runs based on snapshot_path. Cover direct log links and inferred scheduled backup logs with view tests.
2026-05-20 00:09:59 +02:00
path("runs/<int:run_id>/rsync-log/", views.run_rsync_log, name="run_rsync_log"),
(feature) Add cancellable backup runs and clearer dry-run logs Add a cancel action for queued and running backup runs. Queued runs are cancelled immediately, while running runs are marked for cancellation and the worker terminates the active rsync process group. Make dry-run log paths run-specific and add a defensive default dry-run timeout so stuck dry-runs do not remain running indefinitely. Remove rsync exit codes from run overview tables while keeping detailed diagnostics available on the run detail payload.
2026-05-19 20:46:10 +02:00
path("runs/<int:run_id>/cancel/", views.cancel_run, name="cancel_run"),
(release) Add review resolution for operational tasks Add reviewed state for failed/warning runs and incomplete snapshot records, then use it to clear dashboard and host “need review” tasks after an operator has acknowledged them. Expose Mark reviewed actions on run detail and host retention warnings, keep reviewed records available for audit/debug, and exclude reviewed problem runs from operational counts and latest issue summaries. Refs #19 Refs #8
2026-05-21 03:34:41 +02:00
path("runs/<int:run_id>/resolve-review/", views.resolve_run_review, name="resolve_run_review"),
path(
"hosts/<str:host>/resolve-incomplete-reviews/",
views.resolve_host_incomplete_reviews,
name="resolve_host_incomplete_reviews",
),
(ui) Add dashboard-linked run and snapshot lists Add staff-only list pages for backup runs and snapshots with practical filters, then wire the dashboard summary cards and latest-runs panel to those overviews. This gives the dashboard real drill-down paths for run and snapshot counts instead of leaving the data only partially visible on the first screen. Refs #23
2026-05-21 11:52:35 +02:00
path("snapshots/", views.snapshots_list, name="snapshots_list"),
(feature) add Django detail views for backup runs and snapshots Add staff-only run and snapshot detail pages so scheduler and command output can be inspected from the Django UI. Link dashboard and host detail tables to the new detail views, including snapshot/base relationships and linked backup runs. Render stored result and metadata JSON in readable form and cover the new inspection views with tests.
2026-05-19 12:31:47 +02:00
path("snapshots/<int:snapshot_id>/", views.snapshot_detail, name="snapshot_detail"),
(feature) Add staff-only JSON inspection API Expose lightweight Django JSON endpoints for hosts, snapshots, and backup runs using the existing admin/staff authentication boundary. Include filters for snapshot and run inspection, return resolved snapshot base metadata, and document the new /api/ entrypoint. Add endpoint tests for authentication, host summaries, snapshot lineage payloads, and run filtering.
2026-05-19 11:43:50 +02:00
path("api/", api.api_index),
(feature) Add staff-only service status API Add /api/status/ for quick inspection of database backend, object counts, latest backup run, and latest scheduler activity. Link it from the API index and reuse schedule serialization between host summaries and status output. Cover the endpoint with a focused API test and document the new status URL.
2026-05-19 11:46:22 +02:00
path("api/status/", api.status),
(feature) Add staff-only JSON inspection API Expose lightweight Django JSON endpoints for hosts, snapshots, and backup runs using the existing admin/staff authentication boundary. Include filters for snapshot and run inspection, return resolved snapshot base metadata, and document the new /api/ entrypoint. Add endpoint tests for authentication, host summaries, snapshot lineage payloads, and run filtering.
2026-05-19 11:43:50 +02:00
path("api/hosts/", api.hosts),
path("api/snapshots/", api.snapshots),
path("api/runs/", api.runs),
feat: add Django backend foundation and Docker runtime Add a Django admin-backed management layer for pobsync configs, runs, snapshots, and schedules. Keep the existing CLI engine as the execution source of truth, add import/run management commands, and provide SQLite default plus optional MariaDB Docker Compose support.
2026-05-19 04:48:13 +02:00
path("admin/", admin.site.urls),
]
Reference in New Issue Copy Permalink