KIX 4 KixFw: Document: Downloads and Recommended KIX Directory Arrangements

KIX document content in folder dir_advice

Document title	Downloads and Recommended KIX Directory Arrangements
KIX id	content
Owner	Sverker Griph
Responsible	Sverker Griph
Last modified	2008-12-20 10:01
Current version	3

Version	Published	Title	State
3	2008-12-20 10:01	Downloads and Recommended KIX Directory Arrangements	Current
2	2008-12-19 18:28	Downloads and DEPOT directory arrangement - advice only	Available
1	2008-12-19 10:04	Perl lib arrangement - advice only	Available

+ Plugin view - KixPlugin::Wiki2Html

Exported page ---> /home/oolabs/kixfw/htdocs/kix4kixfw ... KixPlugin::Wiki2Html

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.

+ Plugin view - KixPlugin::DocReview

001: '''Perl lib Directory - Use Symbolic Links to ACTIVE DEPOT Directories'''
002:
003: 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:
004:
005: | Kix -> ../DEPOT/KixFw/ACTIVE/Kix
006: | KixPlugin -> ../DEPOT/KixPlugin/ACTIVE/KixPlugin
007: | MetaAgility -> ../DEPOT/MetaAgility/ACTIVE/MetaAgility
008: | PythonTech -> ../DEPOT/PythonTech/ACTIVE
009: | X3P -> ../DEPOT/X3P/ACTIVE/X3P
010: | RCS
011: | cfw_kix.pm
012:
013: 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.
014:
015: The use of symbolic links makes it much easier to manage future upgrades and roll-backs.
016:
017: '''Create a DEPOT directory'''
018:
019: 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:
020: | DEPOT
021: | DEPOT/KixFw
022: | DEPOT/KixFw/ACTIVE
023: | DEPOT/KixPlugin
024: | DEPOT/KixPlugin/ACTIVE
025: | DEPOT/KixPlugin/ACTIVE/KixPlugin
026: | DEPOT/X3P
027: | DEPOT/X3P/ACTIVE
028: | DEPOT/MetaAgility
029: | DEPOT/MetaAgility/ACTIVE
030: | DEPOT/MetaAgility/ACTIVE/MetaAgility
031: | DEPOT/PythonTech
032: | DEPOT/PythonTech/ACTIVE
033:
034: |
035:
036: '''Download and Install Core Perl Modules into DEPOT'''
037:
038: It is recommended that the latest versions of the following perl modules are downloaded, uncompressed and untared as follows into the proposed DEPOT directories:
039: * Downloads from [[http://www.metaagility.com/sw_distribution/][MetaAgility]]
040: ** ''KixFw'' into ^^DEPOT/KixFw^^
041: ** ''X3P'' into ^^DEPOT/X3P^^
042: ** ''MetaAgility-Reason'' into ^^DEPOT/MetaAgility^^
043: ** ''MetaAgility-DataBox'' into ^^DEPOT/MetaAgility^^
044: * Downloads from [[http://www.pythontech.co.uk/perl/][PythonTech]]
045: ** ''PythonTech-Cfw'' into ^^DEPOT/PythonTech^^
046: ** ''PythonTech-Conv'' into ^^DEPOT/PythonTech^^
047: ** ''PythonTech-Model'' into ^^DEPOT/PythonTech^^
048: ** ''PythonTech-QMap'' into ^^DEPOT/PythonTech^^
049: ** ''PythonTech-Template'' into ^^DEPOT/PythonTech^^
050: ** ''PythonTech-Triples'' into ^^DEPOT/PythonTech^^
051: ** ''PythonTech-WebServer'' into ^^DEPOT/PythonTech^^
052:
053: |
054:
055: '''Install KIX Plugin Perl Modules into DEPOT'''
056:
057: 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:
058:
059: * Downloads from [[http://www.metaagility.com/sw_distribution/][MetaAgility]]
060: ** ''KixPlugin-DocReview'' into ^^DEPOT/KixPlugin^^
061: ** ''KixPlugin-Export2File'' into ^^DEPOT/KixPlugin^^
062: ** ''KixPlugin-Wiki2Html'' into ^^DEPOT/KixPlugin^^
063:
064: |
065:
066: '''Optionally Install CGI::Session'''
067:
068: Depending on which authentication login script is used the '''CGI::Session''' perl module may also be needed.
069:
070: If so create the DEPOT directories
071:
072: | DEPOT/CGI
073: | DEPOT/CGI/ACTIVE
074:
075: and download
076: (for example from [[http://search.cpan.org/dist/CGI-Session/][CPAN]] )
077: ** ''CGI::Session'' into ^^DEPOT/CGI^^
078:
079: |
080:
081: '''Create Symbolic Links to Latest Versions of Downloads'''
082:
083: Create symbolic links in ^^DEPOT/PythonTech/ACTIVE^^ pointing at the perl components of the latest versions of each download component:
084:
085: | Cfw.pm -> ../PythonTech-Cfw-0.3/lib/PythonTech/Cfw.pm
086: | Conv.pm -> ../PythonTech-Conv-1.3/lib/PythonTech/Conv.pm
087: | Form.pm -> ../PythonTech-WebServer-1.1/lib/PythonTech/Form.pm
088: | Login.pm -> ../PythonTech-WebServer-1.1/lib/PythonTech/Login.pm
089: | Model.pm -> ../PythonTech-Model-0.4/lib/PythonTech/Model.pm
090: | Obj.pm -> ../PythonTech-Model-0.4/lib/PythonTech/Obj.pm
091: | QMap.pm -> ../PythonTech-QMap-0.1/lib/PythonTech/QMap.pm
092: | SessionDB -> ../PythonTech-WebServer-1.1/lib/PythonTech/SessionDB
093: | Template.pm -> ../PythonTech-Template-1.2/lib/PythonTech/Template.pm
094: | Triples -> ../PythonTech-Triples-1.1/lib/PythonTech/Triples
095: | Triples.pm -> ../PythonTech-Triples-1.1/lib/PythonTech/Triples.pm
096: | UserDB -> ../PythonTech-WebServer-1.1/lib/PythonTech/UserDB
097: | WebServer.pm -> ../PythonTech-WebServer-1.1/lib/PythonTech/WebServer.pm
098:
099: Create a symbolic link in ^^DEPOT/KixFw/ACTIVE^^ pointing at the Kix lib directory in latest version of the KixFw download component:
100:
101: | Kix -> ../KixFw-1.10/lib/Kix
102:
103: Create symbolic links in ^^DEPOT/MetaAgility/ACTIVE/MetaAgility^^ pointing at the perl components of the latest versions of each download component:
104:
105: | DataBox.pm -> ../../MetaAgility-DataBox-0.0/lib/DataBox.pm
106: | Reason -> ../../MetaAgility-Reason-0.1/lib/Reason
107: | Reason.pm -> ../../MetaAgility-Reason-0.1/lib/Reason.pm
108:
109: Create symbolic links in ^^DEPOT/KixPlugin/ACTIVE/KixPlugin^^ pointing at the perl components of the latest versions of each download component:
110:
111: | Export2File.pm -> ../../KixPlugin-Export2File-1.0/lib/Export2File.pm
112: | Wiki2Html.pm -> ../../KixPlugin-Wiki2Html-1.0/lib/Wiki2Html.pm
113: | DocReview.pm -> ../../KixPlugin-DocReview-1.5/lib/DocReview.pm
114:
115: Create a symbolic link in ^^DEPOT/X3P/ACTIVE^^ pointing at the X3P lib directory in the latest version of the X3P download component:
116:
117: | X3P -> ../X3P-1.3/lib/X3P
118:
119: Back to '''[[installation/content/][main installation instruction]]'''.

Perl link creation out of sequence.
Adam Stephen at 2009-07-08 14:26:38

I think the intent here is to give a flavour of the design, but this section is also necessary to set up the lib links. The links can't be created at this stage.

i.e. The instructions would work best if organised so that they can be followed literally. Of course, this would best be achieved by wrapping the actions as a script.

Kix or KixFw ?
Adam Stephen at 2009-07-08 14:27:49

Is there a good reason why the depot folder is named KixFw, but the link to it is named Fix ?

Version number lags release / order of links.
Adam Stephen at 2009-07-08 14:31:31

1. Webserver is released at 1.2 but the instructions say 1.1. Downloads of latest stable might resolve this ?

2. The order of the .pm files is alphabetical, but when creating the symbolic links, grouping modules from common packages reduces finger load. Again - a script is required to do this, to avoid funger tribble.

MetaAgility path structure mismatch
Adam Stephen at 2009-07-08 14:33:50

The instructions link to ../../Package/lib/Module but the package has a structure ../../Package/lib/MetaAgility/Module.

The same applies to the KixPlugin group.

CGI module lacks symlink instruction
Adam Stephen at 2009-07-08 14:28:49

The instructions say to download CGI::Session but omit to say which elements of this to link into the ACTIVE directory.

+ Current version source

'''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 [[http://www.metaagility.com/sw_distribution/][MetaAgility]]
** ''KixFw'' into ^^DEPOT/KixFw^^
** ''X3P'' into ^^DEPOT/X3P^^
** ''MetaAgility-Reason'' into ^^DEPOT/MetaAgility^^
** ''MetaAgility-DataBox'' into ^^DEPOT/MetaAgility^^
* Downloads from [[http://www.pythontech.co.uk/perl/][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 [[http://www.metaagility.com/sw_distribution/][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 [[http://search.cpan.org/dist/CGI-Session/][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 '''[[installation/content/][main installation instruction]]'''.