2 Installation
Frank Harris edited this page 2026-06-20 13:04:55 -05:00

Installation

This page combines the original Open Game Panel installation guidance with the current GSP panel source tree and installer checks.

Overview

GSP has two major parts:

  • the panel, which provides the PHP web interface
  • one or more remote agents, which execute server actions on host machines

For the panel itself, start with a working Linux web server, install the required PHP extensions and database services, place the panel in the web document root, then complete the web installer.

  1. Prepare the web server and database host.
  2. Install the required packages listed in Requirements and Prerequisites.
  3. Place the panel source tree in the intended document root or subdirectory.
  4. Ensure writable paths and the configuration file are writable for installation.
  5. Run the environment check page.
  6. Run the installer page.
  7. Remove installation write access that is no longer needed.
  8. Connect the panel to remote agent hosts.

Current Ubuntu 24.04 Quick Install Example

The current Panel/Panel/INSTALL_README.md includes this package baseline for Ubuntu 24.04:

sudo apt update
sudo apt install -y 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
sudo a2enmod rewrite
sudo systemctl restart apache2

That package set matches the current GSP environment checker closely, but the exact package names should still be verified for the target operating system and PHP packaging model.

Manual Linux Web Installation

The upstream OGP wiki documents the classic manual installation model, which still matches the general panel architecture:

  1. Install Apache or a compatible web server.
  2. Install PHP and the required extensions.
  3. Install MySQL or MariaDB.
  4. Enable Apache rewrite support if Apache is used.
  5. Copy the panel files into the web root.
  6. Open the installer in a browser and complete database configuration.

Typical document-root placement examples:

  • /var/www/html/
  • /var/www/html/gsp/
  • another configured virtual-host document root

If the panel is deployed into a subdirectory rather than the root site, confirm the web server routing and permissions are correct before running the installer.

Environment Check And Installer

Current GSP ships two important web installer entry points:

  • Panel/Panel/check.php
  • Panel/Panel/install.php

Recommended flow:

  1. Open check.php first and clear every reported blocker.
  2. Open install.php.
  3. Enter the database connection details.
  4. Keep the default table prefix of gsp_ unless there is a deliberate reason to change it.
  5. Finish the installer and confirm the panel login page loads.

Filesystem Permissions

The current checker verifies these paths:

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

During installation, the web server user must be able to write the paths the installer needs. After installation, reduce permissions to the minimum required by normal runtime behavior.

Database Notes

  • MySQL and MariaDB are both reasonable targets for the panel database layer.
  • The current installer defaults to the gsp_ table prefix.
  • Legacy ogp_ prefixes may still appear in older documentation or compatibility paths, but new GSP installations should use gsp_.

Remote Agent Notes

The original OGP documentation separated panel installation from agent installation. That still applies to GSP in principle:

  • the panel is installed on the web server
  • agents are installed on the game-host machines

See Remote Servers and Agents for panel-side integration notes.

After Installation

Verify these items before treating the panel as ready:

  1. The login page loads without PHP warnings.
  2. check.php no longer reports missing requirements.
  3. The database tables were created with the expected prefix.
  4. Modules load in navigation without fatal errors.
  5. XML game configs validate and load correctly.
  6. A configured remote server can connect to the panel.