KnowledgeTree Setup Wizard Troubleshoot

From KnowledgeTree Document Management Made Simple

Overview

Setup Wizard attempts to guide the user through a step by step configuration of the KnowledgeTree source code on the first access of KnowledgeTree via a browser.

KnowledgeTree Prerequisites

Minimum Software Requirements

See Platform Requirements[1]

Web Server Access

  -  Move the KnowledgeTree folder to the directory it is going to be served from
  -  Configure your web server to access the KnowledgeTree system

Installer Steps

PHP Dependencies

PHP Version

The PHP version must be higher than 5.0 and lower than 6.0.

It is not recommended to run a version higher than 5.3.2.

PHP Extensions

ZendServer Extensions Admin

Follow the following steps to "turn on" Extensions:

  -  Login into ZendServer
  -  Navigate to the "Server Setup" page
  -  Navigate to the "Extensions" sub menu page
  -  Make sure extensions below are turned on
  -  If not, click "Turn on". Then restart PHP

Other

  - Locate php.ini file

The following extensions are required by KnowledgeTree:

MySQL
Allows you to access MySQL database servers.
ZendServer Extension - mysql
Other -

cURL
Allows you to connect to and communicate with many different types of servers, with many different types of protocols.
ZendServer Extension - curl
Other -

XMLRPC
These functions can be used to write XML-RPC servers and clients.
ZendServer Extension - xmlrpc
Other -

JSON
Implements the JavaScript Object Notation (JSON) data-interchange format. 
ZendServer Extension - json
Other -

The following extensions are required for KnowledgeTree to perform at an optimal level:

Fileinfo
Allows retrieval of information regarding a vast majority of file types. This information may include dimensions, quality, length etc.
ZendServer Extension - fileinfo
Other -

IconV
Character Set Conversion - This module contains an interface to the iconv character set conversion facility. 
With this module, you can turn a string represented by a local character set into a string represented by another character set (such as the Unicode character set).
ZendServer Extension - iconv
Other -

win32 (Windows platform)
Allows control of Microsoft Windows services
ZendServer Extension - 
Other -

Multi Byte Strings
Multibyte Character Processing - Multibyte character encoding schemes were developed to express more than 256 characters in the regular bytewise coding system.
When you manipulate (trim, split, splice, etc.) strings encoded in a multibyte encoding, you need to use special functions, since two or more consecutive bytes may represent a single character in such encoding schemes. 
ZendServer Extension - mbstring
Other -

LDAP
Lightweight Directory Access Protocol, a protocol used to access "Directory Servers". 
The Directory is a special kind of database that holds information in a tree structure.
ZendServer Extension - ldap
Other -

Open SSL
This module uses the functions of OpenSSL for generation and verification of signatures and for sealing (encrypting) and opening (decrypting) data.
ZendServer Extension - openssl
Other -

PHP Configurations

ZendServer Directives Admin

Follow the following steps to configure Directives:

  -  Login into ZendServer
  -  Navigate to the "Server Setup" page
  -  Navigate to the "Directives" sub menu page
  -  Make sure directives below are configured accordingly
  -  Make sure to restart PHP after configuring directives.

Other

  - Locate php.ini file

The following is the recommended PHP configuration for KnowledgeTree to perform at an optimal level.

Safe Mode
Whether to enable safe mode of PHP
Value : ON
ZendServer Directive - safe_mode
Other -

Display Errors
Display errors in HTML script output
Value : OFF
ZendServer Directive - display_errors
Other -

Display Startup Errors
Display startup errors
Value : ON
ZendServer Directive - display_startup_errors
Other -

File Uploads
Whether or not to allow HTTP file uploads
Value : ON
ZendServer Directive - file_uploads
Other -

Magic Quotes GPC
Sets the magic_quotes state for GPC (Get/Post/Cookie) operations
Value : OFF
ZendServer Directive - magic_quotes_gpc
Other -

Magic Quotes Runtime
If enabled, most functions that return data from any sort of external source including databases and text files will have quotes escaped with a backslash
Value : OFF
ZendServer Directive - magic_quotes_runtime
Other -

Register Globals
Tells whether or not to register the EGPCS as global variables
Value : OFF
ZendServer Directive - register_globals
Other -

Output Buffering
Size of the output buffering
Value : OFF
ZendServer Directive - output_buffering
Other -

Session auto start
Session auto start
Value : OFF
ZendServer Directive - session.auto_start
Other -

Automatic prepend file
Automatically prepend and parse a file to PHP
Value : unset
ZendServer Directive - auto_prepend_file
Other -

Automatic append file
Automatically append and parse a file to PHP
Value : unset
ZendServer Directive - auto_append_file
Other -

Open base directory
Limit the files that can be opened by PHP to the specified directory-tree
Value : unset
ZendServer Directive - open_basedir
Other -

Default MIME type
Default MIME type
Value : text/html
ZendServer Directive - default_mimetype
Other -

Maximum POST size
Sets max size of post data allowed
Value : 32M
ZendServer Directive - post_max_size
Other -

Maximum upload size
The maximum size of an uploaded file
Value : 32M
ZendServer Directive - upload_max_filesize
Other -

Memory limit
Maximum of amount of memory in bytes that a script is allowed to allocate
Value : 32M
ZendServer Directive - memory_limit
Other -

System Configuration

Related known issues

Known Issue: KnowledgeTree Documents directory not writable on Linux

Server Settings

Gathers default system information, and attempts to help the user setup KnowledgeTree

If you enable ssl, be aware that the wizard does not configure Apache SSL.

SSL can be manually enabled and configured as per the instructions below.

Ubuntu

# Install Open SSL
sudo apt-get install openssl 
# Install wrapper for OpenSSL's certificate request
sudo apt-get install ssl-cert
# Create ssl certificate
sudo make-ssl-cert /usr/share/ssl-cert/ssleay.cnf /etc/ssl/private/localhost.pem
# Switch to apache sites configuration
cd /etc/apache2/sites-available/
# Backup the default configuration
sudo cp default default.backup.date 
# Be sure to listen to the port 80 for the default,
sudo sed -i '1,2s/\*/*:80/' default
# by checking the default file for "<VirtualHost *:80>"
# Create the ssl configuration
sudo cp default ssl 
# Set the ssl port
sudo sed -i '1,2s/\*:80/*:443/' ssl 
sudo sed -i "3a\\\tSSLEngine On\n\tSSLCertificateFile /etc/ssl/private/localhost.pem" ssl
# Enable Site
sudo a2ensite ssl 
# Enable SSL module
sudo a2enmod ssl
# Restart apache2
sudo /etc/init.d/apache2 restart

Windows

# IIS 6
follow the instructions at this link:
http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/56bdf977-14f8-4867-9c51-34c346d48b04.mspx?mfr=true

# IIS 7
follow the instructions at this link:
http://learn.iis.net/page.aspx/144/how-to-setup-ssl-on-iis-70/

# OpenSSL (for Apache servers)
instructions on setting up and using openssl can be found at the following link:
http://wiki.knowledgetree.com/Generating_SSL_certificates

Paths and Permissions

Makes sure that folders needed by the system are writable and owned by the apache user.

Configuration File:

The file contains the systems configuration settings.

This file has to be copied from the default location, if the default location is changed.

The config-path file content has to be updated to :

config/config.ini

Locate the file in:

Windows

KnowledgeTree_Installation_Directory/config/config-path # Path file needs to be updated

Linux

Community

/usr/share/knowledgetree-ce/config/config-path # Path file needs to be updated

Commercial

/usr/share/knowledgetree/config/config-path # Path file needs to be updated

Windows

KnowledgeTree_Installation_Directory/config/config.ini # Config file needs to be copied

Linux

Community

/etc/knowledgetree-ce/config.ini # Config file needs to be copied

Commercial

/etc/knowledgetree/config.ini # Config file needs to be copied

Document Directory:

Where documents are stored.