Index: openacs-4/packages/acs-core-docs/www/openacs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.html,v diff -u -r1.8 -r1.9 --- openacs-4/packages/acs-core-docs/www/openacs.html 24 Jun 2003 03:58:11 -0000 1.8 +++ openacs-4/packages/acs-core-docs/www/openacs.html 28 Jun 2003 05:07:02 -0000 1.9 @@ -1,9 +1,9 @@ -Install OpenACS 5.0.0

Install OpenACS 5.0.0

+Install OpenACS 4.7.0d

Install OpenACS 4.7.0d

by Vinod Kurup
OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Set up the file system for an OpenACS Service

  1. The reference install stores all OpenACS services in +

Set up the file system for an OpenACS Service

  1. 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
    @@ -31,15 +31,15 @@
           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 5.0.0-P and 5.0.0-O Reference Platform, + community.

    For the 4.7.0d-P and 4.7.0d-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]# useradd -g web service0 -d /home/service0
     [root@yourserver root]#

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

    [root@yourserver root]# su - service0
    @@ -70,10 +70,10 @@
     ORA_NLS33=$ORACLE_HOME/ocommon/nls/admin/data
    [service0@yourserver service0]$ exit
     logout
     
    -[root@yourserver root]#
  2. 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
    +[root@yourserver root]#
  3. 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-5.0.0.tgz
    -[service0@yourserver web]$ mv openacs-5.0.0 service0
    +[service0@yourserver web]$ tar xzf /tmp/openacs-4.7.0d.tgz
    +[service0@yourserver web]$ mv openacs-4.7.0d service0
     [service0@yourserver web]$ chmod -R 700 service0
     [service0@yourserver web]$ ls -al
     total 3
    @@ -86,10 +86,11 @@
     [root@yourserver root]#
     
    su - service0
     cd /web
    -tar xzf /tmp/openacs-5.0.0.tgz
    -mv openacs-5.0.0 service0
    +tar xzf /tmp/openacs-4.7.0d.tgz
    +mv openacs-4.7.0d service0
     chmod -R 700 service0/
    -exit
  4. Add the Service to CVS (OPTIONAL)

  5. Set up several additional directories in the service root: +exit

  6. Add the Service to CVS (OPTIONAL)

  7. (This step should be obsoleted by the 5.0.0 tarball, as + these directories will be included in the tarball)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
    @@ -98,7 +99,7 @@
     [root@yourserver web]#
     
    su - service0
     mkdir /web/service0/etc /web/service0/log /web/service0/database-backup
    -exit

Prepare Oracle for OpenACS

If you won't be using Oracle, skip to Prepare PostgreSQL for OpenACS

+exit

Prepare Oracle for OpenACS

If you won't be using Oracle, skip to the section called “Prepare PostgreSQL for an OpenACS Service”

You should be sure that your user account (e.g. service0) is in the dba group. @@ -232,32 +233,34 @@ 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” -

Prepare PostgreSQL for an OpenACS Service

  1. Create a user in the database matching the service name.

    [root@yourserver root]# su - postgres
    +		  

Prepare PostgreSQL for an OpenACS Service

  1. 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]#
  2. Create a database with the same name as our service name, service0.

    [root@yourserver root]# su - service0
    +[root@yourserver root]#
  3. 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
  4. 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 --analyze service0
  5. Add Full Text Search Support (OPTIONAL)

  6. [service0@yourserver service0]$ exit
    +createdb service0
  7. 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 --analyze service0
  8. Add Full Text Search Support (OPTIONAL)

  9. [service0@yourserver service0]$ exit
     logout
     
    -[root@yourserver root]# 

Configure an AOLserver Service for OpenACS

  1. +[root@yourserver root]#

Configure an AOLserver Service for OpenACS

  1. 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
    +	  need to configure a virtual server.  The Reference Platform
    +	  uses a configuration file included in the OpenACS tarball,
    +	  /web/service0/etc/config.tcl.
    +	   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. + 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.

    • httpport - If you want your server on a different port, enter it here. The Reference Platform port is 8000, which is suitable for development use. Port 80 is the standard http port - it's the port used by your browser when you enter http://yourserver.test. So you should use port 80 for your production site.

    • httpsport - This is the port for https requests. The Reference Platform https port is @@ -275,10 +278,10 @@ will both own OpenACS files and connect to the database (for Postgresql).

    • debug - Set to true for a very verbose error log, including many lines for every page view, success or failure.

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

  3. Enable OpenFTS Full Text Search (OPTIONAL)

  4. Install nsopenssl - for SSL support. (OPTIONAL)

Verify AOLserver startup

  1. + for SSL support. (OPTIONAL)

Verify AOLserver startup

  1. Kill any current running AOLserver processes and start a new one. If you are using Oracle, rather than PostgreSQL, replace nsd-postgres with @@ -298,7 +301,7 @@ 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.

  2. +[08/Mar/2003:18:13:29][32131.8192][-main-] Notice: nsd.tcl: finished reading config file.

  3. Attempt to connect to the service from a web browser. You should specify a URL like:

    http://yourserver.test:8000

    You should see a page that looks like this. If you imported your files into @@ -318,7 +321,7 @@

  4. Automate AOLserver keepalive (OPTIONAL)

Configure a Service with the OpenACS Installer

Now that you've got AOLserver up and running, let's install OpenACS - 5.0.0. + 4.7.0d.

  • You should see a page from the webserver titled OpenACS Installation: @@ -374,11 +377,11 @@ Give the server a few minutes to start up. Then reload the final page above. You should see the front page, with an area to login near the upper right. Congratulations, OpenACS - 5.0.0 is now up and running! + 4.7.0d is now up and running!

  • Install Full Text Search (OPTIONAL). If you have installed OpenFTS and enabled OpenFTS, you can now install the OpenFTS Driver package and - Full Text Search Engine package in the OpenACS service.

Next Steps

  • This is a good time to make a backup of your service. If this is a - production site, you should set up automatic nightly backups.

  • If you want traffic reports, set up analog or another log + Full Text Search Engine package in the OpenACS service.

Next Steps

  • This is a good time to make a backup of your service. If this is a + production site, you should set up automatic nightly backups.

  • If you want traffic reports, set up analog or another log processing program.

  • Follow the instruction on the home page to change the appearance of your service or add more - packages. (more information)

  • Proceed to the tutorial to learn how to develop your own packages.

  • Test your backup and recovery procedure.

($Id$)
View comments on this page at openacs.org
+ packages. (more information)

  • Proceed to the tutorial to learn how to develop your own packages.

  • Test your backup and recovery procedure.

  • ($Id$)
    View comments on this page at openacs.org