| Documentation

ChaTicket is a ticketing system you can use it to provide support for almost any type of products, ChaTicket is a unique mix of live chat app like messenger and ticket system platform that includes all the necessary features like ticket department, statue, auto agent assignement, mail notifications, public and private tickets, search tickets, and it's also support Envato items with auto purchase code checker, ChaTicket can be used as micro service support system thanks to our design architecture tickets are stored in custom database away from your main database.

ChaTicket is completely restful you can access your tickets, create and answer them throw AJAX requests from any other domain or server, ChaTicket is not your grandpapa support system it's the future of making your customers more happy.

It's highly recommended to go throw each section and follow the steps, If you can't find what you look for ,We encourage you to reach us through our Support portal. We'll be glad to help you out in your queries. Please create ticket through our Support portal

• Apache or Nginx WebServer (we recommend Apache)
• PHP version 5.6 or greater (we recommend 7 or greater)
• WordPress 4.5 or greater
• PHP memory of 256M or greater.

We recommend hosting ChaTicket API plugin on custom server, VPS with only 512mb ram should be enough even if you except large volum of tickets, Here is a list of recommended hosting:

• Vultr Powerful with low price starting at $2.50/mo
• Amazon AWS EC2 EC2 Micro instances is free
• DigitalOcean

If you are on amazon ec2 then please check the following article otherwise keep reading

• Login to your server using Terminal ( If you are on Windows use PuTTy )
• For Ubuntu or Debian os use the following command: $ sudo apt-get update
$ sudo apt-get upgrade
• Now you can start the installation of Nginx using the following command $ sudo apt-get install nginx

Once you are done visit your server IP address and you should see nginx welcome page

After installing Nginx you need both php and mysql in order for WordPress to work, To do that do the following steps:

• Install MySQL with the following command $ sudo apt-get install mysql-server You will be asked to supply a root (administrative) password for use within the MySQL system. The MySQL database software is now installed, but its configuration is not exactly complete yet.
• To finish MySQL installation process use the following command: $ mysql_secure_installation

You will be asked to confirm your root password then type Y ( yes ) to continue, Once you finish MySQL installation you can process with installing PHP-FPM with the following command:

ZeroMQ is a minimalist library with an API resembling BSD sockets that allows for building efficient and flexible messaging systems without much pain, With ChaTicket we use ZeroMQ to carry messages and notifications without it none of our live features will work

There is many ways to instal ZeroMQ, We will start with the easy one insatlling via PHP Pear:

To make sure PHP Pear is installed use the following command: $ sudo apt-get install php-pear

After that you may try to install it ZMQ with the following command: $ sudo pecl install zmq-beta

If the above command didn't work or you got an error then you might try the following: $ sudo apt-get install php-zmq

Once the install is done you can enable the extension to do that use add the following line inside php.ini file extension=zmq.so $ sudo apt-get install nano
$ sudo nano /etc/php/7.0/fpm/php-fpm.conf

Then restart the php service with the following command: $ sudo systemctl restart php-fpm.service

If the above code didn't work try the following: $ sudo systemctl restart php7.0-fpm.service

By default nginx won't run your PHP files you need first to edit the config file: $ sudo nano /etc/nginx/sites-available/default

This is how your config file should look: server {
    listen 80 default_server;
    listen [::]:80 default_server;
    root /var/www/html;
    index index.php index.html index.htm index.nginx-debian.html;
    server_name server_domain_or_IP;

    location / {
        try_files $uri $uri/ =404;
    }

    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_pass unix:/run/php/php7.0-fpm.sock;
   }

    location ~ /\.ht {
        deny all;
    }
}

Please note in the above example we are using PHP version 7.0 if you are using other version make sure to change the following line: fastcgi_pass unix:/run/php/php7.0-fpm.sock;

To open new TCP port on your nginx server add the following lines at the top of /etc/nginx/sites-available/default file

Please note 8888 is the port number that we will use later in our plugin settings you can change it to other port if you wish

Since we are installing the API plugin and the APP on different domains we need to tell Nginx to allow Cross Origin to do that add the following lines: location / {
    if ($request_method = 'OPTIONS') {
        add_header 'Access-Control-Allow-Origin: $http_origin';
        add_header 'Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE, HEAD';
        add_header 'Access-Control-Allow-Credentials: true';
        add_header 'Access-Control-Allow-Headers: Origin,Content-Type,Accept,Authorization';
        add_header 'Access-Control-Max-Age' 1728000;
        add_header 'Content-Type' 'text/plain charset=UTF-8';
        add_header 'Content-Length' 0;

        return 204;
    }

    if ($request_method = 'POST') {
        add_header 'Access-Control-Allow-Origin: $http_origin';
        add_header 'Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE, HEAD';
        add_header 'Access-Control-Allow-Credentials: true';
        add_header 'Access-Control-Allow-Headers: Origin,Content-Type,Accept,Authorization';
    }

    if ($request_method = 'GET') {
        add_header 'Access-Control-Allow-Origin: $http_origin';
        add_header 'Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE, HEAD';
        add_header 'Access-Control-Allow-Credentials: true';
        add_header 'Access-Control-Allow-Headers: Origin,Content-Type,Accept,Authorization';
    }
}

You need to set your WordPress permalink to post name in order for the Rest API to work, However Nginx servers requers extra customization to get this work, Add the following line at Nginx config file: location / {
    try_files $uri $uri/ /index.php?$args;
}

location /wp-json/ {
    # if permalinks not enabled
    rewrite /wp-json/(.*?)$ /?rest_route=/$1 last;
}

Now you can save the file and restart your Nginx server with the following command: $ sudo systemctl reload nginx

We are not going throw installing apache and php in this section since it's already installed on most hosting and comes with any control panel such as Cpanel, However if you have clean server ( We recommend that for the API ) you will find many tutorial on the web can take you throw the required steps, Here is one of the good articles

To install ZeroMQ log in to your server through Putty or any similar, We will start first with updating the repo with the following command:

Then install the require dependency:

You can now start installing ZeroMQ with pecl:

After installing ZMQ make sure to add the following line at your php.ini config file

We will be using Apache mod_proxy to enable ws:// protocol, mod_proxy already comes with apache however we still need to enable it from your SSH, To do that use the following command

We can start now adding our wss:// port number and domain at apache config file.

Add the following lines:

Since we are going to use JWT Authentication we need to make sure our Apache server will pass the require Authentication http header to any request, To do that let's first enable headers module:

After that add the following line at your WordPress .htaccess file

There is manay tutorials covers how to install WordPress if you are using control panel on your server like Cpanel this might be pretty easy, However our aim in this docs to covers how to install it over SSH, Bring a cup of tea and let's get started

First log in to your server SSH using PuTTy, To access mysql use the following command:

Enter the root password which you already set in PHP-FPM MySQL Install step

To create new database use the following command:

To create new database user use the following command:

Now we need to grant privileges on our database to the new created user:

The last step is to alter our new created user:

We will download WordPress lasted version from SSH but first let's make sure we have wget installed on our server ( wget is used to download the zip files to our server ): $ sudo apt-get install wget

Before we start downloading WordPress files we need to go to the correct directory where we want to setup our WordPress, in Nginx server your root folder is located in: $ cd /var/www/html

If you want create new directory use the following command: $ mkdir DIRECTORY_NAME
$ cd DIRECTORY_NAME

Now we can grab the lasted WordPress version to our directory using the following command: $ wget http://wordpress.org/latest.tar.gz
$ tar xfz latest.tar.gz
$ rm -f latest.tar.gz

Once you have downloaded the package, and after extracting, you will see the following files & folder structure:

• chaticket

  This is chaticket reactjs app, Customers can create tickets on the same domain where chaticket plugin is installed

• chaticket-api

  The api plugin for chaticket, This plugin will handle storing and getting your tickets from the database to the app

• tcp-server

  This folder will be uploaded to your server and we will explain later how to run it throw SSH access

• Documentation

  The documentation you are reading right now

After installing and activating ChaTicket API you should see the following warning:

JWT Authentication for WP REST API extends the WP REST API using JSON Web Tokens Authentication as an authentication method

After installing JWT Authentication you need to do the following:

• Edit your WordPress wp-config.php file ( It's on your website root folder ) and add the following line:

  define('JWT_AUTH_SECRET_KEY', 'your-top-secret-key');

  To generate secret key you might check this website
• If both the API and the APP plugin are not on the same domain then you might need to enable cors, To do that add the following line in wp-config.php

  define('JWT_AUTH_CORS_ENABLE', true);

After all your config file should look like that:

Once you installed the API plugin you might install ChaTicket APP on other domain, go to Plugins > Add New then select Upload plugin and choose chaticket.zip file from the downloaded package

The APP settings are located inside Apperance > Customizer therefor you need to install the following require plugin

In server configuration section we have added Nginx Websocket now let's configure our server.php to point to that socket, Modify server.php file which is inside tcp-server folder ( inside the downloaded package )

At line #10 you should see 127.0.0.1 replace it with your server IP as the following: $pull->bind('tcp://SERVER_IP:5556');

At line #14 you will see the port number for our websocket which is 8888 it should be the same as the port number from step Nginx Websocket $webSock = new React\Socket\Server('0.0.0.0:8888', $loop);

Start the listener

Now our websocket is ready to listen to our app changes, After uploading tcp-server folder to our API server, Login to your server throw SSH then run the following command: $ php -q /var/www/html/tcp-server/server.php

This section covers the basic settings for tickets and answers, For example from there you can set the minum number of words on new answers

This is the most important section for the app to work correctly which includes:

• APP Domain: The domain name where chaticket app is installed also make sure to include the tickets page in your url
• APP Domain Login Page: The login page for your app, This is will be used to redirect users after loging or register with Envato API
• TCP Address: Your TCP server domain or IP address without tcp://
• TCP Port: Your TCP port which we added in Websocket Listener step ( in our case is 5556 )

From there you can set the default mail mesage on new ticket or answer creation

Please note by default Nginx servers requires additional steps to send mail, If you would like to avoid these steps you can use Gmail SMTP service to send mails, Please check the following plugin for more information WP Mail SMTP by WPForms

Inside your mail message you can use any of the following shortcodes:

After fetching your Envato items you might go Tickets > Departments and you will able to assign an Envato item to your departement

You need to create Envato APP in order to enable Envato login:

• Goto the Envato API New App Page
• Enter your APP name
• Check the required permission as the following screen
• Add ChaTicket APP login page ( Will be covered more in next sections )
• Check the I have read and understood terms checkbox
• Click the Register App button

• After creating your APP make sure to copy the secret key somewhere safe
• Also make a note of your OAuth client ID from your Envato My Apps page

Configure Envato Login

Now go to the ChaTicket API settings page then navigate to Envato Integration section and paste both the OAuth ID and client secret key

ChaTicket APP settings are located at Appearance > Customize > ChaTicket APP

ChaTicket requires setting 5 pages in order for the APP to work correctly:

• Tickets Page: Will be used to show the tickets list and single ticket
• Create Ticket Page: The page for creating new ticket
• Login Page: Page for login
• Register Page: Adding new user page
• Terms Page: Service terms

From this section you can set your APP logo

You must point your APP to the API if you left this section empty ChaTicket APP won't work

1 This is the domain where ChaTicket API is installed

2 This is the WSS listener port which we already setup in Websocket Listener section

1 Clean mode will only load the APP asset files without any theme header or footer

2 This option is different than the default WordPress custom homepage, It will redirect users to your tickets page insted of using the tickets page as home

The most important fields in the colors section is Primary Color and Secondary Color the primary color is used as highlighted for inputs and buttons the secondary is for things like notification count and secondary buttons

If you need help with installing or configure ChaTicket we would love to hear from you, Please submit new request at our support portal