SupportPal Documentation

Customisation

SupportPal has a number of features enabling developers to customise the software to their preference.

Custom Reports

We have provided a framework that lets you create your own reports, requiring some knowledge of PHP. Existing reports are stored in /app/Reports and there is a folder for each category.

Language Files

Language strings are stored in files within the /resources/lang directory, with each subdirectory representing a language supported by the application. The name of the directory must be ISO 639-1 compliant and can contain an optional regional identifier e.g. en_US or en_GB.

REST API

The SupportPal REST API can be used to access data and perform actions available in SupportPal from external applications.

SAML Authentication

SupportPal supports Secure Assertion Markup Language (SAML), which allows you to provide single sign-on (SSO) authentication for both users and operators. Different identity providers can be configured for both users and operators to allow greater flexibility.

SimpleAuth (SSO)

SimpleAuth is an automatic authentication method (single sign-on) to allow you to log users in to SupportPal from third party code/software. Useful in integrations with other client management software, it will generate a session for the user without them having to do anything or requiring the user's password.

Templates

SupportPal makes use of the Twig template system. Twig is a fast, secure and flexible template engine for PHP. Twig template files use the .twig file extension and are stored in the /resources/templates directory.

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.

Plugin Development

A plugin lets you add an individual bit of additional functionality, or allows modifying data that is being handled by the system. Follow our development guide to build your own useful plugin.