Skip to content

Latest commit

 

History

History
211 lines (146 loc) · 6.55 KB

prerequisites.rst

File metadata and controls

211 lines (146 loc) · 6.55 KB
Raw

Prerequisites

GLPI is a Web application that will need:

  • a webserver;
  • PHP;
  • a database.

Web server

GLPI requires a web server that supports PHP, like:

Apache configuration

Here is a virtual host configuration example for Apache 2 web server.

Warning

The following configuration is only suitable for GLPI version 10.0.7 or later.

<VirtualHost *:80>
    ServerName glpi.localhost

    DocumentRoot /var/www/glpi/public

    # If you want to place GLPI in a subfolder of your site (e.g. your virtual host is serving multiple applications),
    # you can use an Alias directive. If you do this, the DocumentRoot directive MUST NOT target the GLPI directory itself.
    # Alias "/glpi" "/var/www/glpi/public"

    <Directory /var/www/glpi/public>
        Require all granted

        RewriteEngine On

        # Ensure authorization headers are passed to PHP.
        # Some Apache configurations may filter them and break usage of API, CalDAV, ...
        RewriteCond %{HTTP:Authorization} ^(.+)$
        RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

        # Redirect all requests to GLPI router, unless file exists.
        RewriteCond %{REQUEST_FILENAME} !-f
        RewriteRule ^(.*)$ index.php [QSA,L]
    </Directory>
</VirtualHost>

Note

If you cannot change the Apache configuration (e.g. you are using a shared hosting), you can use a .htaccess file.

# /var/www/glpi/.htaccess
RewriteBase /
RewriteEngine On
RewriteCond %{REQUEST_URI} !^/public
RewriteRule ^(.*)$ public/index.php [QSA,L]

Nginx configuration

Here is a configuration example for Nginx web server using php-fpm.

Warning

The following configuration is only suitable for GLPI version 10.0.7 or later.

server {
    listen 80;
    listen [::]:80;

    server_name glpi.localhost;

    root /var/www/glpi/public;

    location / {
        try_files $uri /index.php$is_args$args;
    }

    location ~ ^/index\.php$ {
        # the following line needs to be adapted, as it changes depending on OS distributions and PHP versions
        fastcgi_pass unix:/run/php/php-fpm.sock;

        fastcgi_split_path_info ^(.+\.php)(/.*)$;
        include fastcgi_params;

        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
    }
}

lighttpd configuration

Here is a virtual host configuration example for lighttpd web server.

Warning

The following configuration is only suitable for GLPI version 10.0.7 or later.

$HTTP["host"] =~ "glpi.localhost" {
    server.document-root = "/var/www/glpi/public/"

    url.rewrite-if-not-file = ( "" => "/index.php${url.path}${qsa}" )
}

IIS configuration

Here is a web.config configuration file example for Microsoft IIS. The physical path of GLPI web site must point to the public directory of GLPI (e.g. D:\glpi\public), and the web.config file must be placed inside this directory.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <rule name="Rewrite to GLPI" stopProcessing="true">
                    <match url="^(.*)$" />
                    <conditions>
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php" appendQueryString="true" />
                </rule>
          </rules>
        </rewrite>
    </system.webServer>
</configuration>

Warning

The URL Rewrite module is required.

PHP

PHP Compatibility Matrix
GLPI Version Minimum PHP Maximum PHP
10.0.X 7.4 8.3

Note

We recommend to use the newest supported PHP release for better performance.

Mandatory extensions

Following PHP extensions are required for the app to work properly:

  • dom, fileinfo, filter, libxml, json, simplexml, xmlreader, xmlwriter: these PHP extensions are enable by default and are used for various operations;
  • curl: used for remote access to resources (inventory agent requests, marketplace, RSS feeds, ...);
  • gd: used for images handling;
  • intl: used for internationalization;
  • mysqli: used for database connection;
  • session: used for sessions support;
  • zlib: used for handling of compressed communication with inventory agents, installation of gzip packages from marketplace and PDF generation.

Optional extensions

Note

Even if those extensions are not mandatory, we advise you to install them anyways.

Following PHP extensions are required for some extra features of GLPI:

  • bz2, Phar, zip: enable support of most common packages formats in marketplace;
  • exif: enhance security on images validation;
  • ldap: enable usage of authentication through remote LDAP server;
  • openssl: enable email sending using SSL/TLS;
  • Zend OPcache: enhance PHP engine performances.

Security configuration for sessions

To enhance security, it is recommended to configure PHP sessions with the following settings:

  • session.cookie_secure: should be set to on when GLPI can be accessed on only HTTPS protocol;
  • session.cookie_httponly: should be set to on to prevent client-side scripts from accessing cookie values;
  • session.cookie_samesite: should be set, at least, to Lax, to prevent cookies from being sent cross-origin (across domains) POST requests.

Note

Refer to PHP documentation for more information about session configuration.

Database

Warning

Currently, only MySQL (5.7 minimum) and MariaDB (10.2 minimum) database servers are supported by GLPI.

In order to work, GLPI requires a database server.