General parameters¶
Configuration files¶
The default configuration file is conf/config.inc.php
, it contains all default values.
To edit configuration, you should create conf/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
conf/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 conf/
, for example conf/en.inc.php
.
Dates¶
You can adapt how dates are displayed with specifiers (see strftime reference):
$date_specifiers = "%Y-%m-%d %H:%M:%S (%Z)";
Graphics¶
Logo¶
You change the default logo with your own. Set the path to your logo in $logo
:
$logo = "images/ltb-logo.png";
Background¶
You change the background image with your own. Set the path to image in $background_image
:
$background_image = "images/unsplash-space.jpeg";
Custom CSS¶
To easily customize CSS, you can use a separate CSS file:
$custom_css = "css/custom.css";
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.
Smarty¶
You need to define where Smarty is installed:
define("SMARTY", "/usr/share/php/smarty3/Smarty.class.php");
Notify administrator by mail¶
It is possible to provide mail of administrator to service-desk using a HTTP header.
$header_name_notify_admin_by_mail is name of header that will be provided to cgi script as HTTP_$header_name_notify_admin_by_mail to set administrator mail from webserver.
$header_name_notify_admin_by_mail = "SSP-Admin-Mail";
Using Apache, we may set such header using the following:
<VirtualHost *:80>
ServerName ssp.domain1.com
RequestHeader setIfEmpty SSP-Admin-Mail admin@example.com
[...]
</VirtualHost>
Using Nginx, nginx take normalized cgi param naming, ie uppercase and - replaced to _. we could use instead:
server {
[...]
location ~ \.php {
fastcgi_param HTTP_SSP_ADMIN_MAIL admin@example.com;
[...]
}