General parameters

Configuration files

The default configuration file is /etc/service-desk/config.inc.php, it contains all default values. To edit configuration, you should create /etc/service-desk/config.inc.local.php and override needed parameters:

<?php
// Override config.inc.php parameters below

?>

Warning

Do not copy config.inc.php into config.inc.local.php, as the first one includes the second. You would then create an infinite loop and crash your application.

Multi tenancy

You can load a specific configuration file by passing a HTTP header. This feature is disable by default. To enable it:

$header_name_extra_config = "SSP-Extra-Config";

Then if you send the header SSP-Extra-Config: domain1, the file /etc/service-desk/config.inc.domain1.php will be loaded.

Using Apache, we may set such header using the following:

<VirtualHost *:80>
   ServerName ssp.domain1.com
   RequestHeader setIfEmpty SSP-Extra-Config domain1
   [...]
</VirtualHost>

Using Nginx, we could use instead:

server {
    [...]
    location ~ \.php {
        fastcgi_param HTTP_SSP_EXTRA_CONFIG domain1;
        [...]
    }

Language

Tip

Lang is selected from browser configuration. If no matching language is found, the default language is used.

Set default language in $lang:

$lang = "en";

Tip

You can override messages by creating lang files in configuration directory:

conf/ directory for service-desk archive
/etc/service-desk directory for rpm/deb packages

For example, you can create a customized file: /etc/service-desk/en.inc.php.

Language is picked according to browser choice among the available ones. All languages are allowed by default, to restrict them add $allowed_lang array:

$allowed_lang = array("en");

Dates

Format

You can adapt how dates are displayed with specifiers (see strftime reference):

$date_specifiers = "%Y-%m-%d %H:%M:%S (%Z)";

The date displayed in javascript should be configured with the dayjs format (see https://day.js.org/docs/en/display/format):

$js_date_specifiers = "YYYY-MM-DD HH:mm:ss (Z)";

Timezone

You can adapt the default timezone for displaying all the dates (see the complete list of timezones):

$date_timezone = "UTC";

Graphics

Logo

You can change the default logo with your own. Set the path to your logo in $logo:

$logo = "images/ltb-logo.png";

Background

You can change the background image with your own. Set the path to image in $background_image:

$background_image = "images/unsplash-space.jpeg";

Favicon

You can change the favicon with your own. Set the path to your favicon in $favicon:

$favicon = "images/favicon.ico";

Custom CSS

To easily customize CSS, you can use a separate CSS file:

$custom_css = "css/custom.css";

Password inputs

When testing or resetting a password, the browser will prompt to remember the password. You can disable this behavior in your browser for Service Desk page, but if you need to change this on server side, a trick is needed. Password inputs are converted into text inputs but value is kept hidden.

To enable this trick:

$fake_password_inputs = true;

Custom templates

If you need to do more changes on the interface, you can create a custom templates directory and override any of template file by copying it from templates/ into the custom directory and adapt it to your needs:

$custom_tpl_dir = "templates_custom/";

To define a custom template paramter, create a config parameter with tpl_ prefix:

$tpl_mycustomparam = true;

And then use it in template:

<div>
{if $mycustomparam}
<p>Display this</p>
{else}
<p>Display that</p>
{/if}

Debug

You can turn on debug mode with $debug:

$debug = true;

Tip

Debug messages will be printed in server logs.

This is also possible to enable Smarty debug, for web interface issues:

$smarty_debug = true;

Tip

Debug messages will appear on web interface. You will also have many more messages in error logs.

Smarty

You need to define where Smarty is installed:

define("SMARTY", "/usr/share/php/smarty3/Smarty.class.php");