README: DekiWiki Pre-Release Hayes BETA
Thank you for your interest in MindTouch DekiWiki. You can find out more about MindTouch by visiting http://www.MindTouch.com or http://www.OpenGarden.org . OpenGarden.org is a MindTouch sponsored and community supported open source project.
______________________________________________________________________________
TABLE OF CONTENTS:
Thank you for evaluating DekiWiki pre-release Hayes BETA 2. We are very interested in your input and feedback. As you evaluate the beta you should be aware of a few key points. First, this is not a production release and it should not be used as such. That said we are especially interested in feedback on:
The control panel still has significant work left before we officially release Hayes; therefore, before making any recommendations on the control panel please first review doc.opengarden.org/DekiWiki/Specs/Control_Panel_Redesign.
New in Hayes Beta 2:
New in Hayes Beta 1:
If you wish to download the source code of MindTouch DekiWiki or Dream:
See Section 10. Additional Resources for more information and physical address.
If you are interested in MindTouch Deki, the commercial enterprise collaboration wiki that installs in minutes and receives support as well as automatic updates:
deki-hayes
|
+---README - (you're reading this now)
|
+---/config - all configuration that require editing for deployment
|
+---/src - all source code, including API source code
|
+---/web - all files (php and deki api binaries) that are required to install DekiWiki.
When upgrading from previous versions of DekiWiki:
MySQL 5.0.X - NOTE: DekiWiki Hayes uses stored procedures and is therefore incompatible with MySQL 4.x
PHP 5.X - NOTE: DekiWiki Hayes uses the PHP5 object model and is therefore incompatible with PHP4
New in Hayes Beta 2.1:
2040, 2052, 2056, 2062, 2072, 2073, 2093, 2094, 2095
New in Hayes Beta 2:
1844, 1830, 1674, 1844, 1842, 1868, 1846, 1861, 1788, 693, 1857, 1906, 1810,
1847, 1894, 1921, 1887, 1888, 1050, 1765, 1869, 1167, 1964, 1939, 1971, 1969,
1972, 1973, 1978, 1953, 1179, 2032, 2997, 2011, 2028, 1993, 1873, 1935, 1988,
1953, 2010, 2017, 2018, 1797, 2019, 1847, 2003, 1788, 2002, 1782, 1996, 1179
New in Hayes Beta 1:
Split LuceneSearch into its own file
Various improvements to search and bugfixes
Added search for numerical data
Fixed integer parsing bugs in 'gmap()' and 'chat()' live content extensions
Table handling in editor improved
Provided a patch to MySQL bug http://bugs.mysql.com/bug.php?id=28167
New error and warning messaging
Bugs: 1846, 1845, 1845, 1844, 1842, 1825, 1814, 1805, 1788, 1780, 1779, 1775, 1767, 1764, 1763, 1728, 1726, 1723, 1715, 1704, 1689, 1686, 1682, 1679, 1678, 1670, 1669, 1668, 1665, 1649, 1644, 1642, 1641, 1637, 1632, 1631, 1617, 1611, 1610, 1606, 1604, 1599, 1591, 1588, 1582, 1581, 1580, 1578, 1575, 1573, 1564, 1563, 1559, 1558, 1555, 1550, 1549, 1547, 1545, 1544, 1538, 1536, 1529, 1528, 1523, 1510, 1509, 1508, 1503, 1497, 1495, 1480, 1477, 1473, 1472, 1470, 1461, 1458, 1454, 1450, 1444, 1442, 1439, 1437, 1426, 1423, 1422, 1421, 1420, 1407, 1401, 1399, 1398, 1381, 1372, 1367, 1365, 1364, 1350, 1349, 1346, 1329, 1327, 1323, 1300, 1299, 1287, 1285, 1278, 1274, 1273, 1268, 1267, 1263, 1256, 1254, 1241, 1238, 1227, 1223, 1211, 1209, 1204, 1201, 1183, 1165, 1165, 1149, 1142, 1125, 1119, 1096, 1095, 1087, 1075, 1069, 1060, 1051, 1031, 1029, 1012, 1007, 1006, 988, 952, 817, 758, 758, 737, 716, 712, 695, 693, 323, and 307
Visit http://bugs.opengarden.org for more information. NOTE: You must be a registered user of http://www.opengarden.org to browse the bug tracker.
Steps to install DekiWiki Hayes Beta. NOTE: many of the steps below have Debian-specific characteristics.
Apache 2.x
MySQL 5.0.X - NOTE: DekiWiki Hayes uses stored procedures and is therefore incompatible with MySQL 4.x
PHP 5.X - NOTE: DekiWiki Hayes uses the PHP5 object model and is therefore incompatible with PHP4
Mono 1.2.X
Install the prerequisites using apt-get (Debian)
apt-get install apache2 php5 php5-cli php5-mysql libapache2-mod-php5 php5-mcrypt php5-mhash php5-gd php5-curl imagemagick wv pdftohtml html2text html2ps htmldoc aspell links php-pear curl mysql-server-5.0
Install mono
apt-get install mono-gmcs mono-mcs libmono-sqlite2.0-cil libmono-sqlite2.0-cil
install pear libraries
pear install XML_RPC Cache_Lite
set your mysql root password (if this is the first time you've installed mysql)
mysql -e "set password=PASSWORD('your_root_password')"
Download Hayes-Beta build from one of the following sources.
* http://www.opengarden.org/source_code (includes SVN enlistment info)
* http://sourceforge.net/projects/dekiwiki (tarballs)
Extract the archive to your home directory:
cd ~/ tar xfvz dekiwiki-hayes-beta0.2.tar.gz cd deki-hayes
Copy web files to your apache directory
mkdir /var/www/deki-hayes cp -r web/* /var/www/deki-hayes chown -R www-data /var/www/deki-hayes
cd ~/deki-hayes/
Edit the config/deki-apache.conf file
Change the following values according to your setup:
ServerName deki-hayes DocumentRoot "/var/www/deki-hayes"
Copy the apache config file (for example, in Debian do:)
cp config/deki-apache.conf /etc/apache2/sites-available/deki ln -s /etc/apache2/sites-available/deki /etc/apache2/sites-enabled/001-deki
Enable the mod_rewrite module
a2enmod rewrite
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.
Enable mod_proxy_http module
a2enmod proxy_http
Edit the mod_proxy config file (/etc/apache2/mods-available/proxy.conf on Debian) and make sure you have the following:
<Proxy *>
AddDefaultCharset off
Order deny,allow
Deny from all
Allow from all
</Proxy>
Edit your deki apache config file /etc/apache2/sites-available/deki and make sure the following lines are uncommented
# mod_proxy rules ProxyPass /@api http://localhost:8081 ProxyPassReverse /@api http://localhost:8081 SetEnv force-proxy-request-1.0 1 SetEnv proxy-nokeepalive 1
Restart apache to enable the module and apply the new settings
/etc/init.d/apache2 restart
Create the deki-api logfile
touch /var/log/deki-api.log chown www-data /var/log/deki-api.log
Create the mono .wapi directory (Note: the mono .wapi directory needs to exist in the home directory for your apache user. In debian the www-data user's home dir is: /var/www/ but this location may be different for different linux distros.)
mkdir /var/www/.wapi chown www-data /var/www/.wapi
Edit the config/dekihost init script. This script can be used to test the status of deki-api or start/stop the mindtouch.host.sh (deki-api) process. Change the following values to match your configuration:
# path to your wiki DEKI_PATH=/var/www/deki-hayes # this should match your Apache ServerName directive DEKI_SERVERNAME=deki-hayes
Copy the init script
cp config/dekihost /etc/init.d/
Create a symlink to the dekihost init script in the appropriate runlevel
ln -s /etc/init.d/dekihost /etc/rc2.d/S92dekihost
Launch a browser and go to the installer:
http://deki-hayes/config/index.php
Fill in the required information and click "Install DekiWiki"
Complete the installation by running the additional commands as instructed by the installer.
If deki-api failed to load try the following:
* make sure the mono process is running
ps ax|grep mindtouch.host
You should see a process like:
www-data 3401 0.5 15.9 67292 40892 pts/0 Sl 19:25 0:03 mono /var/www/deki-hayes/bin/mindtouch.host.exe apikey 92669 script /etc/dekiwiki/mindtouch.deki.startup.xml server-name http://deki-hayes path-prefix @api http-port 8081 ip localhost notty
If you don't see the process above, check the dekiapi error logs (/var/www/deki-hayes/bin/logs/trace.log) for more details
You can restart the deki-api process by:
/etc/init.d/dekihost restart
Indexing has changed slightly in DekiWiki Hayes. The path to the lucene binaries has been changed to /var/www/deki-hayes/bin/mwsearch in order to keep things more self-contained.
Beta Note: indexing/search may not be functioning properly in the Beta release of Hayes
Edit the mwsearch.conf.deki file and make sure you've defined the following:
databases=wikidb_hayes attachmentpaths=/var/www/deki-hayes/attachments username=root password=mysql_root_password
Edit ~/deki-hayes/config/mwlucene and make sure following is defined:
BIN_DIR=/var/www/deki-hayes/bin/mwsearch
Copy mwsearch.conf
cp ~/deki-hayes/config/mwsearch.conf.deki /etc/mwsearch.conf mkdir /var/run/mwsearch cp ~/deki-hayes/config/mwlucene /etc/init.d/mwlucene chmod +x /etc/init.d/mwlucene ln -s /etc/init.d/mwlucene /etc/rc2.d/S20mwlucene
Rebuild your lucene index:
cd /var/www/deki-hayes/bin/mwsearch ./MWUpdater --rebuild
Start lucene
/etc/init.d/mwlucene start
Verify your new DekiWiki Hayes installation by launching a browser and going to the following URI:
http://deki-hayes/
Steps to install DekiWiki Hayes Beta. NOTE: many of the steps below have Debian-specific characteristics.
Apache 2.x
MySQL 5.0.X - NOTE: DekiWiki Hayes uses stored procedures and is therefore incompatible with MySQL 4.x
PHP 5.X - NOTE: DekiWiki Hayes uses the PHP5 object model and is therefore incompatible with PHP4
Mono 1.2.X
Install the prerequisites using apt-get (Debian)
apt-get install apache2 php5 php5-cli php5-mysql libapache2-mod-php5 php5-mcrypt php5-mhash php5-gd php5-curl imagemagick wv pdftohtml html2text htmldoc html2ps aspell links php-pear curl mysql-server-5.0
Install mono
apt-get install mono-gmcs mono-mcs libmono-sqlite2.0-cil libmono-sqlite2.0-cil
install pear libraries
pear install XML_RPC Cache_Lite
First backup your mysql database:
mysqldump -u your_username -pyour_password your_wikidb > wikidb-backup.sql
Next backup your attached files
cd /var/www/mks-wiki tar cvzf ~/attachments-backup.tar.gz attachments
Download Hayes-Beta build from one of the following sources.
* http://www.opengarden.org/source_code (includes SVN enlistment info)
* http://sourceforge.net/projects/dekiwiki (tarballs)
Extract the archive to your home directory:
cd ~/ tar xfvz dekiwiki-hayes-beta0.2.tar.gz cd deki-hayes
Copy web files to your apache directory
mkdir /var/www/deki-hayes cp -r web/* /var/www/deki-hayes chown -R www-data /var/www/deki-hayes
Create a new database for your wiki (ex: wikidb_hayes)
mysql -u root -pyour_password -e "create database wikidb_hayes"
Populate the database with your old data
mysql -u root -pyour_password wikidb_hayes < wikidb-backup.sql
tar xfvz ~/attachments.tar.gz -C /var/www/deki-hayes/ chown -R www-data /var/www/deki-hayes/attachments
cd ~/deki-hayes/
Edit the config/deki-apache.conf file
Change the following values according to your setup:
ServerName deki-hayes DocumentRoot "/var/www/deki-hayes"
Copy the apache config file (for example, in Debian do:)
cp config/deki-apache.conf /etc/apache2/sites-available/deki ln -s /etc/apache2/sites-available/deki /etc/apache2/sites-enabled/001-deki
Enable the mod_rewrite module
a2enmod rewrite
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.
Enable mod_proxy_http module
a2enmod proxy_http
Edit the mod_proxy config file (/etc/apache2/mods-available/proxy.conf on Debian) and make sure you have the following:
<Proxy *>
AddDefaultCharset off
Order deny,allow
Deny from all
Allow from all
</Proxy>
Edit your deki apache config file /etc/apache2/sites-available/deki and make sure the following lines are uncommented
# mod_proxy rules ProxyPass /@api http://localhost:8081 ProxyPassReverse /@api http://localhost:8081 SetEnv force-proxy-request-1.0 1 SetEnv proxy-nokeepalive 1
Restart apache to enable the module and apply the new settings
/etc/init.d/apache2 restart
Create the deki-api logfile
touch /var/log/deki-api.log chown www-data /var/log/deki-api.log
Create the mono .wapi directory (Note: the mono .wapi directory needs to exist in the home directory for your apache user. In debian the www-data user's home dir is: /var/www/ but this location may be different for different linux distros.)
mkdir /var/www/.wapi chown www-data /var/www/.wapi
Edit the config/dekihost init script. This script can be used to test the status of deki-api or start/stop the mindtouch.host.sh (deki-api) process. Change the following values to match your configuration:
# path to your wiki DEKI_PATH=/var/www/deki-hayes # this should match your Apache ServerName directive DEKI_SERVERNAME=deki-hayes
Copy the init script
cp config/dekihost /etc/init.d/
Create a symlink to the dekihost init script in the appropriate runlevel
ln -s /etc/init.d/dekihost /etc/rc2.d/S92dekihost
Launch a browser and go to the installer:
http://deki-hayes/config/index.php
Fill in the required information and click "Install DekiWiki". The installer should detect that your database is a DekiWiki Gooseberry Schema and apply the appropriate schema changes automatically.
Complete the installation by running the additional commands as instructed by the installer.
Indexing has changed slightly in DekiWiki Hayes. The path to the lucene binaries has been changed to /var/www/deki-hayes/bin/mwsearch in order to keep things more self-contained.
Beta Note: indexing/search may not be functioning properly in the Beta release of Hayes
Edit the mwsearch.conf.deki file and make sure you've defined the following:
databases=wikidb_hayes attachmentpaths=/var/www/deki-hayes/attachments username=root password=mysql_root_password
Copy mwsearch.conf
cp ~/deki-hayes/config/mwsearch.conf.deki /etc/mwsearch.conf mkdir /var/run/mwsearch cp ~/deki-hayes/config/mwlucene /etc/init.d/mwlucene chmod +x /etc/init.d/mwlucene ln -s /etc/init.d/mwlucene /etc/rc2.d/S20mwlucene
Rebuild your lucene index:
cd /var/www/deki-hayes/bin/mwsearch ./MWUpdater --rebuild
Start lucene
/etc/init.d/mwlucene start
Verify your new DekiWiki Hayes installation by launching a browser and going to the following URI:
http://deki-hayes/
MindTouch DekiWiki is the first and only OSI-approved commercial open source wiki.
Deki means smart in Japanese. Combine that with the Hawaiian wikiwiki, meaning fast and quick, and you get DekiWiki in a nutshell: The smartest, fastest, most sophisticated and advanced open-source wiki application available today.
DekiWiki was developed with an emphasis on open standards, extensibility, and performance. It began as a MediaWiki fork and has since become something significantly more than just another Wiki. It facilitates information sharing in a contextually rich environment, has a very polished WYSIWYG Editor, allows the capture and sharing of files, which are indexed and searchable, and stores in XHTML. Indexing is done with Lucene, AJAX is employed where appropriate, and data is portable.
Learn more about DekiWiki: http://opengarden.org/dekiwiki
Additional documentation: http://doc.opengarden.org/Dekiwiki
MindTouch Dream is a RESTfull distributed application framework developed in Mono/.NET. With Dream, a Web service is similar to an object, and features interact through standard HTTP verbs. This design allows the developer to assume an "idealized" world where everything a service comes into contact with is accessed through Web requests. The Dream service library addresses common problems, and the Dream runtime orchestrates all interactions without requiring a Web server to be pre-installed on a target machine. Dream avoids unnecessary abstractions and overhead for services by providing direct access to the rich, distributed application capabilities of HTTP. It can be embedded into existing web-application frameworks or operate independently.
MindTouch Dream manages all the complex aspects of interactive web services, such as providing storage locations, database connections, event notifications, automatic data conversion from XML to JSON and short-circuit communication for co-hosted services. The platform enables developers to create enterprise-ready service architectures with exceptional speed and ease.
Learn more about Dream: http://opengarden.org/dream
Additional documentation: http://doc.opengarden.org/dream
MindTouch, Inc
555 West Beech Street Suite 501
San Diego, CA 92101