El Mhadder Mohamed Rida

Installation Guide for Chat4Us Components

Before diving into the installation of Chat4Us components, you need to ensure that Java 21 or higher and GPT4All are installed on your system. You can download these dependencies from their respective official websites.

Installing Dependencies

To begin with, visit the downloads page to obtain links for both Java and GPT4All. After downloading them, follow these steps:

Install GPT4All: Installation process differ from an os to the other and you can find the installation guide on the GPT4All website. After installation success, run GPT4All and open the settings view. Activate the web server in the settings. Note down the port number as it will be essential later when setting up chat bot servers to access the GPT4All AI language model.

Advanced users can install and use the CLI version that can run faster and use less OS/hardware resources than the GUI version.

Download Models: If you plan to use one of the provided examples, go to Find Models and click +Add Model. Search for Llama 3.2 3B Instruct and download it.

Ensure that GPT4All is running with its web server activated before proceeding to connect Chat4Us components.

Installing Chat4Us Components

Chat4Us – Chat bots Creator

  1. Download the Latest Release: Visit the downloads page and obtain the latest release of Chat4Us.
  2. Extract the Archive: Extract the downloaded archive into a folder.
  3. Run the Jar File: Navigate to the extracted folder and run chat4us.jar. In some operating systems, you may need to grant required permissions and configure the firewall to let chat bot servers accept incoming connections.

Chat4Us – Agent Messenger

  1. Download the Latest Release: Visit the downloads page and obtain the latest release of Chat4Us.
  2. Extract the Archive: Extract the downloaded archive into a folder.
  3. Run the Jar File: Navigate to the extracted folder and run chat4usAgent.jar. In some operating systems, you may need to grant required permissions and configure the firewall to let chat bot servers accept incoming connections.

The Agent Messenger is only required if you plan letting remote chat bot users ask for human support.

Chat4Us – Chat bot IFrame

  1. Download the Sample Web Project: Obtain the sample web project archive from the downloads page.
  2. Extract the Archive: Extract the downloaded archive into a folder where a web server like Apache or Nginx can access and serve.
  3. Integrate Your Own Chat Bots: The provided HTML, CSS, JS and PHP files allow you to engage discussions with chat bot servers and messengers. This sample project is designed for educational purposes, enabling web designers and developers to develop and integrate their own chat bots.

Chat4Us – Client Software

  1. Download the Sample Java Project: Obtain the sample java project archive from the downloads page.
  2. Extract the Archive: Extract the downloaded archive into a folder and import it into your IDE. This is an Eclipse IDE java project.
  3. Integrate Your Own Chat Bots: The provided Java project allows you to engage discussions with chat bot servers and messengers. This sample project is designed for educational purposes, enabling software developpers to create and integrate their own chat bots.

Getting Started

Now that all components are installed, proceed to the Get Started page. There, you will learn how to create and run your first chat bot.

By following these steps, you’ll have a fully functional setup for creating custom chat bots using Chat4Us components.