Faveo Helpdesk System Requirements

Faveo requires a fairly standard PHP & MySQL server setup in order to be installed and function correctly. If you require any assistance with setting up Faveo or determining if your system can support Faveo, please contact us.

1. PHP Version

PHP versions 8.2.x are supported.

For assistance installing a new version of PHP please contact your hosting provider or server administrator.

a. PHP Extensions

  • BCMath
  • Ctype
  • cURL
  • DOM
  • FileInfo
  • GD
  • Iconv
  • ionCube Loaders
  • JSON
  • Mbstring
  • OpenSSL
  • PDO
  • Tokenizer
  • XML
  • IMAP - When using email download to pull in department tickets
  • LDAP - When using LDAP operator authentication

PHP extensions differ depending on your server, your host and other system variable. For assistance installing missing extensions, please contact your hosting provider or server administrator.

b. PHP Settings

Your PHP configuration must adhere to the following settings:

  • ! allow_url_fopen Enabled To use Gravatar and other Faveo features, allow_url_fopen must be enabled in your PHP configuration.
  • IPv6 Support If your server has IPv6 networking support, this should be enabled by default. However if not please ensure you have the php-sockets extension enabled and PHP has been compiled with the --enable-ipv6 flag.
  • PNG & JPG Support If the PHP GD extension has been manually compiled, please ensure the --with-png-dir and --with-jpeg-dir flags are provided.
  • Disabled functions If you’re running under a particularly strict environment, please ensure that the following functions are not listed under the disable_functions directive: ini_set
  • Memory Limit A minimum of 128MB addressable memory is required to install and use Faveo. We recommend at least 256 MB. For assistance on modifying your PHP configuration, please contact your hosting provider or server administrator.

2. File Permissions

The following directories (and directories within recursively) must be writable by the PHP/Web Server process.

  • storage/
  • config/
  • bootstrap/cache/

a. Linux

We recommend setting the above directories to 755 permissions. You may also need to adjust the owner and group of the directories.

find /path/to/directory -type f -exec chmod 644 {} \;
find /path/to/directory -type d -exec chmod 755 {} \;
chown -R www-data:www-data /path/to/directory

If you're using CentOS, it has SELinux enabled by default which has measures in place to prevent httpd from writing to files, beyond the normal file permissions. You need to apply `httpd_sys_rw_content_t` to the directories: chcon -Rv --type=httpd_sys_rw_content_t /path/to/directory

b. IIS (Windows)

Right click on the folder containing the Faveo files, click Properties and then the Security tab. Provide full permission to IUSR and IIS_ISURS group apply the changes.

3. Database

a. Version

Latest version of Faveo supports MySQL Server 8.0.x and MariaDB 10.6.x .

b. User Privileges

For day to day use, the following database privileges are required.

  • DELETE
  • INSERT
  • LOCK TABLES
  • SELECT
  • UPDATE

For installing and upgrading the system, as well as activation and deactivation of plugins, the following additional privileges are required.

  • ALTER
  • CREATE
  • DROP
  • INDEX

c. Settings

We recommend the following MySQL configuration directives are changed:

  • max_allowed_packet - we recommend greater than 20MB to ensure large emails and embedded images are correctly handled. For assistance on modifying your MySQL configuration, please contact your hosting provider or server administrator.

4. Web Server

Faveo supports Apache, nginx and IIS web server, in all cases you must enable the mod_rewrite module for SEO friendly URLs.

Apache works out of the box, however for nginx and IIS you will need to install the rewrite rules.

Depending on the web server you are running, you may need to configure it further to run Faveo correctly - for example, ensuring all the HTTP request verbs (DELETE, GET, OPTIONS, POST and PUT) are enabled. Below is a list of common web servers and steps required for them.

a. Apache

Apache is supported out of the box.

b. Nginx

On nginx, please create a new virtual host for Faveo. The below is an example virtual host but will need editing for your specific environment (paths may vary): faveo.conf

c. IIS

On IIS, please create a web.config file in the root of your installation directory with the below contents: web.config

Required Extension(s) The URL Rewrite extension is required for the below web.config file to function correctly, otherwise a 500.19 error is likely to be shown when visiting Faveo (see Understanding HTTP Error 500.19).

5. Queue Driver

Currently, Faveo supports 3 queue drivers “sync,” “database,”  and “redis,” which are responsible for the core functionality of Faveo emails (incoming and outgoing), recurring emails, report generation, notifications, etc.

  1. Sync: where the only requirements are incoming and outgoing emails. It is appropriate for a Cpanel-like environment or any other shared hosting environment where installing and configuring the Redis database is not possible.

  2. Redis: preferred queue driver. It enables all the functionality of Faveo.

  3. Database: An alternative to Redis that works only on Windows servers

Redis requires “supervisor” daemon service we need to install the same for Redis to work smoothly.

6. Firewall Requirements

Please open outbound access to billing.faveohelpdesk.com

Updated: