Skip to content

Before Installation

The installation of Data Focus consists of 9 key steps. For a successful installation, each step must be completed in the correct order.

Warning

If you're installing on Windows Server, please update the Powershell 6.0 or newer. For update you can use the msi package on scripts directory or visit aka.ms/PSWindows

You must have sudo rights to execute the installation scripts. Using the root user for installation is not recommended.

The steps are outlined below.

1. Docker Installation
2. Extracting Packages
3. Loading Packages
4. Hostname Configuration
5. HTTPS Configuration
6. Deployment
7. Keycloak Configuration
8. Monitoring

Environment-Specific Considerations

Choose your deployment type for specific requirements

Quick Setup Requirements:

  • Minimum hardware specifications are sufficient
  • HTTP configuration acceptable for testing
  • Standard VM settings work fine
  • No special backup requirements

Critical Production Requirements:

  • Enhanced hardware specifications recommended
  • HTTPS configuration mandatory
  • Special virtualization and storage considerations required

See detailed production requirements below

Supported Browser Versions

  1. Google Chrome

    • Latest Version: 128.0.6613.95
    • Previous Versions: 127.0.6533.125, 126.0.6478.98, 125.0.6422.112, 124.0.6367.102

  2. Mozilla Firefox

    • Latest Version: 128.0
    • Previous Versions: 127.0, 126.0, 125.0, 124.0

  3. Microsoft Edge

    • Latest Version: 128.0.2619.97
    • Previous Versions: 127.0.2651.51, 126.0.2592.87, 125.0.2535.71, 124.0.2478.51

  4. Safari (macOS)

    • Latest Version: 17.5
    • Previous Versions: 17.4, 17.3, 17.2, 17.1

Network Requirements

Data Focus is a web application that operates both at the backend and frontend. We utilize Nginx as a reverse proxy to manage traffic to our applications, including those running in Docker containers.

Ports Required

  • HTTP: 80
  • HTTPS: 443

Ensure that these ports are open and properly configured to allow seamless communication between clients and the application.

Hardware Requirements

Select a configuration to view details

  • CPUs: 8
  • Memory: 16 GiB
  • Disk: 100 GiB
  • Use Case: POC, and small-scale setups
  • CPUs: 16
  • Memory: 32 GiB
  • Disk: 500 GB SSD or NVME Storage
  • Use Case: Production deployments

Storage Specifications

Volume Requirements

For all deployments, we need two dedicated volumes on the host:

Mount Path Purpose Recommended Allocation
/datafocus Application data storage 40% of total storage
/var/lib/docker Docker storage 40% of total storage
Unallocated Reserved for future use 20% of total storage

These volumes must be dedicated to the OS, Docker, and application operations. This configuration ensures that even if the VM fails to boot, you can continue operations on a new VM by mounting these volumes.

Note

The recommended configuration ensures optimal performance and scalability for your applications.

Production-Specific Requirements

Additional Requirements for Production Deployments

If you're deploying Data Focus in a production environment, please review and implement the following additional requirements:

Virtual Infrastructure Settings

Virtualization Configuration

Resource Allocation:

  • CPU Overcommit: Maximum 2:1 ratio (recommended 1.5:1)
  • Memory Overcommit: Disabled or maximum 1.2:1 ratio
  • Vertical Scaling: Ensure resource allocation supports vertical scaling capabilities
  • Resource Reservation: Reserve minimum required CPU and memory

Backup and Snapshot Strategy

Data Protection Requirements

Mount Disk Snapshots:

  • Both /datafocus and /var/lib/docker volumes must be snapshot-capable
  • Pre-deployment snapshots: Mandatory before any updates
  • Regular snapshots: Daily incremental, weekly full snapshots
  • Retention policy: Minimum 14 days for production data
  • Recovery testing: Verify snapshot restore procedures regularly

Security and Network Hardening

Production Security

  • HTTPS Configuration: Mandatory (not optional) for production
  • SSL Certificates: Use valid certificates (avoid self-signed)
  • Firewall Rules: Restrict access to required ports only
  • Network Security: Implement proper network segmentation