Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml,v diff -u -N -r1.44 -r1.45 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml 13 Jan 2005 13:55:16 -0000 1.44 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml 16 Feb 2005 00:18:52 -0000 1.45 @@ -711,7 +711,7 @@ set use_categories_p [parameter::get -parameter "EnableCategoriesP" -default 0] - if { $use_categories_p == 1 && [exists_and_not_null category_id] } { + if { $use_categories_p == 1 && [exists_and_not_null category_id] } { set from_clause "category_object_map com, acs_named_objects nam" set_where_clause "com.object_id = qa.entry_id and @@ -773,7 +773,7 @@ <multiple name="categories"> <h2>@categories.tree_name@ <group column="tree_id"> - <a href="@package_url@cat/@categories.category_id@?@YOURPARAMS@&category_id=@categories.category_id@">@categories.category_name@ + <a href="@package_url@cat/@categories.category_id@?@YOURPARAMS@&category_id=@categories.category_id@">@categories.category_name@ </group> </multiple> <a href="@package_url@view?@YOURPARAMS@">All Items</if> Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml,v diff -u -N -r1.25 -r1.26 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml 5 Feb 2005 18:22:17 -0000 1.25 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/aolserver4.xml 16 Feb 2005 00:18:52 -0000 1.26 @@ -159,8 +159,7 @@ Install nssha1 - [root nspostgres]# cd ../nssha1 -[root nssha1]# + [root nspostgres]# cd ../nssha1 Now install nssha1: [root nssha1]# make install AOLSERVER=/usr/local/aolserver40r10 If the make fails you will have to edit nssha1.c. Comment out the following 2 lines (lines 139-140): Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml,v diff -u -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml 13 Jan 2005 13:55:17 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/maintenance.xml 16 Feb 2005 00:18:52 -0000 1.25 @@ -838,52 +838,7 @@ - - - - Creating an appropriate tuning and monitoring environment - - The first task is to create an appropriate environment for finding out - what is going on inside Oracle. Oracle provides Statspack, a package to - monitor and save the state of the v$ performance views. These reports - help finding severe problems by exposing summary data about the Oracle - wait interface, executed queries. You'll find the installation - instructions in $ORACLE_HOME/rdbms/admin/spdoc.txt. Follow the - instructions carefully and take periodic snapshots, this way you'll be - able to look at historical performance data. - - - - Also turn on the timed_statistics in your init.ora file, so that - Statspack reports (and all other Oracle reports) are timed, which makes - them a lot more meaningful. The overhead of timing data is about 1% per - Oracle Support information. - - - - - To be able to get a overview of how Oracle executes a particular query, - install "autotrace". I usually follow the instructions here http://asktom.oracle.com/~tkyte/article1/autotrace.html. - - - Make sure, that the Oracle CBO works with adequate statistics - - - The Oracle Cost Based optimizer is a piece of software that tries to find - the "optimal" execution plan for a given SQL statement. For that it - estimates the costs of running a SQL query in a particular way (by default - up to 80.000 permutations are being tested in a Oracle 8i). To get an - adequate cost estimate, the CBO needs to have adequate statistics. For - that Oracle supplies the dbms_stats - package. - - - - - - ($Id$) + ($Id$) Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/software.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/software.xml,v diff -u -N -r1.20 -r1.21 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/software.xml 13 Jan 2005 13:55:17 -0000 1.20 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/software.xml 16 Feb 2005 00:18:52 -0000 1.21 @@ -3,7 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ %myvars; -<<]> +]> Prerequisite Software @@ -19,7 +19,7 @@ Version Compatibility Matrix - + @@ -29,7 +29,8 @@ - + + OpenACS Version @@ -41,476 +42,490 @@ 4.6.3 5.0 5.1 + 5.2 - - AOLserver - 3 - Yes - No - - - 3.3+ad13 - Maybe - Yes - - - 3.3oacs1 - Maybe - Yes - - - 3.4.2 - No - - - 3.4.2oacs1 - Maybe - Yes - Maybe - - - 3.5.5 - Maybe - Yes - No - - - 4.0 - Maybe - Yes - - - PostgreSQL - 7.0 - Yes - No - - - 7.2 - Yes - No - - - 7.3.2 - 7.3.x - No - Yes - - - 7.4 - No - Yes - - - Oracle - 8.1.6 - Maybe - Yes - - - 8.1.7 - Maybe - Yes - - - 9i - No - Yes - - - -
- The OpenACS installation instructions assume the operating system and build environment are installed. + + AOLserver + 3 + Yes + No + + + 3.3+ad13 + Maybe + Yes + No + + + 3.3oacs1 + Maybe + Yes + No + + + 3.4.2 + No + + + 3.4.2oacs1 + Maybe + Yes + No + + + 3.5.5 + Maybe + Yes + No + + + 4.0 + Maybe + Yes + + + PostgreSQL + 7.0 + Yes + No + + + 7.2 + Maybe + Yes + No + + + 7.3.2 - 7.3.x + No + Yes + + + 7.4 + No + Yes + + + 8.0 + No + Maybe + Yes + + + Oracle + 8.1.6 + Maybe + Yes + + + 8.1.7 + Maybe + Yes + + + 9i + No + Yes + + + + + The OpenACS installation instructions assume the operating system and build environment are installed. The instructions explain installation of TCL, tDOM, tclwebtest, a Web Server, a Database, a Process Controller, and Source Control software. The following external links are for reference only. - - - <ulink + </para> + <itemizedlist> + <listitem id="openacs-download"><formalpara><title><ulink url="http://openacs.org/projects/openacs/download/">OpenACS &version;</ulink> - The OpenACS tarball comprises the core packages and - many useful additional packages. This includes a full set - of documentation. The tarball works with both PostgreSQL - and Oracle. Some scripts require bash shell. + The OpenACS tarball comprises the core packages and + many useful additional packages. This includes a full set + of documentation. The tarball works with both PostgreSQL + and Oracle. Some scripts require bash shell. + + + + + + Operating System + OpenACS is designed for a Unix-like system. It is + developed primarily in Linux. It can be run on Mac OS X, + and in Windows within VMWare. + + + + + + GNU/Linux + The installation assumes a linux kernel of 2.2.22 or newer, or 2.4.14 or newer. - - Operating System - OpenACS is designed for a Unix-like system. It is - developed primarily in Linux. It can be run on Mac OS X, - and in Windows within VMWare. - - - - - - GNU/Linux - The installation assumes a linux kernel of 2.2.22 or newer, or 2.4.14 or newer. - - - - - FreeBSD - FreeBSD guide. The OpenACS Reference Platform uses shell scripts written for bash, which is the + FreeBSD + FreeBSD guide. The OpenACS Reference Platform uses shell scripts written for bash, which is the standard Linux shell. If you are using a different shell, you will need to substitute your shell's conventions for setting environment variables when appropriate, and install bash to work with the scripts. Substitute fetch when the instructions suggest you use wget to download software. - - - - - Mac OS X - - - - - - Windows/VMWare - The only + + + + + Mac OS X + + + + + + Windows/VMWare + The only way to run OpenACS on Windows is through the VMWare emulator. (Please let me know if you have OpenACS running directly in Windows.) - - - + + + + + + Build Environment + The Reference Platform installation compiles most programs from + source code. + + - Build Environment - The Reference Platform installation compiles most programs from - source code. - - - - - <ulink url="http://www.gnu.org/software/libc/libc.html">glibc</ulink> 2.2 or newer, REQUIRED - You need recent versions of these libraries for + <ulink url="http://www.gnu.org/software/libc/libc.html">glibc</ulink> 2.2 or newer, REQUIRED + You need recent versions of these libraries for Oracle to work properly. For Unicode support, you need glibc 2.2 or newer. This should be included in your operating system distribution. - - - - - <ulink url="http://www.gnu.org/software/make/">GNU Make</ulink> 3.76.1 or newer, REQUIRED - PostgreSQL and AOLserver require gmake to - compile. Note that on most linux - distributions, GNU Make is simply named - make and - there is no - gmake, - whereas on BSD distributions, - make and - gmake are - different --use gmake. - - - + - <ulink url="http://www.tcl.tk/">TCL</ulink> 8.4.x - + <ulink url="http://www.gnu.org/software/make/">GNU Make</ulink> 3.76.1 or newer, REQUIRED + PostgreSQL and AOLserver require gmake to + compile. Note that on most linux + distributions, GNU Make is simply named + make and + there is no + gmake, + whereas on BSD distributions, + make and + gmake are + different --use gmake. - - - - <ulink url="http://www.tcl.tk/">TCL</ulink> 8.4.x, REQUIRED - OpenACS is written in TCL, an interpreted + + + + + + <ulink url="http://www.tcl.tk/">TCL</ulink> 8.4.x + + + + + + <ulink url="http://www.tcl.tk/">TCL</ulink> 8.4.x, REQUIRED + OpenACS is written in TCL, an interpreted language. A threaded version of the TCL interpreter must be installed for OpenACS to work. The TCL interpreter that is included in most standard distributions may not be thread safe. - - - - - <ulink url="http://www.tcl.tk/">TCL</ulink> 8.4.x development headers and libraries, OPTIONAL - The site-wide-search service, OpenFTS, requires these to - compile. (Debian users: apt-get install - tcl8.4-dev). You need this + + + + + <ulink url="http://www.tcl.tk/">TCL</ulink> 8.4.x development headers and libraries, OPTIONAL + The site-wide-search service, OpenFTS, requires these to + compile. (Debian users: apt-get install + tcl8.4-dev). You need this to install OpenFTS. - - - + + + - - - <ulink url="http://www.tdom.org/">tDOM</ulink>, REQUIRED - OpenACS &version; stores + + + <ulink url="http://www.tdom.org/">tDOM</ulink>, REQUIRED + OpenACS &version; stores queries in XML files, so we use an AOLserver module called tDOM to parse these files. (This replaces libxml2, which was used prior to 4.6.4.) - - + + - - - <ulink url="http://sourceforge.net/project/showfiles.php?group_id=31075">tclwebtest</ulink>, OPTIONAL - tclwebtest is a tool for testing web interfaces via tcl scripts. - + + + <ulink url="http://sourceforge.net/project/showfiles.php?group_id=31075">tclwebtest</ulink>, OPTIONAL + tclwebtest is a tool for testing web interfaces via tcl scripts. + - + + + Web Server + The web server handles incoming HTTP requests, provides + a runtime environment for OpenACS's tcl code, connects to the + database, sends out HTTP responses, and logs requests and + errors. OpenACS uses AOLserver; + some people have had success running Apache with mod_nsd. + + + + + - Web Server - The web server handles incoming HTTP requests, provides - a runtime environment for OpenACS's tcl code, connects to the - database, sends out HTTP responses, and logs requests and - errors. OpenACS uses AOLserver; - some people have had success running Apache with mod_nsd. + <ulink url="http://aolserver.com/">AOLserver</ulink> 4.x, REQUIRED + Provides the base HTTP server - - - - - - <ulink url="http://aolserver.com/">AOLserver</ulink> 4.x, REQUIRED - Provides the base HTTP server - - + + - - Mat Kovach is graciously maintaining an AOLserver distribution that - includes all the patches and modules needed to run OpenACS &version;. These - instructions will describe how to install using his source - distribution. He also has binaries for SuSE 7.3 and OpenBSD 2.8 (and - perhaps more to come), currently located at uptime.openacs.org. - + + Mat Kovach is graciously maintaining an AOLserver distribution that + includes all the patches and modules needed to run OpenACS &version;. These + instructions will describe how to install using his source + distribution. He also has binaries for SuSE 7.3 and OpenBSD 2.8 (and + perhaps more to come), currently located at uptime.openacs.org. + - - It's also possible to download all the pieces and patches yourself: - - - - - AOLserver is available at aolserver.com - - - - The OpenACS PostgreSQL driver (nspostgres.so) is available from - SourceForge. If - you do decide to use nspostgres.so, you have to remember to - change the AOLserver config file to point to nspostgres.so - instead of postgres.so. This guide uses Mat Kovach's distro - (i.e. postgres.so) + + It's also possible to download all the pieces and patches yourself: + + + + + AOLserver is available at aolserver.com + + + + The OpenACS PostgreSQL driver (nspostgres.so) is available from + SourceForge. If + you do decide to use nspostgres.so, you have to remember to + change the AOLserver config file to point to nspostgres.so + instead of postgres.so. This guide uses Mat Kovach's distro + (i.e. postgres.so) - + - - The patch that makes exec work - on BSD is available at sourceforge.net - - - - The patch for aolserver 3.x that makes ns_uuencode - work for binary files is available at sourceforge.net - - - - The patch that makes AOLserver 3.x respect the - -g flag is available at - sourceforge.net - - - - - - - - nsopenssl, OPTIONAL - Provides SSL capabilities for AOLserver. It requires - OpenSSL. You need this if you want users to make - secure (https) connections to your webserver. - aolserver3.x requires nsopenssl 2.1a. aolserver4.x requires nsopenssl3; see - aolserver.com for latest release. (home page) - - - - - - - <ulink url="http://braindamage.alal.com/software/nspam.html">ns_pam</ulink> 0.1 or newer, OPTIONAL - Provides PAM capabilities for AOLserver. You - need this if you want OpenACS users to authenticate - through a PAM module (such as RADIUS). - - - - - - - <ulink - url="ftp://ftp.freeradius.org/pub/radius/pam_radius-1.3.16.tar">pam_radius 1.3.16</ulink>, OPTIONAL - Provides RADIUS capabilities for PAM. You need - this if you want to use RADIUS authentication via PAM in OpenACS. - - + + The patch that makes exec work + on BSD is available at sourceforge.net + + + + The patch for aolserver 3.x that makes ns_uuencode + work for binary files is available at sourceforge.net + + + + The patch that makes AOLserver 3.x respect the + -g flag is available at + sourceforge.net + + + + + + + + nsopenssl, OPTIONAL + Provides SSL capabilities for AOLserver. It requires + OpenSSL. You need this if you want users to make + secure (https) connections to your webserver. + aolserver3.x requires nsopenssl 2.1a. aolserver4.x requires nsopenssl3; see + aolserver.com for latest release. (home page) + + + + + + + <ulink url="http://braindamage.alal.com/software/nspam.html">ns_pam</ulink> 0.1 or newer, OPTIONAL + Provides PAM capabilities for AOLserver. You + need this if you want OpenACS users to authenticate + through a PAM module (such as RADIUS). + + + + + + + <ulink + url="ftp://ftp.freeradius.org/pub/radius/pam_radius-1.3.16.tar">pam_radius 1.3.16</ulink>, OPTIONAL + Provides RADIUS capabilities for PAM. You need + this if you want to use RADIUS authentication via PAM in OpenACS. + + - - - <ulink - url="http://sourceforge.net/project/showfiles.php?group_id=3152">ns_ldap 0.r8</ulink>, OPTIONAL - Provides LDAP capabilities for AOLserver. You need - this if you want to use LDAP authentication in OpenACS. - - + + + <ulink + url="http://sourceforge.net/project/showfiles.php?group_id=3152">ns_ldap 0.r8</ulink>, OPTIONAL + Provides LDAP capabilities for AOLserver. You need + this if you want to use LDAP authentication in OpenACS. + + - - - - <ulink - url="http://unc.dl.sourceforge.net/sourceforge/openfts/Search-OpenFTS-tcl-0.3.2.tar.gz">OpenFTS TCL 0.3.2</ulink>, OPTIONAL - Adds full-text-search to PostgreSQL and includes a - driver for AOLserver. You need this if you want users - to be able to search for any text on your site. - - - - - - - <ulink + + <listitem id="openfts-download"> + <formalpara> + <title><ulink + url="http://unc.dl.sourceforge.net/sourceforge/openfts/Search-OpenFTS-tcl-0.3.2.tar.gz">OpenFTS + TCL 0.3.2</ulink>, OPTIONAL Adds + full-text-search to PostgreSQL and includes a driver for + AOLserver. You need this if you want users to be able to + search for any text on your site. For postgres 7.4.x and + higher, full text search is also available via tsearch2. + + + + + + + + <ulink url="http://www.analog.cx/">Analog</ulink> 5.32 or newer, OPTIONAL - This program examines web server request logs, looks up - DNS values, and produces a report. You need this if you - want to see how much traffic your site is getting. - - + This program examines web server request logs, looks up + DNS values, and produces a report. You need this if you + want to see how much traffic your site is getting. + + - - - <ulink + <listitem> + <formalpara id="balance-download"> + <title><ulink url="http://sourceforge.net/projects/balance/">Balance</ulink> 3.11 or newer, OPTIONAL - "Balance is a simple but powerful generic tcp proxy with round robin load balancing and failover mechanisms." You need this or something equivalent if you are running a high-availability production site and do not have an external load balancing system. - - - - - + "Balance is a simple but powerful generic tcp proxy with round robin load balancing and failover mechanisms." You need this or something equivalent if you are running a high-availability production site and do not have an external load balancing system. + + + + + + Database + The data on your site (for example, user names and passwords, + calender entries, and notes) is stored in the database. + OpenACS separates the database with an abstraction layer, + which means that several different databases all function + identically. While you can run the core OpenACS on any + supported database, not all contributed packages support all + databases. + + + - Database - The data on your site (for example, user names and passwords, - calender entries, and notes) is stored in the database. - OpenACS separates the database with an abstraction layer, - which means that several different databases all function - identically. While you can run the core OpenACS on any - supported database, not all contributed packages support all - databases. - - - - - - Oracle 8.1.7 (Either this or PostgreSQL is REQUIRED) - You can register and download Oracle from Oracle - TechNet. You need this if you want to use an + Oracle 8.1.7 (Either this or PostgreSQL is REQUIRED) + You can register and download Oracle from Oracle + TechNet. You need this if you want to use an Oracle database. - - - - - <ulink url="http://sourceforge.net/projects/pgsql/">PostgreSQL</ulink> 7.4.x (Either this or Oracle is REQUIRED) - You need this if you want to use a PostgreSQL database. - - - + - - Process Controller - This is software that initiates other software, and + + <ulink url="http://sourceforge.net/projects/pgsql/">PostgreSQL</ulink> 7.4.x (Either this or Oracle is REQUIRED) + You need this if you want to use a PostgreSQL database. + + + + + + + Process Controller + This is software that initiates other software, and restarts that software if it fails. On Linux, we recommend using Daemontools to control AOLserver and qmail. + + + + + <ulink + url="http://cr.yp.to/daemontools/daemontools-0.76.tar.gz">Daemontools + 0.76</ulink>, OPTIONAL You need this if + you want AOLserver and qmail to run "supervised," + meaning that they are monitored and automatically + restarted if they fail. An alternative would be to + run the services from inittab. - - - - <ulink - url="http://cr.yp.to/daemontools/daemontools-0.76.tar.gz">Daemontools 0.76</ulink>, OPTIONAL - You need this if you want AOLserver and qmail to run - "supervised," meaning that they are monitored and - automatically restarted if they fail. - - + + + - - - Mail Transport Agent - A Mail Transport Agent is a program that handles all + + + Mail Transport Agent + A Mail Transport Agent is a program that handles all incoming and outgoing mail. The Reference Platform uses Qmail; any MTA that provides a sendmail wrapper (that is, that can be invoked by calling the sendmail program with the same variables that sendmail expects) can be used. - - - - - <ulink - url="http://www.qmail.org/netqmail/">Netqmail 1.04</ulink>, OPTIONAL - You need this (or a different Mail Transport + + + + + <ulink + url="http://www.qmail.org/netqmail/">Netqmail 1.04</ulink>, OPTIONAL + You need this (or a different Mail Transport Agent) if you want your webserver to send and receive email. - - - - - <ulink - url="http://cr.yp.to/ucspi-tcp/ucspi-tcp-0.88.tar.gz">ucspi-tcp 0.88</ulink>, OPTIONAL - This program listens for incoming TCP connections and - hands them to a program. We use it instead of inetd, - which is insecure. You need this if you are running qmail. - - - - - + - - <ulink url="http://www.docbook.org/">DocBook</ulink>, OPTIONAL - (docbook-xml v4.2, docbook-xsl v1.56, libxslt 1.0.21, - xsltproc 1.0.21). You need this to write or edit documentation. - + + <ulink + url="http://cr.yp.to/ucspi-tcp/ucspi-tcp-0.88.tar.gz">ucspi-tcp 0.88</ulink>, OPTIONAL + This program listens for incoming TCP connections and + hands them to a program. We use it instead of inetd, + which is insecure. You need this if you are running qmail. - - - - Source Control - A Source Control system keeps track of all of the old + + + + + + <ulink url="http://www.docbook.org/">DocBook</ulink>, OPTIONAL + (docbook-xml v4.2, docbook-xsl v1.56, libxslt 1.0.21, + xsltproc 1.0.21). You need this to write or edit documentation. + + + + + + + Source Control + A Source Control system keeps track of all of the old versions of your files. It lets you recover old files, compare versions of file, and identify specific versions of files. You can use any source control system; the Reference Platform and the OpenACS.org repository (where you can get patched and development code in between releases) use cvs. - - - - - <ulink url="https://www.cvshome.org/">cvs</ulink> 1.11.2, OPTIONAL - cvs is included in most unix distributions. You + + + + + <ulink url="https://www.cvshome.org/">cvs</ulink> 1.11.18, OPTIONAL + cvs is included in most unix distributions. You need this if you want to track old versions of your files, do controlled deployment of code from development to production, or get or contribute development code from openacs.org. - - - + - ($Id: software.xml,v 1.8 2003/10/29 - 09:01:09 joela Exp $) - + + + ($Id$) + Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml,v diff -u -N -r1.36 -r1.37 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml 13 Jan 2005 13:55:18 -0000 1.36 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/upgrade.xml 16 Feb 2005 00:18:52 -0000 1.37 @@ -423,7 +423,7 @@ upgrade to OpenACS 5.2, you'll need to check out another branch. - The openacs-5-1-compat tag identifies the latest released version of OpenACS 5.1 (ie, 5.1.3 or 5.1.4) and the latest compatible version of each package. Each minor release of OpenACS since 5.0 has this tagging structure. For example, OpenACS 5.1.x has openacs-5-1-compat. + The openacs-5-1-compat tag identifies the latest released version of OpenACS 5.1 (ie, 5.1.3 or 5.1.4) and the latest compatible version of each package. Each minor release of OpenACS since 5.0 has this tagging structure. For example, OpenACS 5.1.x has openacs-5-1-compat. You will want to separately check out all the packages you are using. @@ -455,8 +455,10 @@ - Update your local CVS working checkout (unless - you just set it up). + Update CVS + Update your local CVS working checkout (unless + you just set it up). + [root root]# su - $OPENACS_SERVICE_NAME [$OPENACS_SERVICE_NAME aolserver]$ cd /var/lib/aolserver/openacs-5-1 [$OPENACS_SERVICE_NAME aolserver]$ cvs up -Pd ChangeLog *.txt bin etc tcl www packages/*