Files
gallery-organizer-web/specs/001-archive-curator/quickstart.md
Danilo Reyes 070a3633d8 init
2026-02-07 06:01:29 -06:00

1.3 KiB

Quickstart: Archive Curator (Phase 1)

Purpose

Run the service in a safe, local-only configuration and confirm read-only browsing, untagged review, and audit visibility behaviors.

Prerequisites

  • Local archive directories available (untagged, whitelisted, kept, trash)
  • Download list file path available
  • Nix installed and flake support enabled

Setup Steps

  1. Configure required paths and safety flags:

    • untagged root
    • whitelisted root
    • kept root
    • trash/staging root
    • download list file path
    • audit log path
    • state database path
    • read-only mode
    • hard delete enabled (default off)
  2. Start the service via NixOS module or local run target.

  3. Open the web UI on the configured bind address and port.

Smoke Checks

  • Read-only mode blocks all mutations while allowing browsing.
  • Untagged directory collage loads with directory name, size, file count, and samples.
  • Resample changes the collage without leaving the directory.
  • Preview/confirm flow is required before any destructive action.
  • Audit view shows recent actions with paths and timestamps.

Safety Verification

  • Whitelisted directories cannot be deleted by directory-level actions.
  • Deletions are staged to trash by default.
  • List-file edits are previewed, optional, and case-insensitive after trimming surrounding whitespace.