Skip to content

📖 firmflow. Implementation & Migration Playbook

This playbook provides standardized procedures for firm IT departments to deploy, configure, and migrate data to firmflow. On-Premise.

1. Environment Readiness (Pre-Installation)

Scale Users CPU RAM Storage
Small 1-10 4 Cores 8 GB 250 GB SSD
Medium 11-50 8 Cores 16 GB 1 TB NVMe
Enterprise 50+ 16 Cores 32 GB+ 5 TB+ RAID 10

Software Prerequisites

  • OS: Ubuntu 22.04 LTS or Windows Server 2022 (with WSL2).
  • Containerization: Docker Desktop or k3s (Lightweight Kubernetes).
  • Network: Port 3000 (App) and 5432 (DB) must be reachable within the firm's LAN.
  • External Access: Outbound HTTPS (Port 443) to *.googleapis.com for SmartRequestAI™.

2. Installation Procedures

Option A: Docker Compose (Quick Start)

  1. Clone the repository to the production server.
  2. Configure .env with firm-specific secrets:
  3. AUTH_SECRET: Generate a secure string.
  4. DATABASE_URL: Point to the local PostgreSQL container.
  5. STORAGE_DRIVER: Set to local or nas.
  6. LICENSE_SECRET: Provided by firmflow vendor.
  7. Run docker-compose up -d.

Option B: Helm (Enterprise Scale)

  1. Install the firmflow chart using the provided local repository.
  2. Update values.yaml for high-availability database and persistent volume mounts.
  3. Run helm install firmflow ./kubernetes/firmflow.

3. Legacy Data Migration

Process Overview

  1. Inventory: Catalog existing paper and folder-based client records.
  2. Standardization: Rename folders to match Client Name / RC Number.
  3. Ingestion: Use the migration-utils.ts to bulk upload records.

Supported Ingestion Methods:

  • Folder Sync: Mount a legacy SMB drive and run the sync-legacy-folders script.
  • CSV Import: Import client metadata and tax history via standardized CSV templates.

4. Post-Migration Checklist

  • [ ] Verify Document Encryption (AES-GCM checks).
  • [ ] Test LDAP Connection to Firm Active Directory.
  • [ ] Activate Node-Locked License.
  • [ ] Conduct staff training on SmartRequestAI™ workflows.
  • [ ] Schedule first automated backup job.