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.22.2.10 -r1.22.2.11 --- openacs-4/packages/acs-core-docs/www/openacs.html 21 Jan 2004 18:36:16 -0000 1.22.2.10 +++ openacs-4/packages/acs-core-docs/www/openacs.html 29 Jan 2004 10:43:05 -0000 1.22.2.11 @@ -1,4 +1,4 @@ -Install OpenACS 5.0.0

Install OpenACS 5.0.0

by Vinod Kurup


+Install OpenACS

Install OpenACS

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 one or more OpenACS Sites

For Linux Standard Base compliance and ease of backup, @@ -35,9 +35,7 @@ can use database and server commands associated with that group.

 [root root]# useradd service0
-[root root]#

Install with automated script (EXPERIMENTAL)

Starting with OpenACS 5.0, an experimental script is - available to automate all of the steps for the rest of this - section. Requires tclwebtest. If you are not feeling lucky, skip to the section called “Install from tarball”.

Get the install script from CVS. It is located within +[root root]#

Install with automated script

A bash script is available to automate all of the steps for the rest of this section. It requires tclwebtest. The automated script can greatly accelerate the install process, but is very sensitive to the install environment. We recommend that you run the automated install and, if it does not work the first time, consider switching to a manual installation.

Get the install script from CVS. It is located within the main cvs tree, at /etc/install. Use anonymous CVS checkout to get that directory in the home directory of the service's dedicated user. We put it there so that it is not @@ -51,28 +49,28 @@ U install/tcl/twt-procs.tcl U install/tcl/user-procs.tcl [service0 service0]$ cd install -[service0 install]$ -

Edit - /home/service0/install/install.tcl - and change the values as documented in the file. It will work - unchanged at 127.0.0.1:8000.

Run the file as root.

[service0 service0]$ exit 
+[service0 install]$ emacs install.tcl
+

Edit the installation configuration file, /home/service0/install/install.tcl and update the site-specific values, such as the new service's IP address and name, which will be written into the new service's config.tcl file. If your system is different from the one described in the previous sections, check the file paths as well. Set do_checkout=yes to create a new OpenACS site directly from a CVS checkout, or =no if you have a fully configured site and just want to rebuild it (drop and recreate the database and repeat the installation). If you have followed a stock installation, the default configuration will work without changes and will install an OpenACS site at 127.0.0.1:8000.

Run the install script install.sh as root:

[service0 service0]$ exit 
 [root root]# sh /home/service0/install/install.sh
 /home/service0/install/install.sh: Starting installation with config_file 
 /home/service0/install/install.tcl. Using serverroot=/var/lib/aolserver/
 service0, server_url=http://0.0.0.0:8000, do_checkout=yes, do_install=yes, 
 dotlrn=no, and database=postgres., use_daemontools=true
-  ... many lines omitted ...
-./install.sh: Finished (re)installing /var/lib/aolserver/service0 at Wed Nov  
-5 13:27:17 CET 2003.  Access the new site at http://127.0.0.1:8000 with admin 
-username admin@yourserver.test and password 1
+  ... many lines omitted ...
+Tue Jan 27 11:50:59 CET 2004: Finished (re)installing /var/lib/aolserver/service0.
+######################################################################
+  New site URL: http://127.0.0.1:8000
+admin email   : admin@yourserver.net
+admin password: xxxx
+######################################################################
 [root root]#

You can proceed to the section called “Next Steps”.

Install from tarball

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

  1. 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 root]# su - service0
     [service0 service0]$ cd /var/lib/aolserver
    -[service0 aolserver]$ tar xzf /tmp/openacs-5.0.0.tgz
    -[service0 aolserver]$ mv openacs-5.0.0 service0
    +[service0 aolserver]$ tar xzf /tmp/.tgz
    +[service0 aolserver]$ mv  service0
     [service0 aolserver]$ chmod -R 700 service0
     [service0 aolserver]$ ls -al
     total 3
    @@ -84,8 +82,8 @@
     [root root]#
     
    su - service0
     cd /var/lib/aolserver
    -tar xzf /tmp/openacs-5.0.0.tgz
    -mv openacs-5.0.0 service0
    +tar xzf /tmp/.tgz
    +mv  service0
     chmod -R 700 service0/
     exit
  2. Add the Service to CVS (OPTIONAL)

  3. Prepare the database

    • Prepare Oracle for OpenACS.�If you won't be using Oracle, skip to Prepare PostgreSQL for an OpenACS Service

      You should be sure that your user account @@ -220,15 +218,15 @@ CREATE DATABASE [service0 service0]$

      su - service0
      -createdb -E UNICODE 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. Recommended: VACUUM ANALYZE every hour and VACUUM FULL ANALYZE every day.

      [service0 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-23 * * * /usr/local/pgsql/bin/vacuumdb --full --analyze service0
      +createdb -E UNICODE 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. Recommended: VACUUM ANALYZE every hour and VACUUM FULL ANALYZE every day.

      [service0 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-23 * * * /usr/local/pgsql/bin/vacuumdb --full --analyze service0
       0 0 * * * /usr/local/pgsql/bin/vacuumdb --full --analyze service0
    • Add Full Text Search Support (OPTIONAL)

    • At this point the database should be ready for installing OpenACS.

  • 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, /var/lib/aolserver/service0/etc/config.tcl. - Open it in an editor to adjust the parameters.

      [root root]# su - service0
      +	   Open it in an editor to adjust the parameters.

      [root root]# su - service0
       [service0 service0]$ cd /var/lib/aolserver/service0/etc
       [service0 etc]$ emacs config.tcl
       

      @@ -289,11 +287,11 @@ permissions errors or missing files. If you need to make changes, don't forget to kill any running servers with killall nsd. -

    2. Automate +

    3. 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. + .

    • You should see a page from the webserver titled OpenACS Installation: @@ -343,20 +341,20 @@ You'll see the final Installer page, "OpenACS Installation: Complete." It will tell you that the server is being restarted; note that unless you already set up a way for - AOLserver to restart itself (ie. inittab or daemontools), + AOLserver to restart itself (ie. inittab or daemontools), you'll need to manually restart your service.

      [service0 service0]$ /usr/local/aolserver/bin/nsd-postgres -t /var/lib/aolserver/service0/config.tcl
    • 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! -

  • Next Steps

    • Install Full Text Search (OPTIONAL). If you have installed OpenFTS and enabled + is now up and running! +

    Next Steps

    • Use daemontools supervice and svc, or inittab, to automate server startup and shutdown.

    • 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.

    • 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.

    • Set up database environment variables for the site + packages. (more information)

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

    • Set up database environment variables for the site user. These settings are necessary for working with the database while logged in as the service user. They do not directly affect the service's run-time connection with the