Downloads and Recommended KIX Directory Arrangements


Perl lib Directory - Use Symbolic Links to ACTIVE DEPOT Directories

The objective of the proposed KIX directory structure is to create a perl lib directory with symbolic links to all downloaded perl modules. See the following example:

 Kix -> ../DEPOT/KixFw/ACTIVE/Kix
 KixPlugin -> ../DEPOT/KixPlugin/ACTIVE/KixPlugin
 MetaAgility -> ../DEPOT/MetaAgility/ACTIVE/MetaAgility
 PythonTech -> ../DEPOT/PythonTech/ACTIVE
 X3P -> ../DEPOT/X3P/ACTIVE/X3P
 RCS
 cfw_kix.pm
Note. The cfw_kix.pm file is part of the KixFw distribution but it needs to be adapted to each installation. Hence it has been copied here and is managed via an RCS repository.

The use of symbolic links makes it much easier to manage future upgrades and roll-backs.

Create a DEPOT directory

If your server environment does not include a DEPOT directory it is recommended that such a directory is created. It is recommended that this directory should have the following subdirectory structure to provide flexible installation support for KIX:

 DEPOT
 DEPOT/KixFw
 DEPOT/KixFw/ACTIVE
 DEPOT/KixPlugin
 DEPOT/KixPlugin/ACTIVE
 DEPOT/KixPlugin/ACTIVE/KixPlugin
 DEPOT/X3P
 DEPOT/X3P/ACTIVE
 DEPOT/MetaAgility
 DEPOT/MetaAgility/ACTIVE
 DEPOT/MetaAgility/ACTIVE/MetaAgility
 DEPOT/PythonTech
 DEPOT/PythonTech/ACTIVE
   
Download and Install Core Perl Modules into DEPOT

It is recommended that the latest versions of the following perl modules are downloaded, uncompressed and untared as follows into the proposed DEPOT directories:

  • Downloads from MetaAgility
    • KixFw into DEPOT/KixFw
    • X3P into DEPOT/X3P
    • MetaAgility-Reason into DEPOT/MetaAgility
    • MetaAgility-DataBox into DEPOT/MetaAgility
  • Downloads from PythonTech
    • PythonTech-Cfw into DEPOT/PythonTech
    • PythonTech-Conv into DEPOT/PythonTech
    • PythonTech-Model into DEPOT/PythonTech
    • PythonTech-QMap into DEPOT/PythonTech
    • PythonTech-Template into DEPOT/PythonTech
    • PythonTech-Triples into DEPOT/PythonTech
    • PythonTech-WebServer into DEPOT/PythonTech
   
Install KIX Plugin Perl Modules into DEPOT

Once KIX has been installed KIX it is very likely that some plugin modules are required. Thus it is recommended that the following plugins are installed as follows:

  • Downloads from MetaAgility
    • KixPlugin-DocReview into DEPOT/KixPlugin
    • KixPlugin-Export2File into DEPOT/KixPlugin
    • KixPlugin-Wiki2Html into DEPOT/KixPlugin
   
Optionally Install CGI::Session

Depending on which authentication login script is used the CGI::Session perl module may also be needed.

If so create the DEPOT directories

 DEPOT/CGI
 DEPOT/CGI/ACTIVE
and download (for example from CPAN )
    • CGI::Session into DEPOT/CGI
   
Create Symbolic Links to Latest Versions of Downloads

Create symbolic links in DEPOT/PythonTech/ACTIVE pointing at the perl components of the latest versions of each download component:

 Cfw.pm -> ../PythonTech-Cfw-0.3/lib/PythonTech/Cfw.pm
 Conv.pm -> ../PythonTech-Conv-1.3/lib/PythonTech/Conv.pm
 Form.pm -> ../PythonTech-WebServer-1.1/lib/PythonTech/Form.pm
 Login.pm -> ../PythonTech-WebServer-1.1/lib/PythonTech/Login.pm
 Model.pm -> ../PythonTech-Model-0.4/lib/PythonTech/Model.pm
 Obj.pm -> ../PythonTech-Model-0.4/lib/PythonTech/Obj.pm
 QMap.pm -> ../PythonTech-QMap-0.1/lib/PythonTech/QMap.pm
 SessionDB -> ../PythonTech-WebServer-1.1/lib/PythonTech/SessionDB
 Template.pm -> ../PythonTech-Template-1.2/lib/PythonTech/Template.pm
 Triples -> ../PythonTech-Triples-1.1/lib/PythonTech/Triples
 Triples.pm -> ../PythonTech-Triples-1.1/lib/PythonTech/Triples.pm
 UserDB -> ../PythonTech-WebServer-1.1/lib/PythonTech/UserDB
 WebServer.pm -> ../PythonTech-WebServer-1.1/lib/PythonTech/WebServer.pm
Create a symbolic link in DEPOT/KixFw/ACTIVE pointing at the Kix lib directory in latest version of the KixFw download component:
 Kix -> ../KixFw-1.10/lib/Kix
Create symbolic links in DEPOT/MetaAgility/ACTIVE/MetaAgility pointing at the perl components of the latest versions of each download component:
 DataBox.pm -> ../../MetaAgility-DataBox-0.0/lib/DataBox.pm
 Reason -> ../../MetaAgility-Reason-0.1/lib/Reason
 Reason.pm -> ../../MetaAgility-Reason-0.1/lib/Reason.pm
Create symbolic links in DEPOT/KixPlugin/ACTIVE/KixPlugin pointing at the perl components of the latest versions of each download component:
 Export2File.pm -> ../../KixPlugin-Export2File-1.0/lib/Export2File.pm
 Wiki2Html.pm -> ../../KixPlugin-Wiki2Html-1.0/lib/Wiki2Html.pm
 DocReview.pm -> ../../KixPlugin-DocReview-1.5/lib/DocReview.pm
Create a symbolic link in DEPOT/X3P/ACTIVE pointing at the X3P lib directory in the latest version of the X3P download component:
 X3P -> ../X3P-1.3/lib/X3P
Back to main installation instruction.

The KixFw development team would appreciate any comments or questions. Include your details if you wish to be contacted. kix4kixfw
 
 

2008-12-20 10:01


Home of kixfw.sourceforge.net
Contact kixfw project