FreeBSD6-install-howto

From KnowledgeTree Document Management Made Simple

KnowledgeTree Installation Notes for freeBSD-6.*
------------------------------------------------

* This sample installation steps was done under freeBSD-6.0.
  The steps should apply to freeBSD-6.1 as well.

* This sample installation steps was done under a jail environemnt.
  Again, the steps should apply to normal non-jail environment.

* It is assumed that you have the ports tree updated etc.

* ** Pre-knowledgeTree installation **

* Install apache-2.2
   # (cd /usr/ports/www/apache22; make; make install)

* Install mysql-5.0
   # (cd /usr/ports/databases/mysql50-server; make; make install)

* Install php-4.4
   # cd /usr/ports/lang/php4
   # make config
   # #enable 'Build Apache module'
   # make
   # make install

* Install php4-modules that are needed
   # cd /usr/ports/lang/php4-extensions
   # make config
   # enable the following modules
   # FileInfo, Gettext, MySQL, Session
   # make
   # make install

* enable apache, mysql
   # vi /etc/rc.conf
   # add in the following 2 lines to enable the services
     apache22_enable="YES"
     mysql_enable="YES"

* ** knowledgeTree installation **
   Note: The knowledgeTree folder is installed under http://kthost/knowledgeTree

*  Download knowledgeTree.tgz

*  Untar knowledgeTree.tgz
   # tar -C /path/to/your/html/directory/ knowledgeTree.tgz
   # cd /path/to/your/html/directory/; chmod 755 `find knowledgeTree -type d`

*  Configure your web server to access the KnowledgeTree system.

   - Config /usr/local/etc/apache22/httpd.conf
       Under section <Directory "/usr/local/www/apache22/data">,
       add in the following lines to enable php

        AddType application/x-httpd-php .php
        AddType application/x-httpd-php-source .phps

   - Config /usr/local/etc/php.ini
       if it is not there, create it

       Add the following line to php.ini

        memory_limit = 32M
        display_errors = On
        display_startup_errors = On
        post_max_size = 32M
        upload_max_filesize = 32M

   Due to the many different configuration possibilities, these can not
   all be discussed here.  Please consult the KnowledgeTree Wiki system
   at http://support.ktdms.com/confluence/ to see what others have done
   on your platform, and discuss the pros and cons of various options on
   the KnowledgeTree Forums at http://forum.ktdms.com/

*  Start up the servers
   /usr/local/etc/rc.d/apache22.sh start
   /usr/local/etc/rc.d/mysql-server.sh start

*  Check the pre-installation checkup. Go to:

       http://kthost/knowledgeTree/setup/

*  Fixing problems presented in the pre-installation checkup

   - Session save path           /tmp
   Make sure /tmp is mode 1777

   - KnowledgeTree must be able to write to the log and Documents directories
   # cd /path/to/your/html/directory/;
   # cd knowledgeTree/var
   # chown www:www log Documents

   - The remaining folders should preferably not be able to be written
     to by your web server.


*  Check the post-installation checklist:

   If your knowledgeTree installation is at http://localhost/, go to:

       http://localhost/setup/

   And click on "Post-installation checkup".

*  Set up the database
   - Create a database:
     $ mysqladmin -p create dms

   - Create and populate the tables:
     $ mysql -p dms < sql/mysql/install/structure.sql
     $ mysql -p dms < sql/mysql/install/data.sql

   - Create the database users
     !! change the rights from '*' to 'dms.*' before applying the script below
     $ mysql -p dms < sql/mysql/install/user.sql


*  Configure your installation in config/config.ini:
   - The default configuration will determine many settings on your
     installation automatically, and this is the preferred method of
     running KnowledgeTree.  Please do not manually set these settings
     unless you know what you are doing.

   - The default configuration uses the database username and password
     in the user.sql file mentioned above, use the local host for the
     database, and use the database named 'dms'.  If you follow the
     examples above in setting up the database, this means KnowledgeTree
     should be fully configured to start working.

   - However, you should change this once you've performed your initial
     evalution of KnowledgeTree for the security of your documents.

   - The following settings in config/environment.php control the
     database connectivity, and can be set as shown:
        [db]
        dbHost           = localhost
        dbName           = release206
        dbUser           = myuser
        dbPass           = mypassword

   - Moving the var directory outside of the documentRoot dir of apache
     Assuming the var directory is set to /var/knowledgeTree

       mv /path/to/your/html/directory/knowledgeTree/var/* /tmp/knowledgeTree/

     config config.ini to reflect that

       vi /path/to/your/html/directory/knowledgeTree/config/config.ini

     change the following value to
       varDirectory = /var/knowledgeTree

   - Set your email server
     config config.ini to reflect that

       vi /path/to/your/html/directory/knowledgeTree/config/config.ini

     change the following value to
       emailServer = your/mail/server

*  Login:
   - in a web browser go to your KnowledgeTree installation via the web
   - default user is "admin" with password "admin"


File Indexing
-------------

The file indexing facilities of KnowledgeTree make use of external
programs to perform their jobs.

It is more troublesome under freeBSD since most of the programs are under ports,
which means you have to compile them yourselves.

   # (export WITHOUT_X11=1; cd /usr/ports/graphics/xpdf; make; make install)
   # (cd /usr/ports/textproc/catdoc; make; make install)
   # (cd /usr/ports/archivers/zip; make; make install)
   # (cd /usr/ports/archivers/unzip; make; make install)

Troubleshooting
---------------

Please make sure that your KnowledgeTree installation passes all the
pre- and post-installation checkups first.

Refer to the Frequently Asked Questions list on the KnowledgeTree Wiki
at http://support.ktdms.com/confluence/

Ask on the KnowledgeTree forums on http://forum.ktdms.com/.

If you have found a bug, please report it to the KnowledgeTree bug
reporting system at http://support.ktdms.com/.