1 Requirements and Prerequisites
Frank Harris edited this page 2026-06-20 13:04:55 -05:00

Requirements and Prerequisites

This page collects the practical prerequisites for running the GSP panel. It is based on the original OGP installation documentation and verified against the current GSP environment checker in Panel/Panel/check.php.

Required Platform

  • Linux web server
  • Apache or a compatible web server
  • PHP
  • MySQL or MariaDB
  • Shell utilities used by the panel

The current panel source strongly indicates Linux as the primary supported panel host environment.

Current PHP Baseline

The current environment checker defines:

  • minimum recommended PHP version: 8.3.0

If a different PHP baseline is adopted later, verify Panel/Panel/check.php and Panel/Panel/INSTALL_README.md.

Required PHP Extensions

The current checker explicitly tests for these PHP extensions or capabilities:

  • mysqli
  • curl
  • gd
  • mbstring
  • zip
  • xml
  • json
  • openssl
  • fileinfo
  • session

It also checks for:

  • xmlrpc as an optional or warning-level dependency in the current code path
  • PEAR availability

If packaging differs by distribution, install the equivalent extension names for that OS and PHP version.

Web Server Requirements

For Apache deployments, enable:

  • mod_rewrite

The original OGP installation guidance assumed Apache, and the current GSP checker still validates rewrite support. If a compatible alternative web server is used, verify the equivalent routing and PHP handling manually.

Database Requirements

  • MySQL or MariaDB server
  • a database and user account for the panel installer
  • permission to create tables with the configured prefix

Current GSP defaults to:

  • table prefix gsp_

Required Linux Commands

The current checker looks for these commands:

  • unzip
  • tar
  • screen
  • sudo
  • subversion
  • git
  • rsync
  • mysql

These should be available in the panel host environment before installation or before using the affected features.

Filesystem And Permission Requirements

The current checker verifies write access to:

  • includes/
  • modules/
  • upload/
  • cache/
  • log/
  • temp/
  • includes/config.inc.php

Practical implications:

  • the web server user must be able to write the configuration file during installation
  • runtime cache, upload, temp, and log directories must remain writable
  • permissions should be tightened after installation as far as the panel runtime allows

Common Package Baseline

The current Ubuntu 24.04 install notes in Panel/Panel/INSTALL_README.md use:

  • apache2
  • mysql-client
  • unzip
  • tar
  • screen
  • sudo
  • subversion
  • git
  • rsync
  • php8.3
  • php8.3-mysql
  • php8.3-gd
  • php8.3-curl
  • php8.3-mbstring
  • php8.3-zip
  • php8.3-xml
  • php8.3-xmlrpc
  • php-pear
  • libapache2-mod-php8.3

Version-specific package names should be verified for the current GSP deployment target.

Agent-Side Dependencies

The original OGP installation docs document a separate set of dependencies for the remote agent layer, including Perl packages and utility tools on the host machine. That separation still matters conceptually for GSP, but the exact current agent package list should be verified against the active GSP agent repository before publishing a production install procedure.

Verification Checklist

Before running the installer:

  1. PHP meets or exceeds the current checked version.
  2. Required PHP extensions are installed.
  3. Apache rewrite support or equivalent routing is enabled.
  4. Database access is ready.
  5. Required shell utilities exist in PATH.
  6. Writable panel directories are writable by the web server.

Needs Verification

  • exact non-Apache deployment guidance for Nginx or other web servers
  • current agent package matrix by Linux distribution
  • whether xmlrpc remains optional long-term or becomes removable in a future release