The reference install stores all OpenACS services in /web, with one subdirectory per service. The first time you install a service, you must create that directory and set its permissions:

[root@yourserver root]# mkdir /web
[root@yourserver root]# chgrp web /web
[root@yourserver root]# chmod 770 /web
[root@yourserver root]#
mkdir /web
chgrp web /web
chmod 770 /web

You should already have downloaded the OpenACS tarball to the /tmp directory. If noot, download the OpenACS tarball and save it in /tmp and proceed:

Set up your user account.

AOLserver needs to be started as the root user if you want to use port 80. Once it starts, though, it will drop the root privileges and run as another user, which you must specify on the command line. It's important that this user has as few privileges as possible. Why? Because if an intruder somehow breaks in through AOLserver, you don't want her to have any ability to do damage to the rest of your server.

At the same time, AOLserver needs to have write access to some files on your system in order for OpenACS to function properly. So, we'll run AOLserver with a different user account for each different service. A service name should be a single word, letters and numbers only. If the name of your site is one word, that would be a good choice. For example "service0" might be the service name for the service0.net community.

For the 4.6.3-P and 4.6.3-O Reference Platform, we'll use a server named service0 and a user named service0. We'll leave the password blank for increased security. The only way to log in will be with ssh certificates. The only people who should log in are developers for that specific instance. Add this user, and put it in the web group so that it can use database commands associated with that group.

[root@yourserver root]# useradd -g web service0
[root@yourserver root]#

Set up database environment variables. They are necessary for working with the database.

[root@yourserver root]# su - service0
[service0@yourserver service0]$ emacs .bashrc

Put in the appropriate lines for the database you are running. If you will use both databases, put in both sets of lines.

Test this by logging out and back in as service0 and checking the paths.

[service0@yourserver service0]$ exit
logout
[root@yourserver src]# su - service0
[postgres@yourserver pgsql]$ env | grep PATH

For PostGreSQL, you should see:

LD_LIBRARY_PATH=LD_LIBRARY_PATH=:/usr/local/pgsql/lib
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/usr/bin/X11:/usr/X11R6/bin:/root/bin:/usr/local/pgsql/bin:/usr/local/pgsql/bin

For Oracle:

ORACLE_BASE=/ora8/m01/app/oracle
ORACLE_HOME=/ora8/m01/app/oracle/product/8.1.7
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/usr/bin/X11:/usr/X11R6/bin:/root/bin:/ora8/m01/app/oracle/product/8.1.7/bin
LD_LIBRARY_PATH=/ora8/m01/app/oracle/product/8.1.7/lib:/lib:/usr/lib
ORACLE_SID=ora8
ORACLE_TERM=vt100
ORA_NLS33=$ORACLE_HOME/ocommon/nls/admin/data

[service0@yourserver service0]$ exit
logout

[root@yourserver root]#

Unpack the OpenACS tarball and rename it to service0. Secure the directory so that only the owner can access it. Check the permissions by listing the directory.

[root@yourserver root]# su - service0
[service0@yourserver service0]$ cd /web
[service0@yourserver web]$ tar xzf /tmp/openacs-4.6.2.tgz
[service0@yourserver web]$ mv openacs-4.6.2 service0
[service0@yourserver web]$ chmod -R 700 service0
[service0@yourserver web]$ ls -al
total 3
drwxrwx---    3 root     web          1024 Mar 29 16:41 .
drwxr-xr-x   25 root     root         1024 Mar 29 16:24 ..
drwx------    7 service0 web          1024 Jan  6 14:36 service0
[service0@yourserver web]$ exit
logout

[root@yourserver root]#
su - service0
cd /web
tar xzf /tmp/openacs-4.6.2.tgz
mv openacs-4.6.2 service0
chmod -R 700 service0/
exit

Add the Service to CVS - OPTIONAL. If this is a development server, you may want to add it to a CVS repository..

Set up several additional directories in the service root: etc is for configuration and control files, log is for error and request (web page hit) log files, and database-backup is for database backup files. If you did the CVS step, note that these new directories are excluded from that step so that you can decide whether or not you want your logs and config files in source control.

[root@yourserver root]# su - service0
[service0@yourserver service0]$ mkdir /web/service0/etc /web/service0/log /web/service0/database-backup
[service0@yourserver web]$ exit
logout

[root@yourserver web]#
su - service0
mkdir /web/service0/etc /web/service0/log /web/service0/database-backup
exit

Verify membership by typing groups when you login:

service0:~$ groups
dba web

If you do not see these groups, take the following action:

service0:~$ su -      
Password: ************
root:~# adduser service0 dba

If you get an error about an undefined group, then add that group manually:

root:~# groupadd dba
root:~# groupadd web

Make sure to logout as root when you are finished with this step and log back in as your regular user.

Connect to Oracle using svrmgrl and login:

service0:~$ svrmgrl

SVRMGR> connect internal
Connected.

Determine where the system tablespaces are stored:

SVRMGR>  select file_name from dba_data_files;

Example results:

/ora8/m01/app/oracle/oradata/ora8/system01.dbf
/ora8/m01/app/oracle/oradata/ora8/tools01.dbf
/ora8/m01/app/oracle/oradata/ora8/rbs01.dbf
/ora8/m01/app/oracle/oradata/ora8/temp01.dbf
/ora8/m01/app/oracle/oradata/ora8/users01.dbf
/ora8/m01/app/oracle/oradata/ora8/indx01.dbf
/ora8/m01/app/oracle/oradata/ora8/drsys01.dbf

Using the above output, you should determine where to store your tablespace. As a general rule, you'll want to store your tablespace on a mount point under the /ora8 directory that is separate from the Oracle system data files. By default, the Oracle system is on m01, so we will use m02. This enables your Oracle system and database files to be on separate disks for optimized performance. For more information on such a configuration, see Chapter 12 of Philip's book. For this example, we'll use /ora8/m02/oradata/ora8/.

Create the directory for the datafile; to do this, exit from svrmgrl and login as root for this step:

SVRMGR> exit
service0:~$ su -
Password: ************
root:~# mkdir -p /ora8/m02/oradata/ora8/
root:~# chown service0.web /ora8/m02/oradata/ora8
root:~# chmod 775 /ora8/m02/oradata/ora8
root:~# exit
service0:~$

Create a tablespace for the service. It is important that the tablespace can autoextend. This allows the tablespace's storage capacity to grow as the size of the data grows. We set the pctincrease to be a very low value so that our extents won't grow geometrically. We do not set it to 0 at the tablespace level because this would affect Oracle's ability to automatically coalesce free space in the tablespace.

service0:~$ svrmgrl

SVRMGR> connect internal;
SVRMGR> create tablespace service0 
             datafile '/ora8/m02/oradata/ora8/service001.dbf' 
             size 50M 
             autoextend on 
             next 10M
             maxsize 300M
             extent management local
             uniform size 32K;

Create a database user for this service. Give the user access to the tablespace and rights to connect. We'll use service0password as our password.

Write down what you specify as service_name (i.e. service0) and database_password (i.e. service0password). You will need this information for configuring exports and AOLserver.

SVRMGR> create user service0 identified by service0password default tablespace service0
temporary tablespace temp quota unlimited on service0;
SVRMGR> grant connect, resource, ctxapp, javasyspriv, query rewrite to service0;
SVRMGR> revoke unlimited tablespace from service0;
SVRMGR> alter user service0 quota unlimited on service0;
SVRMGR> exit;

Your table space is now ready. In case you are trying to delete a previous OpenACS installation, consult these commands in the section called “Deleting a tablespace” below.

Make sure that you can login to Oracle using your service_name account:

service0:~$ sqlplus service0/service0password
SQL> select sysdate from dual;

SYSDATE
----------
2001-12-20

SQL> exit

You should see today's date in a format 'YYYY-MM-DD.' If you can't login, try redoing step 1 again. If the date is in the wrong format, make sure you followed the steps outlined in the section called “Troubleshooting Oracle Dates”

Create a user in the database matching the service name.

[root@yourserver root]# su - postgres
[postgres@yourserver pgsql]$ createuser service0
Shall the new user be allowed to create databases? (y/n) y
Shall the new user be allowed to create more new users? (y/n) y
CREATE USER
[postgres@yourserver pgsql]$ exit
logout

[root@yourserver root]#

Create a database with the same name as our service name, service0.

[root@yourserver root]# su - service0
[service0@yourserver service0]$ createdb service0
CREATE DATABASE
[service0@yourserver service0]$
su - service0
createdb service0

Automate daily database Vacuuming. This is a process which cleans out discarded data from the database. A quick way to automate vacuuming is to edit the cron file for the database user.

[service0@yourserver service0]$ export EDITOR=emacs;crontab -e

Add this line to the file. The numbers and stars at the beginning are cron columns that specify when the program should be run - in this case, whenever the minute is 0 and the hour is 1, i.e., 1:00 am every day.

0 1 * * * /usr/local/pgsql/bin/vacuumdb service0

Add Full Text Search Support - OPTIONAL

If you are installing Full Text Search, add required packages to the new database.

[service0@yourserver service0]$ /usr/local/pgsql/bin/psql service0 -f /usr/local/src/postgresql-7.2.3/contrib/tsearch/tsearch.sql
BEGIN
CREATE
(many lines omitted)
INSERT 0 1
COMMIT
[service0@yourserver service0]$ /usr/local/pgsql/bin/psql service0 -f /usr/local/src/postgresql-7.2.3/contrib/pgsql_contrib_openfts/openfts.sql
CREATE
CREATE
[service0@yourserver service0]$
/usr/local/pgsql/bin/psql service0 -f /usr/local/src/postgresql-7.2.3/contrib/tsearch/tsearch.sql
/usr/local/pgsql/bin/psql service0 -f /usr/local/src/postgresql-7.2.3/contrib/pgsql_contrib_openfts/openfts.sql

[service0@yourserver service0]$ exit
logout

[root@yourserver root]# 

The AOLserver architecture lets you run an arbitrary number of virtual servers. A virtual server is an HTTP service running on a specific port, e.g. port 80. In order for OpenACS to work, you need to configure a virtual server. The Reference Platform uses a configuration file included in the OpenACS tarball. Copy it to the /web/service0/etc directory and open it in an editor to adjust the parameters.

[root@yourserver root]# su - service0
[service0@yourserver service0]$ cd /web/service0/etc
[service0@yourserver etc]# cp /web/service0/packages/acs-core-docs/www/files/config.tcl.txt config.tcl
[service0@yourserver etc]# emacs config.tcl

You can continue without changing any values in the file. However, if you don't change address to match the computer's ip address, you won't be able to browse to your server from other machines.

AOLServer is very configurable. These settings should get you started, but for more options, read the AOLServer docs.

OPTIONAL: To run OpenFTS, uncomment this line from config.tcl. (To uncomment a line in a tcl file, remove the # at the beginning of the line.)

#ns_param   nsfts           ${bindir}/nsfts.so

OPTIONAL: To run nsopenssl:

Kill any current running AOLserver processes and start a new one. (Note, if you are using Oracle, rather than PostgreSQL, replace nsd-postgres with nsd-oracle). If you are using port 80, you must be root for this step.

[service0@yourserver etc]$ killall nsd
nsd: no process killed
[service0@yourserver service0]$ /usr/local/aolserver/bin/nsd-postgres -t /web/service0/etc/config.tcl
[service0@yourserver service0]$ [08/Mar/2003:18:13:29][32131.8192][-main-] Notice: nsd.tcl: starting to read config file...
[08/Mar/2003:18:13:29][32131.8192][-main-] Notice: nsd.tcl: finished reading config file.

Attempt to connect to the service from a web browser as you did You should specify a URL like:

You should see a page that looks like this. If you imported your files into cvs, now that you know it worked you can erase the temp directory with rm -rf /web/service0.orig.

If you don't see the login page, view your error log (/web/service0/log/service0-error.log) to make sure the service is starting without any problems. The most common errors here are trying to start a port 80 server while not root, failing to connect because of a firewall, and aolserver failing to start due to permissions errors or missing files. If you need to make changes, don't forget to kill any running servers with killall nsd.

OPTIONAL - Automate AOLserver keepalive

Assuming AOLserver started cleanly in the previous step, we'll set it up so that it's always running, and automatically restarts whenever it dies or is stopped. This step is strongly recommended, even for development sites, because it makes install and maintenance much simpler.

The Reference Platform uses Daemontools to control AOLserver. A simpler method, using init, is here.

[root@yourserver src]# su - service0
[service0@yourserver service0]$ cd /web/service0
[service0@yourserver service0]$ cp /web/service0/packages/acs-core-docs/www/files/analog.cfg.txt etc/analog.cfg
[service0@yourserver service0]$ mkdir www/log
[service0@yourserver service0]$ cp -r /usr/share/analog-5.31/images www/log/
[service0@yourserver service0]$ 
su - service0
cd /web/service0
cp /web/service0/packages/acs-core-docs/www/files/analog.cfg.txt etc/analog.cfg
mkdir www/log
cp -r /usr/share/analog-5.31/images www/log/

Edit /web/service0/etc/analog.cfg and change the variable in HOSTNAME "[my organisation]" to reflect your website title. If you don't want the traffic log to be publicly visible, change OUTFILE /web/service0/www/log/traffic.html to use a private directory.

Run it.

[service0@yourserver service0]$ /usr/share/analog-5.31/analog -G -g/web/service0/etc/analog.cfg
/usr/share/analog-5.31/analog: analog version 5.31/Unix
/usr/share/analog-5.31/analog: Warning F: Failed to open DNS input file
  /home/service0/dnscache: ignoring it
  (For help on all errors and warnings, see docs/errors.html)
/usr/share/analog-5.31/analog: Warning R: Turning off empty Search Word Report
[service0@yourserver service0]$

Verify that it works by browing to http://yourserver.test:8000/log/traffic.html

Automate this by creating a file in /etc/cron.daily.

[service0@yourserver service0]$ exit
logout

[root@yourserver root]# emacs /etc/cron.daily/analog

Put this into the file:

#!/bin/sh

/usr/share/analog-5.31/analog -G -g/web/service0/etc/analog.cfg

[root@yourserver root]# chmod 755 /etc/cron.daily/analog

Test it by running the script.

[root@yourserver root]# sh /etc/cron.daily/analog

Browse to http://yourserver.test/log/traffic.html