Deploying TWiki 4.2.0 on Sun Java Web Server 7.0 ~ Creation Zone

(The following instructions are based on Manish Kapur's Installing TWiki on Sun Java System Web Server. These instructions complement Manish's 2005 blog post)

The goal is to get the TWiki up and running on Sun Java Web Server (formerly known as Sun ONE Web Server / iPlanet Web Server). The assumption is that Sun Java Web Server is running on the Solaris operating system.

Steps:

Create 'twiki' user.

% mkdir /export/twiki
% useradd -d /export/twiki -s /bin/bash twiki
% cd /export
% chown twiki:other twiki
% passwd twiki

Install Sun Java Web Server 7.0 Update 2 in /export/twiki/sjws7u2 directory. Select 'Custom' installation; and choose port '8080' to run the web server.

Sun Java Web Server 7.0 Update 2 is available for free at Sun Downloads web site.
View by Category -> Web & Proxy Servers -> Web Servers -> Web Server 7.0 Update 2.

Install TWiki 4.2.0

Download TWiki tgz file

% mkdir /export/twiki/sjws7u2/https-<hostname>/docs/twiki
% cp TWiki-4.2.0.tgz /export/twiki/sjws7u2/https-<hostname>/docs/twiki
% cd /export/twiki/sjws7u2/https-<hostname>/docs/twiki
% gunzip TWiki-4.2.0.tgz
% tar xf TWiki-4.2.0.tar

Enable CGI on the web server

cd /export/twiki/sjws7u2/https-<hostname>/config

Edit the 'default' section of obj.conf file to include the following two lines

NameTrans fn="pfx2dir" from="/twiki/view" dir="/export/twiki/sjws7u2/<hostname>/docs/twiki/bin/view" name="cgi" Service fn="send-cgi" type="magnus-internal/cgi" nice="10"

Hopefully the following example gives an idea on where to insert those two lines. In the example, 't2000-240-08' is the hostname.

 % diff -C 3 obj.conf obj.conf.orig

*** obj.conf    Wed May 14 01:36:34 2008
--- obj.conf.orig       Wed May 14 01:02:52 2008
***************
*** 10,17 ****
  AuthTrans fn="match-browser" browser="*MSIE*" ssl-unclean-shutdown="true"
  NameTrans fn="ntrans-j2ee" name="j2ee"
  NameTrans fn="pfx2dir" from="/mc-icons" dir="/export/twiki/sjws7u2/lib/icons" name="es-internal"
- # Consider anything in the directory /export/twiki/sjws7u2/https-t2000-240-08/docs/twiki/bin to be a CGI
- NameTrans fn="pfx2dir" from="/twiki/view" dir="/export/twiki/sjws7u2/https-t2000-240-08/docs/twiki/bin/view" name="cgi"
  PathCheck fn="uri-clean"
  PathCheck fn="check-acl" acl="default"
  PathCheck fn="find-pathinfo"
--- 10,15 ----
***************
*** 20,27 ****
  ObjectType fn="type-j2ee"
  ObjectType fn="type-by-extension"
  ObjectType fn="force-type" type="text/plain"
- # Run CGI processes with a "Nice" level of 10
- Service fn="send-cgi" type="magnus-internal/cgi" nice="10"
  Service method="(GET|HEAD)" type="magnus-internal/directory" fn="index-common"
  Service method="(GET|HEAD|POST)" type="*~magnus-internal/*" fn="send-file"
  Service method="TRACE" fn="service-trace"
--- 18,23 ----

Install Revision Control System (RCS), GNU diff utilities (diffutils) and update the PATH variable in user's .profile.

Those packages are available in 'ready to install' form at sunfreeware.com and blastwave.org web sites. Perhaps the easiest way is to use pkg-get to pull those packages with the required dependencies from Blastwave.

Assuming RCS and diffutils are available under /usr/csw/bin directory,
```
% cat ~/.profile | grep PATH
export PATH=/usr/bin:/usr/sbin:/usr/local/bin:/usr/sfw/bin:/usr/csw/bin:$PATH
```
Configure the TWiki. Edit TWiki's *.cfg files, that is.
1. Create the config file LocalLib.cfg.
  1. There is a template for this config file in twiki/bin/LocalLib.cfg.txt. Copy LocalLib.cfg.txt to LocalLib.cfg.
```
% cd /export/twiki/sjws7u2/https-<hostname>/docs/twiki/bin
% cp LocalLib.cfg.txt LocalLib.cfg
```
  2. Edit LocalLib.cfg to update the $twikiLibPath variable.
    $twikiLibPath = "/export/twiki/sjws7u2/https-<hostname>/docs/twiki/lib";
2. Manually create the config file LocalSite.cfg.
```
% cd /export/twiki/sjws7u2/https-<hostname>/docs/twiki/lib
% cp TWiki.spec LocalSite.cfg
```
3. Update the following variables with appropriate values in LocalSite.cfg.
  
  $TWiki::cfg{DefaultUrlHost}, $TWiki::cfg{ScriptUrlPath}, $TWiki::cfg{PubUrlPath}, $TWiki::cfg{PubDir}, $TWiki::cfg{TemplateDir}, $TWiki::cfg{DataDir}, $TWiki::cfg{LocalesDir}, and $TWiki::cfg{OS}, $TWiki::cfg{RCS}{EgrepCmd} and $TWiki::cfg{RCS}{FgrepCmd}.
  
  This diff output shows how they were configured in the demo TWiki that I used for the Proof-Of-Concept (POC). The hardware it was deployed on is a Sun Fire T2000. So Cool Stack was installed on the server to take advantage of the optimized Perl.
Exit the current shell; and reconnect.

Restart the Sun Java Web Server.

% cd /export/twiki/sjws7u2/https-<hostname>/bin
% ./stopserv
% ./startserv

Manually execute the 'view' script from the command line.
```
% cd /export/twiki/sjws7u2/https-/docs/twiki/bin
% ./view
```
You should see valid HTML (not errors) on the stdout. If you see errors, check /export/twiki/sjws7u2/https-<hostname>/logs/errors for the error messages. Fix the issues and re-run 'view' from the command line. Continue this exercise until the script returns valid HTML.
Finally verify the TWiki installation through the web browser.
Open http://<webhost>:<port>/twiki/view in a web browser.