Q: The "Email to a friend" email has "KnowledgeBase Manager Pro" as a subject line. How can I change this text?

A: Subject line includes the title of the knowledge base. By default it is "KnowledgeBase Manager Pro". You can change it at Customization > Styling and Front-end Settings > Home > Title.

To insert the search box, you need to put this HTML code somewhere on your website:

Then URL that you need to put instead of the highlighted text is this:

if this URL doesn't work, try this instead:

If you would like to use a dedicated hosting or host it  on a local server, you can use hardware requirements and example specifications below for a reference.

• Recommended Hardware Requirements
• Example Hardware Specifications
• Maximum Reported Usages
• Technical Overview of Clustering in KnowledgeBase Manager Pro

Recommended Hardware Requirements

On small instances, server load is primarily driven by peak visitors.

5 Concurrent Users

• 1GHz+ CPU
• 512MB RAM
• 20MB database space
• 300MB disk space

25 Concurrent Users

• Dual 2GHz+ CPU
• 2GB+ RAM
• 80MB database space
• 1GB disk space

Example Hardware Specifications

These are example hardware specifications for non-clustered Knowledgebase Manager Pro instances. These values are customer instances reported to us.

Maximum Reported Usages

These values are largest customer instances reported to us or used for performance testing. Clustering for load balancing, database tuning and other performance tuning is recommended for instances exceeding these values.

Technical Overview of Clustering in KnowledgeBase Manager Pro

Clustering in Knowledgebase Manager Pro is the same as clustering  in any other web application. There are three parts of the application that can  be clustered in order to get a performance boost:

• Database
• Web server
• File system (if you’re using large number of  attachments and images/videos)

For database clustering you need to use MySQL Cluster version of MySQL. The recommendation for good redundancy would be 2 MySQL  Server Nodes, 2 Data Nodes and 1 Management Node. The minimum fully fault tolerant  solution would consist of 3 servers with the 2 data nodes and the management  node all running on different hosts and with at least 2 MySQL Server nodes   running on different hosts from each other.

Web server clustering is reached by creating several (2 or more) nodes and at least 2 balancers that split up incoming requests between nodes.

Knowledgebase Manager Pro stores all attachments and media  files in the file system. You can reduce load by moving these files onto external RAID array.

Edit your php.ini and uncomment/add the line:

Then you need to restart the webserver.

The remote installation API helps with fast deployment of new KMP packages. It assumes that all package files are already extracted from the package and uploaded to the remote server, and all necessary file/folder permissions are set.

Contents

• Creating the Request
  
• XML Reference
  
• Sample XML Request
• Sample PHP Request (Using CURL)
  
• A Successful Installation Response
  
• An Erroneous Installation Response
  
• Error Codes
  
• Installation by Shell Script

Creating the Request

Before launching remote installation of KMP copy, make sure that:

• All files are uploaded on the remote server.
• Correct permissions are set.
• Package is not installed yet.

XML Reference

• xml version - XML declaration which specifies the version of XML being used
• methodCall - The root node of the XML document. It outlines your request
• methodName - type of request. It must be "install.setup" for installation request.
• params - This node contains all parameters that you send
• product_key - Product key for KMP. You can get it from your member area.
• db_prefix - Prefix for database tables (optional)
• db_host - Database server address
• db_login - The username of the Database user
• db_password - The Database password for the above user
• db_name - The name of the MySQL database to install the KMP in to
• acc_login - The username of the knowledgebase administrator
• acc_password - The password to assign the KMP administrator account
• acc_first_name - The first name of the knowledgebase administrator
• acc_last_name - The last name of the knowledgebase administrator
• acc_email - The email address of the knowledgebase administrator
• smtp_host - SMTP (mail) server address
• smtp_port - SMTP server port

Sample XML Request

Sample PHP Request (Using CURL and IXR)

The following sample code is written on PHP with usage of CURL functionality.

You can also find this sample in the KMP package: /examples/installation-api/rpc_install.php

Although it uses IXR as XML RPC library (include 'inc/xmlrpc.php') it is just a sample, and you may use any library suitable for you.

A Successful Installation Response

A successful installation response has the following format.

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>Installation completed successfully</string>
      </value>
    </param>
  </params>
</methodResponse>

An Erroneous Installation Response

If an error occurred during installation or server doesn't meet KMP requirements, you will get an erroneous installation message. It includes error code and error message with information why installation cannot proceed.

<?xml version="1.0"?>
<methodResponse>
  <fault>
    <value>
      <struct>
        <member>
          <name>faultCode</name>
          <value><int>-101</int></value>
        </member>
        <member>
          <name>faultString</name>
          <value><string>Not all parameters specified. Following parameters are required: acc_login, acc_password, acc_first_name, acc_last_name</string></value>
        </member>
      </struct>
    </value>
  </fault>
</methodResponse>

Error Codes

The table below outlines all possible error messages for faultCode attribute.

Error Code	Message
-101	Not all parameters specified. Following parameters are required: [list of parameters]
-201	Your PHP version is not compatible. Current PHP version is [current version]. Required version: [required version]
-202	Some of the required modules are missing: [list of missing extensions]
-203	Some of the required custom checks has been failed: [list of custom checks]
-301	File system permissions are incorrect: [list of files with incorrect permissions]
-401	Can not connect to database server
-402	Can not select database
-403	Unknown error while database connection
-410	MySQL error when executing sql dump: [mysql error]
-411	MySQL error when executing sql dump for administrator's account: [mysql error]
-501	Error when setup configuration file
-502	Error when setup file [file name]
-601	Wrong license key
-701	Unable to run installation process because KMP has been already installed

Installation by Shell Script

Installation shell script supports installation of KMP from UNIX shell. Before starting the script:

• Check that server meets the KMP requirements
• Upload files from the KMP package on server
• Setup correct permissions
• Create an empty database for KMP
• Specify correct installation details including database connection parameters, administrator account details, etc in the installation script

To translate it you just need to create your own rating form at Customization > Custom Rating Forms. You can specify the replacement for "Rate It!" text at the second wizard step:

Then you can set this form on your front-end at Customization > Styling and Front-end Settings > Article

 Setup Instructions

1. Go to the "LDAP Settings" section in Administration > General Settings.
2. First of all tick the "Enable LDAP Authentication" checkbox to start and select a LDAP platform.
   
   
   
   
3. Specify correct LDAP host and port.
   
   
   LDAP Host and Port
   

   Double check these settings because application may freeze for 10 minutes if you try to connect to nonexistent LDAP server. 

   
   
   
4. Specify additional connection settings.
   If your LDAP server hold references to other servers you may want to enable "Allow Follow Referrals" option.
   Enable "LDAP Version 3" option if you would like to use LDAPv3 protocol.
   The "Negotiate TLS" option allows establishment of Transport Layer Security on the connection.
   
   
   
   
5. If you would like to get users by certain parameters, you may want to modify the "Search String" value. Otherwise, left the default value.
   
   
   
   
6. Usually "Base DN" consists of two parts: OU (Organizational Unit, "company" in our example), and dc (Domain Component, "example" and "com" in our example; if your LDAP server name includes more domain levels, there will be more dc's).
   You may not specify OU and get full tree of directory groups then.
   
   Object Unit
   

   If you specify OU (Organizational Unit), make sure that LDAP users that you want to import belong to this OU as well as their parent groups. Otherwise, they won't be imported.

   

7. Setup username and password for connection on the LDAP server. This user must have permission to see LDAP entries.
   
   
   
   
8. Check the mapping attributes.
   
   
   Mapping Attributes
   

   Remember that LDAP users that you want to import must have all these required attributes: account name, first name, last name, email. Otherwise they won't be imported. Make sure that attributes here in KMP preferences match user attributes on the LDAP server.

   

9. Setup synchronization options.
   If you would like KMP to inactivate user account if he gets deleted from the LDAP server, set the "Disable User When Deleted" checkbox.
   If you would like to synchronize LDAP user details and LDAP groups each time a LDAP user log in, set checkboxes accordingly. If these checkboxes are not set, account and group information will be synchronized upon the first login only.
   
   
   
   
10. Check "Group Mapping Settings".
    A user that belongs to a LDAP group that is not mapped to any KMP group will be assigned to the group set in "Default Group Mapping Action".
    Check the "LDAP Group Member Attribute" to match the group entry that stores a list of group members.
    Check all LDAP settings, click "Save" above and mark the "Enable LDAP Group Mapping" to start mapping.
    
    
    
    
11. You will see the tree of LDAP groups on the left upon successful connection and the tree of KMP groups on the right. Now you need to map some groups from the LDAP server with groups in KMP. Mapping of LDAP group A to KMP group B means that users from LDAP group A will be assigned to the KMP group B.
    Just drag-n-drop a LDAP group to a KMP group to map them. You can map several LDAP groups to one KMP group. Click "Save" above when finished.
    
    
    
    Please note that you can map here Staff groups only. It is not allowed to import Client users due to the licensing reasons.
    
    
12. After successful mapping you can proceed with one of the two approaches.

• You can go to Users & Groups > Manage Users and click the "Get LDAP Users" button to import LDAP users to KMP immediately. Please note that usage of the "Get LDAP Users" button is not required for successful integration of KMP with your LDAP directory - there is no need to import all LDAP users at once, especially considering limited number of user accounts in KMP. When someone tries to login to KMP and KMP doesn't have this user account in its database, it asks the LDAP server and if a user with these username and password exists on the LDAP server, the account in KMP will be created automatically. Also, "Get LDAP Users" has some limitations due to limits of LDAP servers - they often do not allow to get more than a 1000 users at a time remotely, and if you're using "Get LDAP Users" button while having thousands of users on the LDAP server, you may not find the user that you wanted to import. This doesn't mean that LDAP or KMP functions incorrectly - simply use it another way as specified below:
• Or you can skip the "Get LDAP Users" step and try to login as one of the users from mapped groups. If all settings are correct, you'll be able to login with username and password of this user gotten from the LDAP server. Account in KMP will be created automatically upon login.

• Cron Setup
  

Overview

Installing Knowledgebase Manager Pro means uploading files to your web server and completing the simple installation wizard. The wizard will ask you to configure file system permissions, database, administrator account and some other settings.

Uploading Files

To upload Knowledgebase Manager Pro you need to unzip contents of the "package" directory from the latest KMP package onto your local hard drive and, using an FTP client for example, login to your web server and copy Knowledgebase Manager Pro files through. 

To start the setup wizard, navigate to the directory you have uploaded Knowledgebase Manager Pro to. For example if you uploaded files to the "kmp" under the web root, open http://www.yoursite.com/kmp/ in your browser to start.

If you have a blank screen instead of the installation wizard check if JavaScript is enabled in your browser.

If you get a "Don't have permissions" error, check this guide for help.

You will see the following page. Choose language if necessary and click "Apply". 

Enter the product key. You can get it from your account in the member area.

You can skip activation if you're installing KMP on a test server that doesn't have internet connection. To skip product activation leave this field empty.

You must also agree with End-User License Agreement to proceed.

Click "Next" to start the installation.

Requirements

For a successful installation of the Knowledgebase Manager Pro your sever must match the system requirements.

On this step you may be asked to install the required modules.

Curl setup

If you are asked to install Curl, chose follow one of the guides below according to your server preferences:

• Installing Curl on Windows + Apache or Windows + IIS
• Installing Curl on Linux or a UNIX-like system
• Installing Curl on WAMP

File System Permissions

Knowledgebase Manager Pro requires some files and directories to have special permissions set. The exact permissions may vary from server to server however the ones that should work on the majority of servers are: write and read permissions for owner and read permissions for others. It can be set up by chmod 755 (or chmod 777 depending on server configuration) command for folders and chmod 644 (or chmod 666) command for files in UNIX systems. 

Open our guide that describes how to set files and folders access permissions efficiently in a new window or browser tab. It will help you to set necessary permissions right now in a few clicks and it also includes the directions for setting secure permissions after installation.

You cannot proceed to the next step until all the system permissions are set up correctly. If you have some difficulties with this step do not hesitate to contact our support or your system administrator.

Database Setup

Knowledgebase Manager Pro supports MySQL and MS SQL database to store the data. Select a desired database type and then select a PHP extension which you're going to use. If it says that no extensions for your database type are available, learn how to install PHP extensions for databases.

You need to create an empty database on this step.  This is usually can be done within Control Panel or cPanel web interface of your hosting account. If it asks you for character set and collation, please select character set: utf8, and collation: utf8_general_ci (this is needed to MySQL).

Your MySQL or MS SQL user account should also be granted full access to that database (including CREATE TABLE and ALTER TABLE operators) because installation wizard will need to create some tables and fill this database during the setup process. 

If you do not have MySQL on your server, check this guide to find out where to get it.

For MySQL: the "STRICT_TRANS_TABLES" option must be disabled.

If you're installing it on MSSQL make sure that Full-text Indexing is enabled. This must be done prior to the installation.

If you're using MSSQL, you need to specify an account with SQL Server instead of using Windows Pass-through authentication when connecting to MSSQL.

Host names "localhost" and "127.0.0.1" are common for most servers where web server software (e.g. Apache or IIS) and database are installed on the same machine (it is true for most hosting plans and when you install it on your PC or server), but if the Installation Wizard is unable to connect to the database server with this address, check for your hosting account documentation or contact your ISP or system administrator for correct SQL server name or IP address.

If your database server uses non-default port, you can specify it within the host field separated by colon from the host name itself, e.g. "127.0.0.1:3307"

Tables prefix field should be empty by default. This is optional field that allows you to install Knowledgebase Manager Pro to the database that already contain tables of some other software. Tables prefix is added to a table name without any additional symbols, i.e. if you set "kmp_" as prefix and the table named "accounts" is going to be created, then setup wizard will name it "kmp_accounts".

Click "Test" to check the database connection and if it is successful, click "Next" to fill the database.

System Preferences

On this step you can set up SMTP settings. Default SMTP settings are detected automatically and work on most servers so you do not usually need to change them. If you do not receive test email (check SPAM folder first), you can contact your ISP or refer to your hosting documentation to receive custom SMTP settings. These settings can be changed after installation.

When all corrections are done, click the "Next" button.

Administrator's Account

Here you need to enter your name, e-mail, create login and password and click "Save" button.

Please remember your login and password. You will need them to login to Knowledgebase Manager Pro.

Summary

This is the last step of the installation wizard. Here you can check all the settings and installation results made in the previous steps and setup cron jobs.

In order to complete the installation you should add a task for Knowledge Base Manager Pro pseudo-cron to scheduler application. This step is optional and allows sending of updated content to subscribers, run indexation of knowledge base for automated related articles creation, periodical database backups, and attachments indexation.

Cron setup guides

Chose your platform:

• Windows XP/2003
• Windows 7/Vista/2008
• Linux/UNIX
• Control Panel (e.g. Plesk)

If everything is arranged purely, then you get the green light to finish the installation process by clicking on "Finish" button.

If you get any errors or other issues after installation, please take a look at troubleshooting section. If you can't find the solution there, feel free to submit your question at our support center.

Later, you can check the post installation checklist to enable and configure additional features and fine-tune system preferences.