=========================================================================
   G I Z M I X   P A C K A G E   |   I N S T A L L A T I O N   G U I D E
=========================================================================

Thank you for downloading the Gizmix Audio/Visual Engine. 
Follow this guide to initialize your instance.


[ 1. SERVER REQUIREMENTS ]
-------------------------------------------------------------------------
This system is designed to run on a LAMP environment (Linux, Apache, MySQL, PHP).

If you are setting up a fresh server (e.g., Ubuntu), please refer to this 
guide for setting up the required stack:

LINK: https://www.digitalocean.com/community/tutorials/how-to-install-lamp-stack-on-ubuntu

REQUIRED MODULES:
- PHP 7.4 or higher
- Extensions: mysqli, json, mbstring, gd
- FFMPEG (installed on the system path for audio processing)


[ 2. EXTRACTION & DIRECTORY SETUP ]
-------------------------------------------------------------------------
The package comes as a compressed tarball. 

CRITICAL: 
The extracted folder is named "site_root". You MUST rename this folder 
to match your specific domain, subdomain, or installation directory name 
before proceeding.

COMMAND LINE EXAMPLE:

1. Extract the package in desired directory:
   $ tar -xzvf gizpack10.tar.gz

2. Rename the directory (replace 'your_domain_folder' with your actual name) if needed:
   $ mv site_root your_domain_folder

3. Enter the directory:
   $ cd your_domain_folder

4. Set permissions to install:
   $ sudo chown -R www-data:www-data .
   $ sudo chmod -R +x .


[ 3. RUNNING THE INSTALLER ]
-------------------------------------------------------------------------
1. Navigate to your web browser.
2. Access the installation wizard at:
   https://your-domain.com/your_domain_folder/install/index.php

THE WIZARD PROCESS:

   STEP 1: INITIALIZE CORE
   - The system welcomes you and prepares the installation process.

   STEP 2: SYSTEM CALIBRATION (Diagnostics)
   - Checks PHP version, write permissions, and FFMPEG availability.
   - You must pass all checks to proceed.

   STEP 3: LIBRARY LINK (Database)
   - Enter your Database Host, Name, User, and Password.
   - The installer will verify the connection.

   STEP 4: SYNTHESIS (Deployment)
   - The system extracts the internal 'strTREE' package to your root.
   - It automatically injects your DB credentials into:
     > /SRC/includes/database.php
     > /config/params.php
   - It attempts to lock these files (chmod 444) for security.

   STEP 5: OUTPUT READY
   - Final confirmation. The installer deletes temporary artifacts.


[ 4. POST-INSTALLATION & CUSTOMIZATION ]
-------------------------------------------------------------------------
Once the wizard completes, your system is live. However, you must manually 
configure your site's identity.

1. Open the configuration file:
   /config/params.php

2. You may need to temporarily unlock write permissions if the installer 
   locked them:
   $ chmod 644 config/params.php

3. Edit the following variables to match your project:
   - $site_title      (Your visual title)
   - $site_name       (Your system name)
   - $default_domain  (Your URL)
   - $_root           (Your full path)
   - $intro_title     (Homepage headline)
   - $intro_expl      (Homepage description)

4. Save the file and re-lock it for security:
   $ chmod 444 config/params.php


[ 5. SUPPORT ]
-------------------------------------------------------------------------
For advanced configuration, troubleshooting, or bug reports, please 
contact the development team directly.

CONTACT FORM: https://gizmix.org/#scrollcontact

=========================================================================