Bitnami Live Helper Chat for Huawei

Enterprise Cloud

Description

Open source - Live Support chat for your website. Web and desktop clients. It

includes: co-browsing, XMPP notifications, GTalk, Jabber, Openfire, Skype,

Chrome extension, Node.js support, MySQL, PostgreSQL.

First steps with the Bitnami Live Helper Chat

Stack

Welcome to your new Bitnami application running on Huawei Enterprise Cloud!

Here are a few questions (and answers!) you might need when first starting

with your application.

What is the administrator username set for me to log in to the

application for the first time?

Username: user

What is the administrator password?

To obtain the administrator password, click the "Remote Login" menu option

next to the server name in the Huawei Cloud Server Console. This will launch

a new browser window with an encrypted login session. The application

password will be displayed on the login welcome screen.

What SSH username should I use for secure shell access to

my application?

SSH username: root

How to connect to the MySQL database?

You can connect to the MySQL database from the same computer where it is

installed with the mysql client tool.

mysql -u root -p

You will be prompted to enter the root user password. This is the same as the

application password.

Find out how to obtain application credentials.

How to debug errors in your database?

The main log file is created at /opt/bitnami/mysql/data/mysqld.log on the

MySQL database server host.

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and

restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without

any service name arguments to start all services:

sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the

service name as argument:

sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without

any arguments:

sudo /opt/bitnami/ctlscript.sh

How to create a full backup of Live Helper

Chat?

Backup

The Bitnami Live Helper Chat Stack is self-contained and the simplest option

for performing a backup is to copy or compress the Bitnami stack installation

directory. To do so in a safe manner, you will need to stop all servers, so this

method may not be appropriate if you have people accessing the application

continuously.

Follow these steps:

Change to the directory in which you wish to save your backup:

cd /your/directory

Stop all servers:

sudo /opt/bitnami/ctlscript.sh stop

Create a compressed file with the stack contents:

sudo tar -pczvf application-backup.tar.gz /opt/bitnami

Restart all servers:

sudo /opt/bitnami/ctlscript.sh start

You should now download or transfer the application-backup.tar.gz file to a

safe location.

Restore

Follow these steps:

Change to the directory containing your backup:

cd /your/directory

Stop all servers:

sudo /opt/bitnami/ctlscript.sh stop

Move the current stack to a different location:

sudo mv /opt/bitnami /tmp/bitnami-backup

Uncompress the backup file to the original directoryv

sudo tar -pxzvf application-backup.tar.gz -C /

Start all servers:

sudo /opt/bitnami/ctlscript.sh start

If you want to create only a database backup, refer to these instructions for

MySQL and PostgreSQL.

How to configure outbound email settings?

To configure outbound email, follow these steps:

Log in to the application as an administrator.

Click the "System Configuration" icon (next to the "Extra Modules" tab).

Select the "Mail Settings" in system tab.

At the "Mail Settings" subtab, configure whatever you want to appear as

the "From" address. For instance: help@mydomain.com

Select the "SMTP" tab.

Enable SMTP, clicking on the checkbox.

Configure the server to be used for outbound email. For example, to

configure a Gmail account, you could use the settings below. Replace

USERNAME and PASSWORD with your Gmail account username and

password respectively.

o SMTP Server - tls://smtp.gmail.com

o SMTP port - 465

o Login - USERNAME@gmail.com

o SMTP Password - PASSWORD

Click "Save" to save your changes or "Test" to send a test email and

save the settings.

To configure the application to use other third-party SMTP services for

outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

Troubleshooting Gmail SMTP issues

If you are using Gmail as the outbound email server and you are not able to

send email correctly, Google may be blocking sign-in attempts from your apps

or devices. Depending on whether or not you use Google Apps, the steps to

correct this will differ.

For Google Apps users

If you are a Google Apps user, you will need your administrator to allow users

to change the policy for less secure apps. If you are a Google Apps

administrator, follow these steps:

Browse to the Google Apps administration panel.

Click on "Security" and then "Basic settings".

Look for the section "Less secure apps" and then click on "Go to

settings for less secure apps".

Select "Allow users to manage their access to less secure apps".

For other Google users

If you do not use Google Apps, follow the steps in the following sections,

depending on whether 2-step verification has been enabled on the account or

not.

If 2-step verification has not been enabled on the account, follow these steps:

Browse to the "Less secure apps" page and log in using the account you

are having problems with. This option is typically required by many

popular email clients, such as Outlook and Thunderbird, and should not

be considered unsafe.

Select the "Turn on" option.

If 2-step verification has been enabled on the account, you have to generate

an app password. Follow these steps:

Browse to the "App passwords" page.

Click "Select app" and choose the app you're using.

Click "Select device" and choose the device you're using.

Click the "Generate" button.

Enter the app password on your device.

Click the "Done" button.

Here are other options you may try:

Browse to the web version of Gmail and sign in to your account. Once

you're signed in, try to enable access for the application again.

Browse to the "Unlock Captcha" function page and sign in with your

Gmail username and password.

Disable IMAP from the Gmail web server interface and enable it again.

How to upload files to the server with SFTP?

Although you can use any SFTP/SCP client to transfer files to your server, the

link below explains how to configure FileZilla (Windows, Linux and Mac OS X),

WinSCP (Windows) and Cyberduck (Mac OS X). It is required to use your

server's private SSH key to configure the SFTP client properly. Choose your

preferred application and follow the steps in the link below to connect to the

server through SFTP.

How to upload files to the server

How to enable HTTPS support with SSL

certificates?

NOTE: The steps below assume that you are using a custom domain name

and that you have already configured the custom domain name to point to your

cloud server.

Bitnami images come with SSL support already pre-configured and with a

dummy certificate in place. Although this dummy certificate is fine for testing

and development purposes, you will usually want to use a valid SSL certificate

for production use. You can either generate this on your own (explained here)

or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update

your server to use them. Follow these steps to activate SSL support:

Use the table below to identify the correct locations for your certificate

and configuration files.

Variable Value

Current

application URL https://[custom-domain]/

Example: https://my-domain.com/ or

https://my-domain.com/appname

Apache

configuration file /opt/bitnami/apache2/conf/bitnami/bitnami.conf

Certificate file /opt/bitnami/apache2/conf/server.crt

Certificate key file /opt/bitnami/apache2/conf/server.key

CA certificate

bundle file (if

present)

/opt/bitnami/apache2/conf/server-ca.crt

Copy your SSL certificate and certificate key file to the specified

locations.

NOTE: If you use different names for your certificate and key files, you should

reconfigure the SSLCertificateFile and SSLCertificateKeyFile directives in the

corresponding Apache configuration file to reflect the correct file names.

If your certificate authority has also provided you with a PEM-encoded

Certificate Authority (CA) bundle, you must copy it to the correct

location in the previous table. Then, modify the Apache configuration

file to include the following line below the SSLCertificateKeyFile

directive. Choose the correct directive based on your scenario and

Apache version:

Variable Value

Apache

configuration file /opt/bitnami/apache2/conf/bitnami/bitnami.conf

Directive to include

(Apache v2.4.8+)

SSLCACertificateFile

"/opt/bitnami/apache2/conf/server-ca.crt"

Directive to include

(Apache < v2.4.8)

SSLCertificateChainFile

"/opt/bitnami/apache2/conf/server-ca.crt"

NOTE: If you use a different name for your CA certificate bundle, you should

reconfigure the SSLCertificateChainFile or SSLCACertificateFile directives in

the corresponding Apache configuration file to reflect the correct file name.

Once you have copied all the server certificate files, you may make

them readable by the root user only with the following commands:

sudo chown root:root /opt/bitnami/apache2/conf/server*

sudo chmod 600 /opt/bitnami/apache2/conf/server*

Open port 443 in the server firewall. Refer to the FAQ for more

information.

Restart the Apache server.

You should now be able to access your application using an HTTPS URL.

How to create an SSL certificate?

You can create your own SSL certificate with the OpenSSL binary. A certificate

request can then be sent to a certificate authority (CA) to get it signed into a

certificate, or if you have your own certificate authority, you may sign it yourself,

or you can use a self-signed certificate (because you just want a test certificate

or because you are setting up your own CA).

Create your private key (if you haven't created it already):

sudo openssl genrsa -out /opt/bitnami/apache2/conf/server.key 2048

Create a certificate:

sudo openssl req -new -key /opt/bitnami/apache2/conf/server.key -o

ut /opt/bitnami/apache2/conf/cert.csr

IMPORTANT: Enter the server domain name when the above

command asks for the "Common Name".

Send cert.csr to the certificate authority. When the certificate authority

completes their checks (and probably received payment from you), they

will hand over your new certificate to you.

Until the certificate is received, create a temporary self-signed

certificate:

sudo openssl x509 -in /opt/bitnami/apache2/conf/cert.csr -out /opt

/bitnami/apache2/conf/server.crt -req -signkey /opt/bitnami/apach

e2/conf/server.key -days 365

Back up your private key in a safe location after generating a

password-protected version as follows:

sudo openssl rsa -des3 -in /opt/bitnami/apache2/conf/server.key -o

ut privkey.pem

Note that if you use this encrypted key in the Apache configuration file, it

will be necessary to enter the password manually every time Apache

starts. Regenerate the key without password protection from this file as

follows:

sudo openssl rsa -in privkey.pem -out /opt/bitnami/apache2/conf/se

rver.key

Find more information about certificates at http://www.openssl.org.

How to force HTTPS redirection?

Add the following to the top of the

/opt/bitnami/apps/livehelperchat/conf/httpd-prefix.conf file:

RewriteEngine On

RewriteCond %{HTTPS} !=on

RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]

After modifying the Apache configuration files, restart Apache to apply the

changes.

How to debug Apache errors?

Once Apache starts, it will create two log files at

/opt/bitnami/apache2/logs/access_log and /opt/bitnami/apache2/logs/error_log

respectively.

The access_log file is used to track client requests. When a client

requests a document from the server, Apache records several

parameters associated with the request in this file, such as: the IP

address of the client, the document requested, the HTTP status code,

and the current time.

The error_log file is used to record important events. This file includes

error messages, startup messages, and any other significant events in

the life cycle of the server. This is the first place to look when you run

into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to modify PHP settings?

The PHP configuration file allows you to configure the modules enabled, the

email settings or the size of the upload files. It is located at

/opt/bitnami/php/etc/php.ini.

After modifying the PHP configuration file, restart both Apache and PHP-FPM

for the changes to take effect:

sudo /opt/bitnami/ctlscript.sh restart apache

sudo /opt/bitnami/ctlscript.sh restart php-fpm

For example, to modify the default upload limit for PHP, update the PHP

configuration file following these instructions.

How to modify the allowed limit for uploaded

files?

Modify the following options in the /opt/bitnami/php/etc/php.ini file to increase

the allowed size for uploads:

; Maximum size of POST data that PHP will accept.

post_max_size = 16M

; Maximum allowed size for uploaded files.

upload_max_filesize = 16M

Restart PHP-FPM and Apache for the changes to take effect.

sudo /opt/bitnami/ctlscript.sh restart apache

sudo /opt/bitnami/ctlscript.sh restart php-fpm

How to access phpMyAdmin?

For security reasons, phpMyAdmin is accessible only when using 127.0.0.1 as

the hostname. To access it from a remote system, you must create an SSH

tunnel that routes requests to the Apache Web server from 127.0.0.1. This

implies that you must be able to connect to your server over SSH in order to

access these applications remotely.

IMPORTANT: Before following the steps below, ensure that your Apache and

MySQL servers are running.

NOTE: The steps below suggest using port 8888 for the SSH tunnel. If this port

is already in use by another application on your local machine, replace it with

any other port number greater than 1024 and modify the steps below

accordingly. Similarly, if you have enabled Varnish, your stack's Apache Web

server might be running on port 81. In this case, modify the steps below to use

port 81 instead of port 80 for the tunnel endpoint.

Windows

To access the application using your Web browser, create an SSH tunnel, as

described below.

Download PuTTY and make sure you can log in to the server console

with it following the instructions in the FAQ. Once you have confirmed

you are able to log in successfully, log back out.

Reconnect to the server using PuTTY, this time adapting the steps to

include an additional SSH tunnel. When configuring the new SSH

session in PuTTY, additionally navigate to the "Connection -> SSH ->

Tunnels" section and create a secure tunnel by forwarding port 80 on

the server to port 8888 on the local host (127.0.0.1 or localhost).

Click the "Add" button to add the secure tunnel configuration to the

session. Here is an example:

Go back to the "Session" section and save your changes by clicking the

"Save" button.

Click the "Open" button to open an SSH session to the server. The SSH

session will now include a secure SSH tunnel between the two specified

ports.

While the tunnel is active, you should be able to access the phpMyAdmin

console through the secure SSH tunnel you created, by browsing to

http://127.0.0.1:8888/phpmyadmin.

To log in, use username root for MySQL and the application password from the

detail page for your cloud server.

If you are unable to access phpMyAdmin, verify that the SSH tunnel was

created by checking the PuTTY event log (accessible via the "Event Log"

menu):

Linux and Mac OS X

To access the application using your Web browser, create an SSH tunnel, as

described below.

Open a new terminal window on your local system (for example, using

"Finder -> Applications -> Utilities -> Terminal" in Mac OS X or the Dash

in Ubuntu).

Make sure you can log in to the server console following the instructions

in the FAQ. Once you have confirmed you are able to log in successfully,

log back out.

Run the following command to configure the SSH tunnel. Remember to

replace SERVER-IP with the public IP address or hostname of your

server. Enter your SSH password when prompted.

ssh -N -L 8888:127.0.0.1:80 bitnami@SERVER-IP

If you are using a private key to connect to the server, use the following

command instead, remembering to replace KEYFILE with the path to

your private key and SERVER-IP with the public IP address or

hostname of your server:

ssh -N -L 8888:127.0.0.1:80 -i KEYFILE bitnami@SERVER-IP

NOTE: If successful, the above commands will create an SSH tunnel

but will not display any output on the server console.

While the tunnel is active, you should be able to access the phpMyAdmin

console through the secure SSH tunnel you created, by browsing to

http://127.0.0.1:8888/phpmyadmin.

To log in, use username root for MySQL and the application password from the

detail page for your cloud server.

How to change the default administrator

password?

For security, it is recommended that you change the default administrator

password as soon as possible. Follow the steps below:

Log in to the application as an administrator.

In the top right corner, click "Your Name -> Account".

Type your new password in the "Password" and "Repeat Password"

inputs.

Click "Update" to save your changes.

How to change the interface language?

The Bitnami Live Helper Chat Stack uses the English language pack by default.

However, translations also exist for other languages. To change the interface

language, follow these steps:

Log in to the application as an administrator.

Click on the System Configuration icon (next to "Extra Modules" tab).

Click on "Language Configuration" under System tab.

Select you desired language from the list and click "Save".

How to configure scheduled tasks?

Follow these steps:

Run the following command to edit the crontab file:

sudo crontab -e

Add the following line to the file:

*/15 * * * * su daemon -s /bin/sh -c "/opt/bitnami/php/bin/php

/opt/bitnami/apps/livehelperchat/htdocs/cron.php -s site_admin -c

cron/workflow > /dev/null"

Save the file.

This cron entry will run the script every 15 minutes.

For more information, refer to these pages:

How to set up a cron job

How to add cron job in extension

How to debug errors in Live Helper Chat?

Edit the /opt/bitnami/apps/livehelperchat/htdocs/settings/settings.ini.php file

and modify it so that it looks like this:

'debug_output' => true

'templatecache' => false

'templatecompile' => false

'modulecompile' => false

Refer to the official documentation for further information.

How to enable framing in your domain?

If you want to embed Live Helper Chat in a different domain, you will need to

configure Apache to set up the proper value for the header "X-Frame-Options".

Just edit the /opt/bitnami/apache2/conf/httpd.conf file with the following

content:

<IfModule headers_module>

<IfVersion >= 2.4.7 >

Header always setifempty X-Frame-Options ALLOW-FROM http://DOMAI

N.COM

</IfVersion>

<IfVersion < 2.4.7 >

Header always merge X-Frame-Options ALLOW-FROM http://DOMAIN.COM

</IfVersion>

</IfModule>

Note that we have replaced the more restrictive SAMEORIGIN by

ALLOW-FROM, so that the only the specified domain (DOMAIN.COM) will be

able to embed Live Helper Chat.

How to upgrade Live Helper Chat?

It is strongly recommended to create a backup before starting the update

process. If you have important data, create and restore a backup to ensure

that everything works properly.

You can upgrade the application only without modifying any other stack

components by following these steps:

Log in to the application administration panel.

Click the "System configuration" icon and browse to "System -> Update

Information". Click the "Update database" link if needed.

Log out of the application.

Download the new version of the application.

Overwrite the following folders:

cp -R /PATH-TO-NEW-VERSION/docs /opt/bitnami/apps/livehelperchat/

htdocs/docs

cp -R /PATH-TO-NEW-VERSION/ezcomponents /opt/bitnami/apps/livehel

perchat/htdocs/ezcomponents

cp -R /PATH-TO-NEW-VERSION/lib /opt/bitnami/apps/livehelperchat/h

tdocs/lib

cp -R /PATH-TO-NEW-VERSION/modules /opt/bitnami/apps/livehelperch

at/htdocs/modules

cp -R /PATH-TO-NEW-VERSION/pos /opt/bitnami/apps/livehelperchat/h

tdocs/pos

cp -R /PATH-TO-NEW-VERSION/translations /opt/bitnami/apps/livehel

perchat/htdocs/translations

cp -R /PATH-TO-NEW-VERSION/design /opt/bitnami/apps/livehelpercha

t/htdocs/design

Disable the cache by editing the following values in your

/opt/bitnami/apps/livehelperchat/htdocs/settings/settings.ini.php file:

'templatecache' => false

'templatecompile' => false

'modulecompile' => false

Log in to the application administration panel.

Click the "System configuration" icon and browse to the "System" page.

Click the "Clean cache" link.

Enable the cache.

For further information, refer to the official documentation