Introduction

Thank you for purchasing our script. If you have any questions that are beyond the scope of this help file, please feel free to email via info@mybizcms.com. Thanks so much!

Requirements

You will need the following requirements.

  • PHP >= 8.2
  • MySQL >= 5.6
  • Fileinfo PHP extension
  • PDO PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension

Hosting & Database setup

Hosting

  1. Login to cPanel by accessing www.yourdomain.com/cpanel and navigate to File manager.
  2. Navigate to public_html folder.
  3. Inside the public folder extract EmbedAI zip contents.
  4. That's it. You are ready to go to the next step.

Database setup

  1. Login to cPanel by accessing www.yourdomain.com/cpanel and navigate to MySQL Databases.
  2. Create database first.
  3. Create user and setup your password.
  4. Add the user to database by selecting the database and the username.

Make sure you have checked All privileged when adding the user to database.

Here is a good tutorial how to setup MySQL database in cPanel if you are not familiar with this.

Installation

Intro

To install the script, go to HTTPS://YOURWEBSITE.COM/app/install

Requirements

Make sure all the system requirements are met in order to proceed with installation.

Database Setup

Populate the fields according to your database and Click "Install & Proceed to Company Profile".

If any erros found while connecting you will be notified otherwise you will proceed to complete your profile

Company Profile

Fill all the required details and then "Save & Proceed to your Profile"

The currecy you select will be the base currency. It is important to be sure about your choice. Default currency can be changed later but will affect the values of your items, which means you will need to update the items value too

Your Profile

Fill out every field and "Complete Installation".

Complete

Congratulations

After successful installation you need to:
Login using the your email and password used during installation

That's it.

Chat assistants

Overview

Chat assistants can be added into the app by admin and users based on their subscription. They can then be embeddded into the chat widget. You can set your favourite chat assistants as well.

Add a chat assistant

To add a chat assistant, you must provide:

  • Name
  • Profession
  • Logo
  • Prompt - Used to guide in chat content generation

Fine-tuning

Overview

To fine-tune a model, you are required to provide at least 10 examples. We typically see clear improvements from fine-tuning on 50 to 100 training examples with gpt-3.5-turbo but the right number varies greatly based on the exact use case.

Here is a good tutorial how to train a model if you are not familiar with this.

Training file format

The training file should be in jsonl format.

How to Fine-tune

To upload your prepared file:

  • Select or drag-and-drop your file and click "Upload" button.
  • Click the uploaded file to view details.

To fine-tune your uploaded file:

  • Then click "Upload for finetuning" to upload it to OpenAI for fine-tuning.
  • After uploading click "Finetune".You can check status by clicking the "Refresh icon".
  • That's it. You can now use your trained model.

Chat files

Overview

In case you have a large file you want to embed a chat file, you can add the file for visitors to engage with and inquire about its contents seamlessly. This feature fosters interactive discussions and deeper exploration of the conversation data.

Upload a chat file

To prepare your chat file for chat go to Chat files>upload. Drag and drop your file and upload. After uploading, open details and click Upload for chat. The status should now change to "processed". Now it's ready, you just need to attach it to the widget at External chatbots > Settings > Default chat widget

Chat links

Overview

If you possess a website or link where embedding is desired, you have the option to include them, enabling visitors to effortlessly engage with and inquire about their content. This functionality encourages interactive discussions and facilitates deeper exploration of the conversation data.

Upload a chat link

To prepare your chat link for chat go to Chat links > links. Click on Add link. A popup will appear, input the link and click submit. The status should now change to "processed" unless otherwise. Now it's ready, you just need to attach it to the widget at External chatbots > Settings > Default chat widget

Upload a chat sitemap (Website)

A website sitemap give you control of which links to include in the widget. To prepare your website for for chat go to Chat links > sitemaps. Choose between Upload sitemap or Add a sitemap link. It should be a standard sitemap in XML format. After uploading open it and select the links that you need included in the chat widget and then click Upload sitemap for chat button. The links will be "processed" unless otherwise. Now it's ready, you just need to attach it to the widget at External chatbots > Settings > Default chat widget

Chat embedding

Overview

Setup your AI chat widget appearance by updating the fields in the chat settings.

There is additional Visit timeout which is used to set out the visitors timeout. If a visitor stays idle for the given period and later does an activity, it will be counted as a new visit in the statistics.

Chat embed

This option gives subscribers ability to integrate their own websites with AI chat. When integrated, any visitor chat on the website. Tokens used in the chats are billed on the subscriber.

To integrate AI chat as a subscriber:

  • Go to External chatbots > Settings
  • Configure the chat widget and choose between your trained models and chat assistants.
  • Save the settings.
  • Copy Widget code.
  • Paste it just before the </body> of your website and save.
  • That's it.

Chat embed on wordpress website

To integrate AI chat on wordpress website:

  • Go to External chatbots > Settings
  • Configure the chat widget and choose between your trained models and chat assistants.
  • Save the settings.
  • Copy Widget code.
  • Add the plugin to your site by navigating to Plugins → Add New from your admin dashboard, then searching for “Head & Footer Code”.
  • Once you click on the Install Now and Activate buttons, you can locate the plugin’s settings by going to Tools → Head & Footer Code. On this screen, there are three boxes for the header, footer, and body sections.
  • Paste the copied widget code into the footer section. When you’re done, select the Save Changes button. The code will then load to every page of your site.
  • That's it.

Chat embed errors

All errors on chat widget are given a code together with a standard message Chat unavailable. These are visible on the website the chat is embedded. Below error codes definition will guide you in debugging.

  1. Error400 means You do not have an active subscription.
  2. Error401 means AI chat external embed not available in your current subscription.
  3. Error402 means No chat options available.
  4. Error403 means Errors thrown by OpenAI API. E.g. Invalid API key, token limit reached, etc.
  5. Error404 means Errors thrown by OpenAI Assistant API..

All custom errors are also logged on Super Admin's account.

Chat embed CORS issue - Widget not loading

Cross-Origin Resource Sharing (CORS)is a security feature implemented by web browsers to restrict web pages from making requests to a different domain than the one that served the web page. Because of this, you might get Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at YOUR-WEBSITE.COM. (Reason: CORS header ‘Access-Control-Allow-Origin’ missing). Status code: 200. in your browser console and the chat widget will not load.

To resolve this issue, you have a few options:

  1. Update Server Configuration: If you have control over your hosting server, you should configure it to include the appropriate CORS headers in its responses. You can set the 'Access-Control-Allow-Origin' header to the domain from which the requests are originating. There are 2 ways to do it:
    1. Apache (via .htaccess or server configuration) - Add the following to your .htaccess file or directly in your server configuration: Header set Access-Control-Allow-Origin "*"
    2. Nginx (in the server block) - Add the following to your Nginx configuration: location / { add_header 'Access-Control-Allow-Origin' '*'; }
  2. Proxy Server: If you don't have control over the server, you can set up a proxy server on your domain that makes requests to the server on behalf of your web page. This way, the same-origin policy is not violated because the requests are made from the same domain.

Packages

Overview

Add a package

You can set:

  • Package name
  • Package duration
  • Package duration type - Available options are hours, days, weeks, years.
  • Number of chat assistants
  • Number of trained models
  • Number of words
  • Accept custom branding - If enabled, the visitor will not be able to see the host website branding.
  • Package cost

For unlimited number of chat assistants, trained models and words Enter -1 in the respective fields.

Package features - Add additional features you offer together with the package. The features you can add are unlimited.

Pages

Create dynamic public pages.

  • Show in header - If checked page link will be displayed in header of every page.
  • Show in footer - If checked page link will be displayed in footer of every page.
  • Is this your privacy policy page - If checked you will required to add a short cookie alert description for privacy policies popup content. The popup will have a link to the main page.
  • Is this your terms and conditions page - If checked it will be displayed when users are creating accounts for them to read.
  • Is this your contact us page - If checked it will give you an option to add Show contact us form and Show contact us details. If Show contact us details is enabled, you will have to fill Email, Phone and Address details.

Newsletters

Overview

Add a newsletter

You can create content rich newsletters for your subscribers.

When creatin a newsletter you have an option to send it right away or even send later.

Settings

From the settings tab, you manage all settings.

General settings

Below are the settings to update:

  • Records per page
  • Item prefixes
  • Enable users create account - Enable or disable user registrations
  • Enable HTML Entities decode
  • Timezones
  • Default language
  • Custom scripts and CSS
  • Date and time formats - Manage date and time format accross the app
  • Not found page settings
  • Graphs settings - Change colours of all the graphs in the app
  • Fonts settings
  • Google recaptcha settings - For user login and registration security
  • Google analytics settings - Keep track of all user visits

Google Analytics Settings

To get your tracking ID, follow these steps:

  1. Log in to your Google Analytics account
  2. On the bottom left-hand side of the page, click Admin
  3. From the left column titled Account, select an account from the dropdown menu
  4. From the middle column titled Property, select a property from the dropdown menu
  5. Under the Property column, click Tracking Info > Tracking Code
  6. Your website’s unique tracking ID is shown at the top of the page under Tracking ID and starts with UA

Once you’ve identified your tracking ID, you’ll need to get your tracking code snippet (HIGHLIGHTED), which can be found on this page as the Global Site Tag (gtag.js). The gtag.js is the tracking code for this specific property and you’ll need to copy and paste this code to "Google tracking code" field to track on your website.

Paste the tracking code snippet in the textarea

Google Font Settings

You can change the appearance of your website using google fonts as follows:

  1. Visit the Google fonts official website and the following window will appear
  2. Select the category/ font family of your choice
  3. Select the google font of your choice(e.g. krub)
  4. Copy the link of the selected style from the window that appear on the right side of the screen
  5. Copy the CSS rules for font-family

Then

  1. Paste the link in the Google font link field
  2. Paste CSS rules in Google font css rules field

AI settings

Set up features:

  • OpenAI API key
  • Model - The model that will be used in chats

Homepage section

Design your homepage by setting up the following sections:

  • How it works
  • Trust
  • Templates
  • Optimize
  • Applications
  • Pricing
  • Features
  • Blog
  • Faqs

Payment option settings

You can add offline payment options with instructions to the user. Note that offline payments require admin to approve the payment

Payment settings

You can as well accept online payments through the given gateways. You will need to update with your keys and the status of the gateways from Sandbox to Live.

  • PayPal Pro
  • PayPal Standard
  • Authorize.Net
  • Stripe
  • Paystack
  • SSLCOMMERZ
  • Esewa
  • Instamojo
  • Flutterwave
  • ToyyibPay
  • AamarPay
  • PesaPal
  • Hyperpay
  • Paddle

Subscriptions settings

You can "Approve subscription automatically". That is, you won't be approving subscriptions manually.

You can set the "Minimum payment acceptable" - The lowest amount any subscription can cost. If set at $1.00 and subscriber selects a package option costing less than $1.00, the total charge will automatically be increased to $1.00

Affiliates settings

You can enable or disable affiliates program as well as set:

  • Affiliate rule
  • Commission rate
  • Minimum payout
  • Action phrase
  • Affiliate guidelines

Email settings

The app comes with multiple email platforms as listed below:

  • PHP Mail
  • PHPMAILER
  • SMTP
  • Sendgrid

The one you choose will be used to send emails accross the system.

Email templates

You can create email templates with multiple variables for:

  • Forgot/reset password request
  • Password changed
  • Your user account created
  • Welcome message
  • Subscription payment received
  • Subscription cancelled
  • Subscription approved
  • Affiliates Program
  • Payout requested for admin
  • Payout sent
  • Payout declined
  • Payout cancelled for admin

Default currency

Default currency is used when users are making payments for subscriptions.

Cronjobs

You can add offline payment options with instructions to the user. Note that offline payments require admin to approve the payment

Updates

Intro

To update the script, go to HTTPS://YOURWEBSITE.COM/app/install

Requirements

Make sure all the system requirements are met in order to proceed with installation.

Database Setup

Populate the fields according to your database and Click "Install & Proceed to Company Profile".

If any errors found while connecting you will be notified otherwise you will proceed to complete your profile

Database Update

Now click "Update Database" button.

Complete

Congratulations

After successful installation you need to:
Login using the your email and password used during installation

That's it.

Contact Us

Incase you have any enquiry do not hesitate to reach us through info@mybizcms.com. We will be happy to help you out.

Thank You

Once again, thank you so much for purchasing this script. As I said earlier, we will be glad to help you if you have any questions relating to this script.