Sun SPARC Solaris 8

Download Hayes Bits

Download Hayes build from one of the following sources.

• RECOMMENDED: http://sourceforge.net/projects/dekiwiki (tarballs)
  
• http://wiki.opengarden.org/Source_Code (includes SVN enlistment info)

Extract the archive to your home directory:

cd $HOME
wget http://jaist.dl.sourceforge.net/sourceforge/dekiwiki/Deki_Wiki_1.8.3c_Hayes_source.tar.gz
gtar xfvz Deki_Wiki_1.8.3c_Hayes_source.tar.gz
cd Deki_Wiki_1.8.3c_Hayes_source

Copy web files to your apache share directory.

NOTE:
The Blastwave.com 's Apache package configured to use "/opt/csw/apache2/share/htdocs" as DocumentRoot, but I choose "/opt/csw/apache2/share/deki-hayes" to DocumentRoot for Deiki Wiki's exclusive use.

mkdir /opt/csw/apache2/share/deki-hayes 
cp -r web/*  /opt/csw/apache2/share/deki-hayes 
chown -R nobody:nogroup /opt/csw/apache2/share/deki-hayes

(OPTIONAL)
If you use Internet Explorer 6.0 browser, I recommend to do next ops to avoid link error for Deiki Wiki 1.8.3c.

cd /opt/csw/apache2/share/deki-hayes/skins/
cp common/icons/icon-*.gif ace/neutral/
cp common/icons/icon-*.gif ace/blue/
cp common/icons/anim-save.gif ace/neutral/
cp common/icons/anim-save.gif ace/blue/

Configure Apache server for Deki Wiki

Deki Wiki contains a Apache configuration file named "deki-apache.conf".
I include this file (deki-apache.conf) into the Apache bundled configuration file (httpd.conf).

Copy the "deki-apache.conf" file from source onto Apache configuration direcory.

cd $HOME/Deki_Wiki_1.8.3c_Hayes_source
cp -pi ./config/deki-apache.conf /opt/csw/apache2/etc/deki-apache.conf.orig
cp -pi ./config/deki-apache.conf /opt/csw/apache2/etc/deki-apache.conf

Edit and Change the "deki-apache.conf"file according to your setup:

• ServerName :
  hostname (or FQDN) for your Solaris box
• ErrorLog :
  error reporting file for Apache server
  
• CustomLog :
  access reporting file for Apache server
• DocumentRoot :
  pathname of subdirectory which containing the Deki Wiki web files.

vi /opt/csw/apache2/etc/deki-apache.conf
diff /opt/csw/apache2/etc/deki-apache.conf.orig /opt/csw/apache2/etc/deki-apache.conf
2c2
<       ServerName deki-hayes
---
>       ServerName hostname.mydomain.com
4,5c4,5
<       ErrorLog /var/log/apache2/error.log
<       CustomLog /var/log/apache2/access.log common
---
>       ErrorLog /opt/csw/apache2/var/log/error_log
>       CustomLog /opt/csw/apache2/var/log/access_log common
7c7
<       DocumentRoot "/var/www/deki-hayes"
---
>       DocumentRoot "/opt/csw/apache2/share/deki-hayes"

Add the Proxy definition to end of "deki-apache.conf"file.

<Proxy *>
    AddDefaultCharset off
    Order deny,allow
    Deny from all
    Allow from all
</Proxy>

As a result, "deki-apache.conf"seems to like this.

cat /opt/csw/apache2/etc/deki-apache.conf
<VirtualHost *>
	ServerName hostname.mydomain.com

	ErrorLog /opt/csw/apache2/var/log/error_log
	CustomLog /opt/csw/apache2/var/log/access_log common

	DocumentRoot "/opt/csw/apache2/share/deki-hayes"

	RewriteEngine On
	RewriteCond %{REQUEST_URI} ^/$
	RewriteRule ^/$ /index.php?title= [L,NE]

	RewriteCond %{REQUEST_URI} ^/@gui/[^.]+$
	RewriteRule ^/@gui/(.*)$ /proxy.php?path=$1 [L,QSA,NE] 

	RewriteCond %{REQUEST_URI} !^/(@api|editor|skins|config|@gui)/
	RewriteCond %{REQUEST_URI} !^/index\.php
	RewriteCond %{REQUEST_URI} !^/favicon\.ico$
	RewriteCond %{REQUEST_URI} !^/robots\.txt$
	RewriteCond %{QUERY_STRING} ^$ [OR] %{REQUEST_URI} ^/Special:Search
	RewriteRule ^/(.*)$ /index.php?title=$1 [L,QSA,NE]

	# deki-api uses encoded slashes in query parameters so AllowEncodedSlashes must be On
	AllowEncodedSlashes On   

	# mod_proxy rules
	ProxyPass /@api http://localhost:8081 retry=1
	ProxyPassReverse /@api http://localhost:8081
	SetEnv force-proxy-request-1.0 1
	SetEnv proxy-nokeepalive 1

</VirtualHost>

<Proxy *>
    AddDefaultCharset off
    Order deny,allow
    Deny from all
    Allow from all
</Proxy>

Configure Apache Server for deki-api application

The deki-api is a .NET application which runs under the Mono runtime.  deki-api runs as a standalone mono application which uses MindTouch Dream's built-in webserver.  mod_proxy proxy is used to proxy requests from apache to deki-api.

cp -pi /opt/csw/apache2/etc/httpd.conf /opt/csw/apache2/etc/httpd.conf.orig
vi /opt/csw/apache2/etc/httpd.conf

(1) add next two lines to this file near end of the file.
# Deki Wiki settings
Include etc/deki-apache.conf

(2) enable next three lines
LoadModule proxy_module libexec/mod_proxy.so
LoadModule proxy_http_module libexec/mod_proxy_http.so
LoadModule rewrite_module libexec/mod_rewrite.so

(3) change DocumentRoot and the web root Directory to point directory Deki Wiki web files.
DocumentRoot "/opt/csw/apache2/share/deki-hayes"
<Directory "/opt/csw/apache2/share/deki-hayes">

(4) So that diffential between original file and edited file is:
diff /opt/csw/apache2/etc/httpd.conf.orig /opt/csw/apache2/etc/httpd.conf
95c95
< #LoadModule proxy_module libexec/mod_proxy.so
---
> LoadModule proxy_module libexec/mod_proxy.so
98c98
< #LoadModule proxy_http_module libexec/mod_proxy_http.so
---
> LoadModule proxy_http_module libexec/mod_proxy_http.so
173c173,174
< DocumentRoot "/opt/csw/apache2/share/htdocs"
---
> # DocumentRoot "/opt/csw/apache2/share/htdocs"
> DocumentRoot "/opt/csw/apache2/share/deki-hayes"
200c201,202
< <Directory "/opt/csw/apache2/share/htdocs">
---
> # <Directory "/opt/csw/apache2/share/htdocs">
> <Directory "/opt/csw/apache2/share/deki-hayes">
472a475,477
> # Deki Wiki settings
> Include etc/deki-apache.conf
>

Restart Apache to enable the module and apply the new settings

/etc/rc3.d/S50cswapache2 graceful

At this time, Apache's error_log file should not report any errors.

# tail -f /opt/csw/apache2/var/log/error_log
[Sun Feb 24 15:07:21 2008] [notice] Digest: generating secret for digest authentication ...
[Sun Feb 24 15:07:21 2008] [notice] Digest: done
[Sun Feb 24 15:07:21 2008] [notice] Apache/2.2.6 (Unix) PHP/5.2.4 configured
 -- resuming normal operations

NOTE :
To run syntax check for Apache configuration file, use options of Apache server.

(1) to run syntax check for config files
# /opt/csw/apache2/sbin/httpd -t
Syntax OK

(2) to show parsed settings
# /opt/csw/apache2/sbin/httpd -S
VirtualHost configuration:
wildcard NameVirtualHosts and _default_ servers:
*:*                    hostname.mydomain.com (/opt/csw/apache2/etc/deki-apache.conf:1)
Syntax OK

(3) to show all loaded modules
# /opt/csw/apache2/sbin/httpd -M
 (snip)

Configure deki-api application

Create the deki-api logfile with null contents which writable to Apache user.

# touch /var/log/deki-api.log
# chown nobody:nogroup /var/log/deki-api.log
# chmod 644 /var/log/deki-api.log
# ls -l /var/log/deki-api.log
-rw-r--r--   1 nobody   nogroup        0 Feb 24 15:33 /var/log/deki-api.log

Create the Mono's ".wapi" directory, then change the owner to Apache user.

NOTE:

• The Mono ".wapi" directory needs to exist in the home directory for your Apache user. In this guide the nobody user's home directory is "/" (root directory).
• Note that Apache user and home directory depend on Apache configuration.

# mkdir /.wapi
# chown nobody:nogroup /.wapi
# ls -la /.wapi
total 100
drwxr-xr-x   2 nobody   nogroup      512 Feb 24 11:08 .
drwxr-xr-x  27 root     root        1024 Feb 24 14:20 ..

Copy and Edit the config/dekihost init script. This script can be used to test the status of the deki-api or start/stop the "mindtouch.host.sh" (deki-api) process.

Change the following to match your configuration:

• DEKI_PATH :
  pathname of subdirectory which copy the Deki Wiki web files.
• DEKI_SERVERNAME :
  hostname of your Solaris box
• Apache user:
  effective user of Apache HTTP server, which described "User/Group" parameter in the /opt/csw/apache2/etc/httpd.conf file.
  
• su command:
  In Solaris "su" command cannot specify a shell at argument, so that removed from command line.
• wc command:
  In Solaris "wc" command count "0" if no new line characters found. I search status code instead of line count.
  

NOTE:
It is generally used that "nobody" on Solaris, but "nobody" has no shell definition at /etc/password file for security reason, so that default shell (/usr/bin/sh) is used.
And then "nobody" has the "/" (root directory) as home directory, therefor "nobody" sharing dot-files like "/.bash_profile", "/.bashrc", "/.profile" with super-user ("root").

# cd $HOME/Deki_Wiki_1.8.3c_Hayes_source
# cp -pi config/dekihost /etc/init.d/dekihost 
# chown root:root /etc/init.d/dekihost 
# chmod 744 /etc/init.d/dekihost 
# ln -s /etc/init.d/dekihost /etc/rc3.d/S92dekihost
# ls -l /etc/init.d/dekihost /etc/rc3.d/S92dekihost
-rwxr--r--   1 root     root         961 Feb  1 05:58 /etc/init.d/dekihost
lrwxrwxrwx   1 root     other         20 Mar  1 17:28 /etc/rc3.d/S92dekihost -> /etc/init.d/dekihost
# vi /etc/init.d/dekihost
# diff config/dekihost /etc/init.d/dekihost
4c4,5
< DEKI_PATH=/var/www/deki-hayes
---
> # DEKI_PATH=/var/www/deki-hayes
> DEKI_PATH=/opt/csw/apache2/share/deki-hayes
7c8,9
< DEKI_SERVERNAME=deki-hayes
---
> # DEKI_SERVERNAME=deki-hayes
> DEKI_SERVERNAME=localhost
13c15
< 		su -s /bin/bash www-data -- $DEKI_PATH/bin/mindtouch.host.sh start
---
> 		su - nobody -c "$DEKI_PATH/bin/mindtouch.host.sh start"
19c21
< 		su -s /bin/bash www-data -- $DEKI_PATH/bin/mindtouch.host.sh stop
---
> 		su - nobody -c "$DEKI_PATH/bin/mindtouch.host.sh stop"
28d29
< 	DREAM_OK=`curl -m 3 -s http://$DEKI_SERVERNAME/@api/host/test | grep "<status>200</status>" | wc -l`
30c31,32
< 	if [ $DREAM_OK = 1 ]; then 
---
> 	curl -m 3 -s http://$DEKI_SERVERNAME/@api/host/test | grep "<status>200</status>" > /dev/null
> 	if [ $? = 0 ]; then 

Then /etc/init.d/dekihost will be:

#!/bin/bash

# path to your wiki
# DEKI_PATH=/var/www/deki-hayes
DEKI_PATH=/opt/csw/apache2/share/deki-hayes

# this should match your Apache ServerName directive 
# DEKI_SERVERNAME=deki-hayes
DEKI_SERVERNAME=localhost

prog="MindTouch Deki Host Service"

start(){
	if [ -f $DEKI_PATH/bin/mindtouch.host.sh ]; then
		su - nobody -c "$DEKI_PATH/bin/mindtouch.host.sh start"
	fi
}

stop(){
	if [ -f $DEKI_PATH/bin/mindtouch.host.sh ]; then
		su - nobody -c "$DEKI_PATH/bin/mindtouch.host.sh stop"
	fi
}

status(){
	testDream
}

testDream() {
	echo -n "Dream @ (http://$DEKI_SERVERNAME) "
	curl -m 3 -s http://$DEKI_SERVERNAME/@api/host/test | grep "<status>200</status>" > /dev/null
	if [ $? = 0 ]; then 
		echo '[OK]'
	else
		echo '[FAILED']
	fi
}

restart(){
    start
}

# See how we were called.
case "$1" in
  start)
    start
    ;;
  stop)
    stop
    ;;
  status)
    status
    ;;
  restart)
    restart
    ;;
  *)
    echo $"Usage: $0 {start|stop|status|restart}"
    exit 1
esac

exit $?

Setup Lucene Index

Create a empty folder to store search index file.

mkdir -p /opt/csw/apache2/share/deki-hayes/bin/cache/luceneindex/
chown -R nobody:nogroup /opt/csw/apache2/share/deki-hayes/bin/cache/luceneindex/
chmod -R 775 /opt/csw/apache2/share/deki-hayes/bin/cache/luceneindex/

Deki Wiki site configuration using the web-installer

Launch a browser and go to the installer:

http://<hostname>/config/index.php

"DEKI WIKI Installation" page will be shown in your browser.

Environmental checking are all well and fine except "html2ps" not found warning.

Checking environment...
If you run into installation problems, please include the following lines.

o PHP 5.2.4 installed. 
o Found database drivers for: MySQL. 
o PHP server API is apache2handler. 
o Have XML / Latin1-UTF-8 conversion support. 
o Session save path (/tmp) appears to be valid.
o PHP's memory_limit is 128M. 
o Apache version Apache/2.2.6. 
o apache mod_rewrite enabled. 
o apache mod_proxy enabled. 
o MySQL enabled, client version: 5.0.51. 
o curl enabled, version: 7.18.0. 
o Found ImageMagick: /opt/csw/bin/convert; image thumbnailing will be enabled. 
o Found ImageMagick: /opt/csw/bin/identify; image thumbnailing will be enabled. 
o Found GD graphics library. 
o Found mono: /opt/csw/bin/mono.
o Found html2ps: /opt/csw/bin/html2ps
o Found ps2pdf: /opt/csw/bin/ps2pdf. 
o Installation directory: /opt/csw/apache2/share/htdocs/deki-hayes. 

Environment checked. You can install Deki Wiki.

OK !
Enter required information for Deki Wiki as below:

Deki Wiki Basic Setup

Site name: Deki Wiki
System e-mail:  your e-mail
Admin e-mail:  your e-mail
Admin username:  Admin
Admin password:  *****
Confirm password:  *****
Full Name:  (Optional)
Phone:  (Optional)
[X] Receive updates and notifications from MindTouch about Deki Wiki

Database Configuration

Database type:  MySQL 
Database host:  localhost
Database name:  wikidb
DB username:  wikiuser
DB password:  *****
DB password confirm: *****
[X] My database user doesn't exist
Superuser name: root
Superuser password: *****

Deki API Configuration

API Key: ******************************

Advanced Configuration

ImageMagick convert: /opt/csw/bin/convert
ImageMagick identify : /opt/csw/bin/identify

Fill in the required information and click "Install Deki Wiki !"

Performing installation...

o Generating LocalSettings.php configuration file... 
o Database type: MySQL 
o Attempting to connect to database server as root...success. 
o Connected to 5.0.51 
o Attempting to create database...
o Created database wikidb 
o Creating tables... done. 
o Granting user permissions to wikiuser on wikidb...success. 
o Created sysop account Admin. 
o Inserting wgDekiApiKey into config table...done. 
o Setting storage path in config table...done. 
o Setting Site Name int config table...done. 
o Creating stored procedures... Done. 
o Creating LocalSettings.php...Done 
o Creating AdminSettings.php...Done 
o Creating mindtouch.deki.startup.xml...Done. 
o Creating mindtouch.host.sh...Done. 

Installation successful!

 But wait, you're not done yet!

Please run the following commands manually from the command line 
to complete your installation:

cd /opt/csw/apache2/share/deki-hayes/config
mkdir /etc/dekiwiki
chown www-data /etc/dekiwiki
cp mindtouch.deki.startup.xml /etc/dekiwiki
cp LocalSettings.php /opt/csw/apache2/share/deki-hayes/
cp AdminSettings.php /opt/csw/apache2/share/deki-hayes/
cp mindtouch.host.sh /opt/csw/apache2/share/deki-hayes/bin/
/etc/init.d/dekihost start

You should change file permissions for LocalSettings.php, AdminSettings.php
as required to prevent other users on the server reading passwords and 
altering configuration data.

Complete the installation by running the additional commands as instructed by the installer.

NOTE:
Don't run commands shown by browser, they are for Linux distribution and not for Solaris.

Run the next commands for Solaris.

(1) install derived files into suitable directory

cd /opt/csw/apache2/share/deki-hayes/config/
ls -l mindtouch.deki.startup.xml LocalSettings.php AdminSettings.php mindtouch.host.sh
-rw-rw-rw-   1 nobody   nobody        68 Mar  1 18:49 AdminSettings.php
-rw-rw-rw-   1 nobody   nobody       881 Mar  1 18:49 LocalSettings.php
-rw-rw-rw-   1 nobody   nobody      6004 Mar  1 18:49 mindtouch.deki.startup.xml
-rwxr-xr-x   1 nobody   nobody      1302 Mar  1 18:49 mindtouch.host.sh

mkdir /etc/dekiwiki
chown nobody:nogroup /etc/dekiwiki

cp -pi mindtouch.deki.startup.xml /etc/dekiwiki/
cp -pi LocalSettings.php /opt/csw/apache2/share/deki-hayes/
cp -pi AdminSettings.php /opt/csw/apache2/share/deki-hayes/
cp -pi mindtouch.host.sh /opt/csw/apache2/share/deki-hayes/bin/

chmod 644 /etc/dekiwiki/mindtouch.deki.startup.xml
chmod 644 /opt/csw/apache2/share/deki-hayes/AdminSettings.php
chmod 644 /opt/csw/apache2/share/deki-hayes/LocalSettings.php

(2) modify mindtouch.host.sh to prepare environment for the Mono runtime

cp -pi /opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.sh \
/opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.sh.orig

vi /opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.sh

Insert next two lines under the first line of mindtouch.host.sh
# setenv to run Mono
. /.bash_profile

diff /opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.sh.orig \
/opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.sh
1a2,5
>
> # setenv to run Mono
> . /.bash_profile
>

Start the deki-api daemon.

# /etc/rc3.d/S92dekihost start
Stopping MindTouch Deki API
Starting MindTouch Deki API: mono /opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.exe apikey
 gtG01EEqKkDmVFasUbXrV1i0sgP5tm05 script /etc/dekiwiki/mindtouch.deki.startup.xml path-prefix
 @api http-port 8081 ip localhost notty connect-limit -5

# ps -ef | grep mono
  nobody  6438     1  0 19:24:57 pts/2    0:05 mono
 /opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.exe apikey gtG01EEqKk

# ls -l /var/log/deki-api.log
-rw-r--r--   1 nobody   nogroup      122 Mar 1 19:25 /var/log/deki-api.log

deki-api's Log file is here:

# tail -f /var/log/deki-api.log
-------------------- initializing
-------------------- initialized 1.744082 secs
-------------------- ready 1.202315 secs

At this point you can talk to the deki-api daemon via the HTTP request.

deki-api daemon test:

# curl -i http://localhost:8081/deki/@about
HTTP/1.1 200 OK
Server: Dream-HTTPAPI/1.5.0.24910
Response-Uri: http://localhost:8081/deki/@about
Content-Type: text/html; charset=utf-8
Date: Sat, 01 Mar 2008 10:29:45 GMT
Content-Length: 50475
Connection: close

<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MindTouch Deki Wiki Service</title>
<meta http-equiv="content-type" content="text/html;charset=utf-8" />
  (snip long HTML code)
</body></html>

Verification Deki Wiki

Verify your new Deki Wiki Hayes installation by launching a browser and going to the following URI:

http://<hostname>/index.php

(Appendix) Troubleshooting

If deki-api failed to load try the following:

* if you get "no default auth service" make sure your proxy settings are correct and that your firewall isn't blocking port 8081.

* if your database name has an underscore, you have get an "execute command denied" error. If so, create a new database user, grant them the right perms (CRUD), and set them as the database user in LocalSettings.php

* make sure the mono process is running

ps -ef | grep mindtouch.host

You should see a process like:

nobody  6526     1  0 19:39:32 pts/2    0:37 mono \
/opt/csw/apache2/share/deki-hayes/bin/mindtouch.host.exe apikey gtG01EEqKk

If you don't see the process above, check the dekiapi error logs (/opt/csw/apache2/share/deki-hayes/bin/logs/trace.log) for more details

You can restart the deki-api process by:

/etc/init.d/dekihost restart

(Appendix) Known issue of Deki Wiki Hayes running on Solaris

* [Printing] PDF conversion does not work.. I have no identifiable cause of this issue yet.

* [About] Incorrect OS name displays on "About" page. :-)
You are using MindTouch Deki Wiki 1.8.3c (rev. ) running on: Linux 5.8, PHP 5.2.4, mySQL 14.12 distribution 5.0.51, and Mono 20080223.

* [Performance] The "mono" prosess continue to run away (eat 100% of CPU power) while huge page being saved. The browser expire save error after about 5 minite. Then 10-20 minites ago the "mono" process move to steady state. This could be dependent on speciic page (this guide). The reproducibility was low but occur at two machines. No reproducibility on VMware version of Deiki Wiki Hayes 1.8.3b at the same ops.

(Appendix) Basic file layout

/.bash_profile - personal initialization file for bash (shared by root and nobody)
/.wgetrc - personal initialization file for wget
/etc
	/dekiwiki
		mindtouch.deki.startup.xml - deki-api server configuration file
	/init.d
		dekihost - startup for deki-api
	/rc3.d
		S40cswmysql5 - startup for MySQL server
		S50cswapache2 -> ../init.d/cswapache2 - startup Apache server
		S92dekihost -> /etc/init.d/dekihost - startup for deki-api
/opt
	/csw
		/apache2
			/etc
				deki-apache.conf - Apache config file for Deki Wiki
				httpd.conf - Apache "main" config file (includes deki-apache.conf)
			/share
				/deki-hayes - DocumentRoot for the Deki Wiki "Hayes release"
					/bin
						/cache
							/luceneindex - Lucene index directory
						mindtouch.host.exe - deki-api daemon executable
						mindtouch.host.sh - deki-api startup script
						/logs
							info.log
							trace.log
							warning.log
						LocalSettings.php
						AdminSettings.php
				/htdocs - DocumentRoot of Apache original (Not used)
			/var
				/log
					access_log - Apache access log file
					error_log - Apache error log file
		/bin
			wget - network utility to retrieve files from the Web
			mono - .NET runtime
			gmcs - C# compiler
		/etc
			pkg-get.conf - pkg-get configuration file
		/mysql
			my.cnf - configuration file for MySQL server
		/php5
			/lib
				php.ini - configuration for PHP5
/var
	/log
		deki-api.log - deki-api log file
/.wapi - Mono shared directory

END OF GUIDE