View file Pinky Chat/Documentation/index.html

File size: 14.83Kb
<!doctype html>  
<!--[if IE 6 ]><html lang="en-us" class="ie6"> <![endif]-->
<!--[if IE 7 ]><html lang="en-us" class="ie7"> <![endif]-->
<!--[if IE 8 ]><html lang="en-us" class="ie8"> <![endif]-->
<!--[if (gt IE 7)|!(IE)]><!-->
<html lang="en-us"><!--<![endif]-->
<head>
	<meta charset="utf-8">
	
	<title>Pinky Chat v1.6</title>
	
	<meta name="description" content="">
	<meta name="author" content="Balaji">
	<meta name="copyright" content="Rainbow Networks">
	<link rel="stylesheet" href="css/documenter_style.css" media="all">
	<link rel="stylesheet" href="css/custom.css" media="screen">

	<script src="js/jquery.1.6.4.js"></script>
	<script src="js/cufon.js"></script><script src="js/font.js"></script>
	<script src="js/jquery.scrollTo-1.4.2-min.js"></script>
	<script src="js/jquery.easing.js"></script>
	
	<link rel="stylesheet" href="css/shDocumenter.css" media="screen">
	<script src="js/shCore.js"></script>
	<script src="js/shBrushPhp.js"></script>
	<script src="js/shBrushPlain.js"></script>
	<script>SyntaxHighlighter.defaults['toolbar'] = false;SyntaxHighlighter.all();</script>
    
	<script src="js/script.js"></script>
	
	<style>
		html{background-color:#F3F3F3;color:#585858;background-image:url(assets/images/image_2.png);background-repeat:repeat;background-attachment:fixed;}
		::-moz-selection{background:#111111;color:#F1F1F1;}
		::selection{background:#111111;color:#F1F1F1;}
		#documenter_sidebar #documenter_logo{background-image:url();}
		a{color:#111111;}
		hr{border-top:1px solid #E5E5E5;border-bottom:1px solid #F9F9F9;}
		#documenter_sidebar, #documenter_sidebar ol a{background-color:#333333;color:#F1F1F1;background-image:url(assets/images/image_3.gif);background-repeat:repeat-y;}
		#documenter_sidebar ol a{-webkit-text-shadow:1px 1px 0px #444444;-moz-text-shadow:1px 1px 0px #444444;text-shadow:1px 1px 0px #444444;}
		#documenter_sidebar ol{border-top:1px solid #222222;}
		#documenter_sidebar ol a{border-top:1px solid #444444;border-bottom:1px solid #222222;color:#F1F1F1;}
		#documenter_sidebar ol a:hover{background:#111111;color:#F1F1F1;border-top:1px solid #111111;}
		#documenter_sidebar ol a.current{background:#111111;color:#F1F1F1;border-top:1px solid #111111;}
		#documenter_copyright{display:block !important;visibility:visible !important;}
	</style>
	
</head>
<body>
	<div id="documenter_sidebar">
		<a href="#documenter_cover" id="documenter_logo"></a>
		<ol id="documenter_nav">
			<li><a class="current" href="#documenter_cover">Start</a></li>
			<li><a href="#what_is">What is Pinky Chat?</a></li>
			<li><a href="#features">Features</a></li>
			<li><a href="#Requirements">Requirements</a></li>
			<li><a href="#Installation">Installation</a></li>
			<li><a href="#install-demo">Installation (Video Demo)</a></li>
            <li><a href="#setup-cron">Setup Cron Job</a></li>
			<li><a href="#translate">Translate to your Language</a></li>
			<li><a href="#customization">Theme Customization</a></li>
			<li><a href="#shortcode">Shortcode</a></li>
			<li><a href="#changelog">Change Log</a></li>
			<li><a href="#credits">Credits</a></li>
		</ol>
		<div id="documenter_copyright">Copyright Rainbow Networks 2023<br />
		</div>
	</div>
    
	<div id="documenter_content">
    
	<section id="documenter_cover">
    <h1>Pinky Chat</h1>
    <h2>It's live chat application and help desk software for your websites. Smarter way to quickly handle your customer service. Talk to your customer in real-time over web and mobile friendly too.  </h2>
    
    <hr/>
    
    <ul>
    <li>Developed By Balaji</li>
    <li><b>Contact US for support: rainbowbalajib@gmail.com</b></li>
    <li><br /></li>
    <li>For Compliant Queries Email to: admin@prothemes.biz</li><li>
    <a href=""></a></li><li>Website:<a href="https://prothemes.biz">prothemes.biz</a></a></li></ul>
    
    <p>Thank you for purchasing. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form <a href="http://prothemes.biz/index.php?route=information/contact">here</a>. Thanks so much!</p>
    </section>
    
    <section id="what_is">
	<h3>What is Pinky Chat?</h3><hr class="notop">
<h6>
    Pinky Chat (PHP Live Chat Script) – Smarter way to quickly handle your customer service. It’s live chat application and help desk software for your websites. Talk to your customer in real-time over web and mobile friendly too. Additionally you can track analytics of your website, visitor’s path and geo location details.  </h6>

<p> &nbsp;</p>

<div>&nbsp;</div>

</section>
<section id="features">
	<h3>Features</h3><hr class="notop"/>

<ul>
 <li>
    Real-time unlimited chatting</li><li>
    Two way file sharing</li><li>
    Operator to Operator Chat</li><li>
    Canned responses (Shortcuts)</li><li>
    Multilingual Support (Translatable to any language)</li><li>
    Responsive Chat Window (Mobile Friendly)</li><li>
    Cross domain support</li><li>
    Send transcripts to users</li><li>
    Multiple Departments Support</li><li>
    Contact page when no operators online</li><li>
    Widget display blacklist</li><li>
    Inline widget support</li><li>
    Fullscreen chat mode</li><li>
    Customizable avatars, emoticon, notification tone etc..</li><li>
    Multiple operators and guests chatting</li><li>
    Message notification tones</li><li>
    Custom Chat Templates</li><li>
    Inbuilt Analytics (Track your visitors traffic, source of traffic etc..)</li><li>
    Visitors path tracking</li><li>
    Performance settings</li><li>
    Custom widget positions</li><li>
    Adblock Detection</li><li>
    Maintenance Mode</li><li>
    Captcha Protection (Google reCAPTCHA Included)</li><li>
    Support both SMTP and native PHP mail</li><li>
    Add-ons Support</li><li>
    Shortcode System</li><li>
    Ban unwanted user IP address functionality</li><li>
    Easy Installer Panel</li>
</ul>
<p>
	&nbsp;</p>

</section>
<section id="Requirements">
	<h3>Requirements</h3><hr class="notop">
<h2>
	&nbsp;</h2>
<p>  <ul>  <li>
PHP 7.2.0 or above (PHP 8.X Recommended)</li><li>
PDO and MySQLI extension</li><li>
GD Extension</li><li>
Multibyte String (Mbstring)</li><li>
PHP DOM / XML</li><li>
PHP CURL</li><li>
“allow_url_fopen” must be allowed. </li><li>
URL Rewrite module </li><li>
SMTP Mail Server (optional)</li>
</ul></p>

<p>
	&nbsp;</p>
</section>
<section id="Installation">
	<h3>Installation</h3><hr class="notop">

<p> <b>

1. Upload the files present on "Upload" directory to your website using FTP or file manager in your hosting's control panel & keep writable mode for "uploads" directory and "/core/config/db.config.php" file&nbsp;<br />&nbsp;<br />
2. Create MySQL database in your hosting account.	&nbsp;<br />	&nbsp;<br />
3. Visit the "index.php" page in your web browser where you have upload the files e.g. http://www.example.com/index.php	&nbsp;<br />	&nbsp;<br />
4. It automatically redirect to installation panel page.	&nbsp;<br />	&nbsp;<br />
5. Provide the necessary information i.e. database-host, database-name, database-username and database-password	&nbsp;<br />	&nbsp;<br />
6. Provide item purchase code for verification of script purchase. (Item purchase code will be found on here http://codecanyon.net/downloads)	&nbsp;<br />	&nbsp;<br />
7. Click "Submit" button, it will be shown a successful message, if you have entered correct information of databse and item purchase code. Then enter your admin user id and password.	&nbsp;<br />	&nbsp;<br />
9. Now click "Install" button, after few seconds (mostly 5 to 10 seconds) it will be shown a successful message with database table creation log file.	&nbsp;<br />	&nbsp;<br />
10. You have done the installation. If you found any errors and bugs while installation - Please report and check the support section. &nbsp;<br />	&nbsp;<br />
11. After installation, put your site on maintenance mode (Admin Panel -> Maintenance) and make basic changes such as title, description, keywords etc.. 	&nbsp;<br />	&nbsp;<br />
12. After done all customization, release the maintenance mode.  &nbsp;<br />	&nbsp;<br />
</b>
</p>

<p>

	<img alt="" src="assets/images/3.png" style="width: 850px; height: 410px; border-width: 0px; border-style: solid; "></center></p>

<br />

<p>
	&nbsp;</p>
</section>

<section id="install-demo">
	<h3>Installation (Video Demo)</h3><hr class="notop">

<video width="800" height="600" controls>
  <source src="https://prothemes.biz/livechat/videos/installation.mp4" type="video/mp4">
  Your browser does not support the video tag.
</video> 

<br />

<p>
	&nbsp;</p>
</section>

<section id="setup-cron">
	<h3>Setup Cron Job</h3><hr class="notop">
    <p>
    1. Setting up cron is an important step in the installation. It helps to generate sitemap, database backups and clean up temporary directory regularly. <br />
    
    2. Cron Job path can be found on Admin Panel -> Cron Job -> Cron Job Path<br />
    
    3. Interval between cron job execution is 5 miniutes to 15 miniutes (Recommended).<br />
    
    </p>
    <br />
    <p>
    <b>How to setup a cron job in cpanel?</b><br /><br />

    Tutorial 1:<br />
    <a target="_blank" href="https://www.namecheap.com/support/knowledgebase/article.aspx/9453/29/how-to-run-scripts-via-cron-jobs">https://www.namecheap.com/support/knowledgebase/article.aspx/9453/29/how-to-run-scripts-via-cron-jobs</a><br /><br />
    
    Tutorial 2:<br />
    <a target="_blank" href="http://support.hostgator.in/articles/cpanel/how-do-i-create-and-delete-a-cron-job">http://support.hostgator.in/articles/cpanel/how-do-i-create-and-delete-a-cron-job</a><br /><br />
    
    Tutorial 3:<br />
    <a target="_blank" href="https://www.siteground.com/tutorials/cpanel/cron_jobs.htm">https://www.siteground.com/tutorials/cpanel/cron_jobs.htm</a><br />
    </p>
    
    <p>
    Cron Job setup steps vary on each hosting service and control panels. So, it is recommended to refer hosting service knowledge base / help sections
    </p>
<br />

<p>
	&nbsp;</p>
</section>

<section id="translate">
    <h3>Translate to your Language</h3><hr class="notop">
    &nbsp;<br />
    <p>
        1. Login into Admin Panel -> Interface -> Create New Language &nbsp;<br />	&nbsp;<br />
        2. Keep the status disabled until making complete translation. &nbsp;<br />	&nbsp;<br />
        3. After making translation, enable the language from admin panel. &nbsp;<br />	&nbsp;<br />
    </p>


    <p>
        For helping other customers, please try to share translated language backup file to us ( rainbowbalajib@gmail.com ).
    </p>
    &nbsp;<br />	&nbsp;<br />
    <p>
        &nbsp;</p>
</section>

<section id="customization">
    <h3>Theme Customization</h3><hr class="notop">
    &nbsp;<br />
    <p>
        1. Don't do any customization on "<b>default</b>" theme. It will make you difficult to upgrade on future releases
        of Turbo Website Reviewer.&nbsp;<br />	&nbsp;<br />

        2. So, always clone the "<b>default</b>" theme directory and make it as a new theme(Admin Panel -> Interface -> Manage Themes -> Select Theme -> Click "Clone" button). Using the cloned files, do
        any customization of inteface. &nbsp;<br />	&nbsp;<br />

        3. Themes files are combination of HTML and simple PHP codes. 90% of codes are Pure HTML on theme files.&nbsp;<br />	&nbsp;<br />

        4. So make use of any HTML editors and do any customizations.&nbsp;<br />	&nbsp;<br />

        5. Theme information must be included on "themeDetails.xml" file. If you cloned exiting theme,
        make sure you change this information first.
        &nbsp;<br />	&nbsp;<br />
    </p>

    <p>
        &nbsp;</p>
    &nbsp;<br />	&nbsp;<br />
</section>

<section id="shortcode">
	<h3>Shortcode</h3><hr class="notop">
&nbsp;<br />
<p> 
Shortcode will be used inisde pages, blog posts and posting multilingual strings.&nbsp;<br />&nbsp;<br />

Shortcode return on below format:&nbsp;<br />
<b>{{short-code-name}}</b> &nbsp;<br />&nbsp;<br />

Simple short code calls:&nbsp;<br />
<b>{{date}}</b> -> Return today date&nbsp;<br />
<b>{{ip}}</b> -> Return client IP&nbsp;<br />
<b>{{baseURL}}</b> -> Return base link of your website&nbsp;<br />
<b>{{ads_720x90}}</b> -> Return Ad Code (Size: 720x90) &nbsp;<br />&nbsp;<br />

Multilingual string calls:&nbsp;<br />
<b>{{lang[1]}}</b> -> Return active language string of 1&nbsp;<br />

<b>{{lang[9]}}</b> -> Return active language string of 9&nbsp;<br />

</p>

<p>
	&nbsp;</p>
    &nbsp;<br />	&nbsp;<br />
</section>

<section id="changelog">
	<h3>Changelog</h3><hr class="notop">

    <h4>
        Version 1.6 </h4>
    <pre class="brush: plain">
    Added: Support for PHP 8.2.x
    Updated: Anti Adblock Detector
    Updated: Cron Job
    Updated: Admin Panel - Users - Export Options
    Fixed: Analytics Crashes
    Fixed: Some minor bugs
    </pre>

    <h4>
        Version 1.5 </h4>
    <pre class="brush: plain">
    Added: Support for PHP 8.1.x & PHP 8.2b
    Updated: File Manager library
    Fxied: Compressed database backup failed.
    Fixed: Some minor bugs
    </pre>

    <h4>
        Version 1.4 </h4>
    <pre class="brush: plain">
    Added: Default sender address overwritable from configuration file
    Updated: PHPMailer library
    Updated: File Manager library
    Some PHP 8 fixes
    </pre>

    <h4>
        Version 1.3 </h4>
    <pre class="brush: plain">
    Added: New CORS (Cross-Origin ) Suport
    Fixed: Staff permission issues
    Fixed: Invite Chat crash on some database server
    </pre>

    <h4>
        Version 1.2 </h4>
    <pre class="brush: plain">
    Added: PHP 8 Support (Beta)
    Added: Beep sound to admin/staff when new chat starts
    Added: Customizable 404 page
    Added: Database Editor
    Updated: File Manager library
    Improved: Handling of multiple chats at a time
    Fixed: Unable to delete banned IP address
    Fixed: Some minor bugs
    </pre>
    <h4>
        Version 1.1 </h4>
    <pre class="brush: plain">
    Updated: Admin File Manager
    Fixed: Contact form issue
    </pre>
<h4>
	Version 1.0 </h4>
<pre class="brush: plain">
Initial release
</pre>
<h4>
	&nbsp;</h4>
<p>
	&nbsp;</p>
</section>
<section id="credits">
	<h3>Credits</h3><hr class="notop">
<h3>
	&nbsp;</h3>
<h6>
	Thanks so much to:</h6>

<p>
    <strong>AdminLTE Theme</strong> - https://almsaeedstudio.com &nbsp;</p>       
<p>
	<strong>PHPMailer</strong> - https://github.com/PHPMailer/PHPMailer &nbsp;</p>
<p>
	<strong>Freepik</strong> - http://freepik.com/ &nbsp;</p>
<p>
	<strong>Bootstrap</strong> - http://getbootstrap.com/ &nbsp;</p>
<p>
	<strong>Geodatabase</strong> - https://www.maxmind.com/ &nbsp;</p>
<p>
	&nbsp;</p>

<br />
<strong>Copyright &copy; 2023 by Rainbow Networks. All right reserved.</strong>

</section>

	</div>
</body>
</html>