Skip to main content

Install Guide

Alternative ways​

Requirements​

If you are running a WordPress site, there is a 99.9% chance that Live Helper Chat will work just fine.

# Optional but recommended
php-phpiredis
php-imap
php-pecl-redis4
php-pecl-igbinary
php-geos
php-fpm
php-opcache

# Required
php-json
php-cli
php-gd
php-xml
php-common
php-pdo
php-pecl-zip
php-mysqlnd
php-mbstring
php
php-bcmath

Composer dependencies​

It's not required if you have downloaded a version with dependencies included.

If you are using a new Version with Mails support or any newer version from 3.30v. You have to run from lhc_web folder.

composer.phar install

If you are getting some like an incompatible php version. You can try to remove composer.lock file and then install

rm composer.lock
composer.phar install

Folders permissions​

  • After granting permission to write to the cache folder, you should see the following window. If you encounter a strange error instead of the installation page, please ensure that:
    • Your browser is pointing to the correct URL: index.php/site_admin/install/install.
    • You have given recursive write permission to the cache folder.

Try changing the owner to the Apache user or the user under which your HTTP server is running.

chown apache:apache -R cache/
chown apache:apache -R var/
chown apache:apache settings/
chmod -R 755 cache/

After that, you should see something like this:

​

Now, just grant permission to write to the required folders/files.

chmod 755 settings/
chmod -R 755 var/storage
chmod -R 755 var/userphoto
chmod -R 755 var/storageform
chmod -R 755 var/storageadmintheme
chmod -R 755 var/botphoto
chmod -R 755 var/bottrphoto
chmod -R 755 var/storageinvitation
chmod -R 755 var/storagedocshare
chmod -R 755 var/storagetheme
chmod -R 755 var/tmpfiles

After that, all items should be green.

Database settings​

On the next screen, you should see a similar window. The database has to be precreated.

​

Application initial settings​

You can fill up these settings according to your needs.

​

Install completed​

​

Installing composer dependencies for third party extensions, AWS translations​

From lhc_web folder run.

composer install

Uncomment those two lines by removing dashes lhc_web/index.php and lhc_web/cron.php.

Logging into the application​

After clicking Login here you should be presented with a login window.

​

Install url is always index.php/site_admin/user/login

Dashboard page​

This is the main application window.

​

Generating embed code​

Now, click on the settings icon ​ on the top menu. You should see this window.

​

Navigate to

Embed code -> Widget embed code (new)

You should see a window like this.

​

To enable proactive chat, check the option Check for operator invitation messages.

The embed code should look like this. If you copy this code, change install.livehelperchat.com/index.php to your installation path. 

<script>var LHC_API = LHC_API||{};
LHC_API.args = {mode:'widget',lhc_base_url:'//install.livehelperchat.com/index.php/',wheight:450,wwidth:350,pheight:520,pwidth:500,leaveamessage:true,proactive:true};
(function() {
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
var date = new Date();po.src = '//install.livehelperchat.com/design/defaulttheme/js/widgetv2/index.js?'+(""+date.getFullYear() + date.getMonth() + date.getDate());
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
})();
</script>

For more information and troubleshooting, please see the integration article.

Proactive invitation setup​

Navigate to:

System configuration -> Live help configuration -> Pro active chat invitations

Here is a demo configuration that we have on demo.livehelperchat.com. It includes the following settings:

  • A message is sent to the user after they spend 20 seconds on the page or have more than 2 pageviews.
  • A random profile from online operators is shown.
  • There are also delayed messages available. Delayed messages can be configured in the autoresponder section.
  • Additionally, there is a long auto delayed message set for 40 seconds. If no one accepts the chat during that period, a message is displayed indicating that all operators are busy.

You can see the proactive invitation setup on our demo installation.

​

And here is the instant auto-response message.
​

Here is the automatic auto-response message.

​

Desktop client​

Desktop application can be found at https://github.com/LiveHelperChat/electron It is based on electron framework and acts as a standalone browser and is much faster than chrome.

Further reading​

On windows IIS I get 404 error?​

Please refer to this comment. It might happen because of to many URL segments.

https://github.com/orgs/LiveHelperChat/discussions/1900#discussioncomment-9767891

Chat does not start?​

If you are running behind CloudFlare or any other proxy that influences the IP seen by Live Helper Chat, please enable it in the settings file.

https://github.com/LiveHelperChat/livehelperchat/blob/a60a3b485ed08650b9e081ed827998e050717e37/lhc_web/settings/settings.ini.default.php#L18

Widget content looks very small on my website?​

Make sure your website has viewport tag

<meta name="viewport" content="width=device-width, initial-scale=1">

My widget does not load?​

Try adding this to your .htaccess ile in the root folder lhc_web. If this folder does not exist, just place the .htaccess file in the same folder where the index.php file exists. It has to be placed in the Live Helper Chat folder, not the website.

AddType application/wasm .wasm

<Files ~ "\.(gif|jpe?g?|png|bmp|swf|css|js|svg|otf|eot|ttf|woff|woff2|swf|mp3|ogg|wasm|map|wav|pdf|ico|txt)$">
  Header always Set Access-Control-Allow-Origin "*"
  Header always Set Access-Control-Allow-Methods: "GET, POST, OPTIONS, PUT, DELETE"
  Header always Set Access-Control-Allow-Headers: "Origin, X-Requested-With, Content-Type, Accept, API-Key, Authorization"
</Files>

If, for some reason, the above solution does not work, try this without the always keyword.

AddType application/wasm .wasm

<Files ~ "\.(gif|jpe?g?|png|bmp|swf|css|js|svg|otf|eot|ttf|woff|woff2|swf|mp3|ogg|wasm|map|wav|pdf|ico|txt)$">
  Header Set Access-Control-Allow-Origin "*"
  Header Set Access-Control-Allow-Methods: "GET, POST, OPTIONS, PUT, DELETE"
  Header Set Access-Control-Allow-Headers: "Origin, X-Requested-With, Content-Type, Accept, API-Key, Authorization"
</Files>

Other possible reasons:

  • You have changed Chat configuration -> Misc -> Domains where script can be embedded. E.g example.com, google.com, but the embedded script is not listed in the domain.
  • You have enabled System configuration -> GEO Adjustment, but you have provided invalid data.
  • You have blocked yourself via System configuration -> Live help configuration -> Blocking -> Blocked users

What if you have to limitate the widget to few domain and subdomain?​

Embedded on multiple domains. More information

Chat was closed by an operator/visitor, but when the visitor starts a new chat, an old chat opens?​

Most likely, you have enabled Chat configuration -> Misc -> Reopen chat functionality enabled

More information

Install from the command line​

It is also possible to install from the command line.

Copy the install-cli.php script to the root folder (lhc_web if you pulled from github)

cp cli/install-cli.php install-cli.php

Copy the default example.settings.ini to settings.ini. Don't forget to modify them.

cp cli/example.settings.ini cli/settings.ini

Install Live Helper Chat

php install-cli.php cli/settings.ini

Installation under a subfolder​

If you are running a WordPress site and have nice URLs, you might need to allow access to the Live Helper Chat subfolder. Your .htacess file could look like this:

RewriteEngine On
# Previous rules
RewriteRule ^lhc_web/.*$ - [L]
# Afterward rules

If you experience logouts after some time being inactive. It can be that your main website uses same php session cookie name. You can change it in the settings file. Change in main settings file php_session_cookie_name to something like lhc_session_id

How to log in?​

To log in, point your browser to the directory where the application is installed. The URL address should look like: http://<your_domain>/index.php/site_admin/

If for some reason, you forgot password and password reminder does not work for you. You can execute this query. It will set admin (user_id 1) password to demo

UPDATE `lh_users` SET password = '$2y$10$IwnZfDcPm7nqvp/BLNmJietHT/TSHCRPXWHKFqheQfojwk4c4znVG' WHERE `id` = 1;

If you modified roles/groups/functions and you can't access the application, you can execute this query. It will set admin (user_id 1) to have all functions.

Error you might be getting is

You do not have permission to access the module "front" and use "use" function

Execute those queries. They will restore admin group/role and permissions for very first user in users list.

DELETE FROM `lh_group` WHERE `id` = 1;
DELETE FROM `lh_role` WHERE `id` = 1;
DELETE FROM `lh_grouprole` WHERE `id` = 1;
DELETE FROM `lh_groupuser` WHERE `id` = 1;

INSERT INTO `lh_group` (`id`, `name`, `disabled`, `required`) VALUES (1,'Admin',0,0);
INSERT INTO `lh_role` (`id`, `name`) VALUES (1,'Admin');
INSERT INTO `lh_grouprole` (`id`, `group_id`, `role_id`) VALUES (1,1,1);
INSERT INTO `lh_groupuser` (`id`, `group_id`, `user_id`) (SELECT 1,1,`lh_users`.`id` FROM `lh_users` ORDER BY `lh_users`.`id` ASC LIMIT 1);