docs: initialize project

2026-03-26 09:36:14 +01:00
commit 4aa632a6d7
1 changed files with 59 additions and 0 deletions
@@ -0,0 +1,59 @@
+# Ready2Blob
+
+## What This Is
+
+Ready2Blob is a pure frontend web app that helps IT professionals deploy rclone onto end-user PCs. It provides a step-by-step configuration wizard that generates rclone config files and deployment scripts (PowerShell for Intune and/or RMM tools) ready to push via enterprise deployment platforms.
+
+## Core Value
+
+An IT pro can go from zero to a deployable rclone setup in minutes — without needing to know rclone's config syntax or PowerShell deployment conventions.
+
+## Requirements
+
+### Validated
+
+(None yet — ship to validate)
+
+### Active
+
+- [ ] Multi-step wizard guides user through rclone backend selection and configuration
+- [ ] Supports any rclone-compatible storage backend (Azure Blob, S3, OneDrive, etc.)
+- [ ] Generates a valid rclone.conf file
+- [ ] Generates PowerShell deployment script for MS Intune (with optional rclone install)
+- [ ] Generates PowerShell deployment script for RMM tools (with optional rclone install)
+- [ ] User can choose which output files to download
+- [ ] Optionally includes rclone installation in the deployment script
+- [ ] All config generation runs client-side (no backend, static site)
+- [ ] Credentials/secrets are written plain text into the config (with a security notice)
+
+### Out of Scope
+
+- User accounts / saved templates — no backend, no persistence
+- Server-side generation — everything runs in the browser
+- rclone version management / auto-update logic — out of scope for v1
+- Non-Windows targets — scripts target Windows endpoints only for v1
+
+## Context
+
+- Project name "Ready2Blob" hints at Azure Blob as a primary use case, but the tool is designed to support all rclone backends
+- Target audience: any IT professional (sysadmins, MSP techs, internal IT)
+- Deployment platforms: MS Intune (Win32 app or PS script) and generic RMM tools (NinjaRMM, Datto, etc.)
+- rclone config files are INI-like text files; generation is purely string manipulation, no server needed
+- Secrets (storage account keys, SAS tokens, OAuth tokens) go directly into the config — user is responsible for handling securely post-download
+
+## Constraints
+
+- **Architecture**: Pure static frontend — no backend, no server required
+- **Target OS**: Windows endpoints only (scripts are PowerShell)
+- **Secrets**: Plain text in generated files — UI must display a clear security warning before download
+
+## Key Decisions
+
+| Decision | Rationale | Outcome |
+|----------|-----------|---------|
+| Pure frontend (no backend) | Simpler hosting, no data retention risk with credentials | — Pending |
+| Support all rclone backends | Not Azure-only despite project name — broader utility | — Pending |
+| Optional rclone install in scripts | Different orgs have different baseline images | — Pending |
+
+---
+*Last updated: 2026-03-26 after initialization*