Skip to end of metadata
Go to start of metadata
Table of contents

This page describes required web server configuration that you need in order to install Kayako Fusion, Kayako Resolve or Kayako Engage.

Server software requirements

PHP

          PHP 5.2.8 or later is required.

The Reports features require PHP 5.3. We will be phasing out support for PHP 5.2, but for now it is possible to get by.
MySQL server

          MySQL version 5.0 or later (we recommend the very latest stable release)

PHP decoders

  Portions of the Kayako code are encoded and require a PHP decoder in order to run. There are two available, both free.

          Zend Optimizer (Supported PHP version: 5.2.x or earlier)

          OR

          ionCube Loader (Supported PHP version: 5.3.x or earlier)

 Web server

          Any web server daemon - such as Apache, nginx, IIS which is fully compatible with the required PHP configuration.

Required PHP settings

PHP caches and accelerators 

Kayako accesses many scripts spread across many files for each connection. If you do not have a PHP cache, unless your web server is very finely tuned you will find the application to be less responsiveness. We strongly recommend that your web server has a PHP cache like xcacheapc or eaccelerator installed. We find that xcache is the easiest to install and most readily available, and use it ourselves.

Required Apache server settings

If you have mod_security installed on your apache web server, mod_security must be disabled or your Kayako helpdesk files whitelisted (exempt from all mod_security rules).

Required MySQL settings

  • sql-mode : not strict(need to edit MySQL configuration file)

Required PHP modules

Most of these modules are included by default. However, we have compiled a list of those which are definitely required by Kayako for good measure:

Server hardware requirements

It is very difficult to quantify server hardware requirements for running Kayako. Our customers run their Kayako helpdesk on dedicated hardware, shared hardware or virtualized environments with restricted resource access.

Whichever environment you choose, assuming your database server will be run from the same hardware, Kayako will need:

  • At least one gigabyte of RAM (allowing for operating system processes)
  • At least around 6 gigabytes of hard disk space available for your helpdesk (realistically, you should allow more than this for future growth)
  • Access to the equivalent of at least one 1 GHz CPU core

So, what's recommended?

What we use

The web application element of Kayako is platform independent, so the server requirements will remain the same for Windows as well as Unix/Linux servers. Which is best for you will depend on a variety of factors - including resources, expertise and what fits within your organization.

That said, we do have our own favourite configuration, which is in part used for our OnDemand platform:

Component What we use Why
Operating system CentOS It is well supported, secure, fast and easily configurable.
Web server nginx (with php-fpm) nginx is lightening fast and much more lightweight than Apache and IIS.
PHP version PHP 5.3 PHP 5.3 is now required for the new ?Reports, and we also find PHP 5.3 to be faster than PHP 5.2.
PHP cache/accelerator xcache We find xcache to be lightweight and does the job very well.

What our customers use

Our customers use a huge variety of platforms and configurations, including both Linux and Windows. Here is what we have identified to be the most common web server setup: 

Component What we use Why
Operating system Linux (CentOS, Red Hat Linux, Debian, Ubuntu) Linux is free, well supported, fast and secure. That's why it is the most popular web server amongst our customers and the world.
Web server Apache (for Linux and Windows) Apache is the world's most popular web server, and very easy to configure. It is prepackaged into most Linux distributions, making it the quickest web server to get started with.
PHP version PHP 5.3  
PHP cache/accelerator xcache Most likely based on our recommendation, and also because it is fairly simple to install.

In summary, the typical LAMP server stack is most popular with our Download customers.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Feb 02, 2011

    Additional php.ini settings must be set:

    allow_url_fopen = On
    allow_url_include = On

    To prevent:

    [Warning]: file_get_contents() [<a href='function.file-get-contents'>function.file-get-contents</a>]: URL file-access is disabled in the server configuration (ProfileImage/class.SWIFT_ProfileImage.php:99)

  2. Feb 22, 2011

    As of this posting, Fusion is NOT compatible with Zend Guard Loader for PHP 5.3. IonCube is generally not a good choice for performance. For those who tried PHP 5.3 and got this:

    Fatal error: Incompatible file format: The encoded file has format major ID 3, whereas the Loader expects 4 in /var/www/html/__swift/swift.php on line 0

    Kayako needs to encode Fusion separately for Zend Guard Loader in order for it to work. If you absolutely must have PHP 5.3, ionCube is the only option at this time.

  3. Mar 15, 2011

    Hi Mike,

    We degraded PHP 5.3 to PHP 5.2 and then installed fusion along with ZendOptimizer. We are using the following build versions :

    1. Fusion : fusion_stable_zendclosed_4_01_139

    2. ZendOptimizer : ZendOptimizer-3.3.9-linux-glibc23-x86_64

     Everything seems to be fine as of now. Should PHP version be an issue later. If yes, is Ioncube the only option ?

  4. May 21, 2011

    Hello,

    while installing kayako fusion 4.01.204 an it returned an error as it could not find the xml_parser_create function. I had to install an extra requirement for this: xml.

    It is maybe a good idea to update the requirement list accordingly.

    Best regards,

    Steven

    1. May 25, 2011

      Thank you - we've added that.

  5. Jul 22, 2011

    Additional php.ini settings must be set:

    magic_quotes_runtime = Off
    magic_quotes_sybase = Off

    To prevent:

    [Notice]: Trying to get property of non-object (Mail/class.SWIFT_Mime.php:170)

    [Notice]: Trying to get property of non-object (Mail/class.SWIFT_Mime.php:171)

    [Notice]: Trying to get property of non-object (Mail/class.SWIFT_Mime.php:177)

    [Notice]: Trying to get property of non-object (Mail/class.SWIFT_Mime.php:246)

    in Resolve 4.01.240

  6. Dec 07, 2011

    Hi,

    Is there a specific reason why no files are available for Zend Loader on PHP 5.3?

    Zend Guard 5.5 will give you the option within the same license to encode files for Zend Optimizer (5.2) or Zend Loader (5.3), so I can't really see the issue here.

    Best regards,

    Eelco

    1. Dec 07, 2011

      Zend Guard 5.5 release came out two weeks ago.
      I think, you just have to wait a little.

      1. Dec 07, 2011

        Hi,

        Not quite, Zend released Guard 5.5 with 5.3 support in Nov 2010. The runtime loader (Zend Guard Loader) was released somewhat later if I'm correct.

        Best regards,

        Eelco

  7. Dec 09, 2011

    Just wanted to add here. Kayako and Apache in general runs MUCH better on PHP 5.3 with Ioncube. Just switched from Zend Optimizer and PHP 5.2 a few weeks ago and am no longer getting segfaults every 5 minutes in Apache logs.

    I would strongly recommend against PHP 5.2 as Kayako has.

    Note: PHP 5.3 requires you to set the server time zone in php.ini to prevent warnings in the logs.

    1. Dec 12, 2011

      Hi Mike,

      Segmentation faults can be caused by various things, it may be a combination of Apache modules / plugins which interfere with each other.

      However, Kayako runs fine on PHP 5.2 with Zend Optimizer.

      Regarding timezone settings, the requirement to set a timezone is since PHP 5.1.0. Since 5.3.0, PHP throws an e_warning instead of an e_strict. The reason you see them now is that you probably didn't log e_strict-level errors.

      Best regards,

      Eelco

  8. Jan 25, 2012

    Also to use PHP GD functions to generate the CAPTCHA image you must have FreeType installed. Otherwise, you will get no CAPTCHA image displayed. This should be added to the requirements list.

    1. Jan 30, 2012

      Thank you Brandon - we've added that.