Skip to content

🛠️ firmflow. Technical Manual (On-Premise Administration)

This manual provides instructions for administrators to maintain, backup, and scale the firmflow. on-premise installation.


1. System Maintenance

Logging

  • Application Logs: Accessed via docker logs firmflow-app or kubectl logs deployment/firmflow.
  • Audit Logs: Viewed in the Support Portal UI or directly in the AuditLog database table.

Backup & Recovery

Database Backup (PostgreSQL)

To run a manual backup of the firmflow database:

docker exec -t firmflow-db pg_dumpall -c -U postgres > firmflow_backup_$(date +%Y%m%d).sql

Document Storage Backup

  • If using Local Storage: Backup the uploads/ directory on the host machine.
  • If using NAS/S3: Ensure the underlying storage provider has snapshots enabled.

2. Scaling & High Availability

CPU/Memory Scaling

Modify the resources section in values.yaml (Helm) or deployments.yaml to increase limits.

resources:
  limits:
    cpu: "2"
    memory: "4Gi"

Replica Scaling

For enterprise workloads, increase the number of pod replicas:

kubectl scale deployment/firmflow --replicas=3


3. Disaster Recovery (DR)

Recovery Procedure

  1. Provision a new server with the hardware requirements specified in the Implementation Playbook.
  2. Install Docker/Kubernetes.
  3. Restore the PostgreSQL database: psql -U postgres < firmflow_backup.sql.
  4. Restore the uploads/ directory.
  5. Re-activate the license using the vendor-supplied activation key.

4. Troubleshooting

Symptom Probable Cause Resolution
AI Analysis fails No outbound internet Verify port 443 access to googleapis.com.
DB Connection error Network latency/Down Check DATABASE_URL and database service health.
License Error Hardware mismatch Regenerate license if server hardware has changed.
Slow upload Network latency Check mobile network health or internal LAN congestion.

For technical support, contact the Toraa Global support desk at support@toraaglobal.com.