SupportPal Documentation

Updating Config Files

SupportPal has a host of configuration files within the /config directory that are used to customise the software beyond the options available in the operator panel. This page contains details on how to update specific configuration files.

Updating Configuration Files

Updating configuration files, requires basic knowledge of PHP as you will need to manually update or create the appropriate /config/production/ file.

If we wanted to add a new configuration item to our /config/production/app.php file, by default the file should look something like below:

    <?php return [ 'key' => 'eH5kVisy6vKsxVIU4hlw9CeztsDBd2Q8', ];

To add the ticket_throttle_max_requests config item, you would append it to the end of the array like so:

    <?php return [ 'key' => 'eH5kVisy6vKsxVIU4hlw9CeztsDBd2Q8', 'ticket_throttle_max_requests' => 5000 ];

Configuration Files

Adding Trusted Redirect Hosts

In order to prevent unvalidated redirect requests when logging in to SupportPal, a trusted hosts file is used to determine whether to permit redirect requests. By default only the host that you're logging in to is permitted. It is possible to add additional hosts to the trust list, by creating the below configuration file.

App Configuration

The app.php file contains most application specific configuration items. This document provides an list of configuration items available in the app.php file, allowing you to modify them as necessary.

Changing Cache Store

SupportPal uses a file-based cache store to keep regularly requested data readily available and reduce the number of database calls. The used cache store can be changed to other available stores.

Changing File Storage Path

By default, SupportPal uses file-based storage in the /storage directory. In some cases, the storage location can be changed to another directory or a specialist system such as Amazon S3 or Memcached.

Configuring a Trusted Proxy

If your web servers sit behind a load balancer, HTTP cache, or other intermediary (reverse) proxy, SupportPal requires some additional configuration. For security reasons, the software must be informed of which proxies to "trust" before it will attempt to read the X-FORWARDED-* headers.

Configuring an Outbound Proxy

This page describes how to configure SupportPal such that it can communicate externally through an outbound proxy. This configuration is required to access servers outside the network such as our license server.

Email Configuration

The email.php file contains most application specific configuration items. This document provides an list of configuration items available in the file, allowing you to modify them as necessary.

Mail Configuration

The mail.php file contains outbound email specific configuration items. This document provides a list of configuration items available in the file, allowing you to modify them as necessary.

Session Configuration

The session.php file contains settings related to user and operator sessions. This document provides a list of configuration items available in the file, allowing you to modify them as necessary.