| Prev | Next |
Tutorials and reference material for creating new OpenACS packages. +
Tutorials and reference material for creating new OpenACS packages.
Table of Contents
Table of Contents
Table of Contents
Download the Analog source tarball in +
Download the Analog source tarball in /tmp. Unpack, compile, and install analog.
[root aolserver]# cd /usr/local/src [root src]# tar xzf /tmp/analog-5.32.tar.gz [root src]# cd analog-5.32 Index: openacs-4/packages/acs-core-docs/www/aolserver.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/aolserver.html,v diff -u -r1.23.2.4 -r1.23.2.5 --- openacs-4/packages/acs-core-docs/www/aolserver.html 15 Dec 2003 15:03:46 -0000 1.23.2.4 +++ openacs-4/packages/acs-core-docs/www/aolserver.html 16 Dec 2003 13:58:40 -0000 1.23.2.5 @@ -1,4 +1,4 @@ -Install AOLserver 3.3oacs1 by Vinod Kurup
+Install AOLserver 3.3oacs1
Unpack the Aolserver tarball.�Download the aolserver tarball and unpack it.
[root root]# cd /usr/local/src Index: openacs-4/packages/acs-core-docs/www/apm-design.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/apm-design.html,v diff -u -r1.21.2.4 -r1.21.2.5 --- openacs-4/packages/acs-core-docs/www/apm-design.html 15 Dec 2003 15:03:46 -0000 1.21.2.4 +++ openacs-4/packages/acs-core-docs/www/apm-design.html 16 Dec 2003 13:58:40 -0000 1.21.2.5 @@ -1,10 +1,10 @@ -Package Manager Design By Bryan Quinn
+Package Manager Design
Tcl API
-apm-install-procs.tcl (Supports installation of packages)
-20-apm-load-procs.tcl (Bootstraps APM for server startup)
Tcl API
+apm-install-procs.tcl (Supports installation of packages)
+20-apm-load-procs.tcl (Bootstraps APM for server startup)
apm-admin-procs.tcl (Supports APM UI)
PL/SQL file
In general terms, a package is a unit of software that serves a single well-defined purpose. That purpose may be to provide a Index: openacs-4/packages/acs-core-docs/www/apm-requirements.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/apm-requirements.html,v diff -u -r1.16.2.2 -r1.16.2.3 --- openacs-4/packages/acs-core-docs/www/apm-requirements.html 8 Dec 2003 15:41:16 -0000 1.16.2.2 +++ openacs-4/packages/acs-core-docs/www/apm-requirements.html 16 Dec 2003 13:58:40 -0000 1.16.2.3 @@ -1,4 +1,4 @@ -
Package Manager Requirements By Bryan Quinn and Todd Nightingale
+Package Manager Requirements The following is a requirements document for the OpenACS Package Manager Index: openacs-4/packages/acs-core-docs/www/automated-testing-best-practices.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/automated-testing-best-practices.html,v diff -u -r1.1.2.4 -r1.1.2.5 --- openacs-4/packages/acs-core-docs/www/automated-testing-best-practices.html 15 Dec 2003 15:03:46 -0000 1.1.2.4 +++ openacs-4/packages/acs-core-docs/www/automated-testing-best-practices.html 16 Dec 2003 13:58:40 -0000 1.1.2.5 @@ -1,4 +1,4 @@ -
Automated Testing By Jeff Davis
+Automated Testing Best practices in writing OpenACS automated tests
Special characters in Tcl.� Index: openacs-4/packages/acs-core-docs/www/backup-recovery.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/backup-recovery.html,v diff -u -r1.15.2.5 -r1.15.2.6 --- openacs-4/packages/acs-core-docs/www/backup-recovery.html 15 Dec 2003 15:03:46 -0000 1.15.2.5 +++ openacs-4/packages/acs-core-docs/www/backup-recovery.html 16 Dec 2003 13:58:40 -0000 1.15.2.6 @@ -1,8 +1,13 @@ -
Backup and Recovery By Don Baccus with additions +
Backup and Recovery We will cover some basic backup and recovery strategies. These are intended to + be robust but simple enough to set up. For a large scale production site you would + probably need to create your own backup strategies (in particular full dumps from + oracle, while easy to set up, are far from the best solution). +
There are three basic things which need to be backed up, the database data, the server + source tree, and the acs-content-repository (which is in the server source tree).
The purpose of backup is to enable recovery. Backup and recovery are always risky; here are some steps that minimize the chance recovery is necessary: @@ -31,177 +36,170 @@ OpenACS installations comprise files and database contents. If you follow the reference install and put all files, including configuration files, in - /var/lib/aolserver/service0/, + /var/lib/aolserver/service0/, and back up the database nightly to a file in - /var/lib/aolserver/service0/database-backup, + /var/lib/aolserver/service0/database-backup, then you can apply standard file-based backup strategies to - /var/lib/aolserver/service0 + /var/lib/aolserver/service0
This section describes how to make a one-time backup and - restore of the files and database. This is useful for rolling back to - known-good versions of a service, such as at initial + restore of the files and database. This is useful for rolling + back to known-good versions of a service, such as at initial installation and just before an upgrade. First, you back up the database to a file within the file tree. Then, you back up the file tree. All of the information needed to rebuild the site, - including the AOLserver config files, is then in tree for - regular file system backup.
Back up the database to a file.�
Oracle.�
+ including the AOLserver config files, is then in tree for regular + file system backup.
Back up the database to a file.�
Download the backup script. Save the file export-oracle.txt as - /tmp/export-oracle.txt + /tmp/export-oracle.txt
Login as root. The following commands will install the export script: -
- [joeuser ~]$ su - - Password: *********** - [root ~]# cp /tmp/export-oracle.txt /usr/sbin/export-oracle - [root ~]# chmod 700 /usr/sbin/export-oracle+
[joeuser ~]$ su - +[root ~]# cp /tmp/export-oracle.txt /usr/sbin/export-oracle +[root ~]# chmod 700 /usr/sbin/export-oracleSetup the export directory; this is the directory where backups will be stored. We recommend the directory - /ora8/m02/oracle-exports.
- [root ~]# mkdir /ora8/m02/oracle-exports - [root ~]# chown oracle.dba /ora8/m02/oracle-exports - [root ~]# chmod 770 /ora8/m02/oracle-exports+ /ora8/m02/oracle-exports.
[root ~]# mkdir /ora8/m02/oracle-exports +[root ~]# chown oracle:dba /ora8/m02/oracle-exports +[root ~]# chmod 770 /ora8/m02/oracle-exportsNow edit - /usr/sbin/export-oracle and + /usr/sbin/export-oracle and change the SERVICE_NAME and DATABASE_PASSWORD fields to their correct values. If you want to use a directory other than - /ora8/m02/oracle-exports, you + /ora8/m02/oracle-exports, you also need to change the exportdir setting.
Test the export procedure by running the command: -
- [root ~]# /usr/sbin/export-oracle - mv: /ora8/m02/oracle-exports/oraexport-service_name.dmp.gz: No such file or directory +[root ~]# /usr/sbin/export-oracle +mv: /ora8/m02/oracle-exports/oraexport-service_name.dmp.gz: No such file or directory - Export: Release 8.1.6.1.0 - Production on Sun Jun 11 18:07:45 2000 +Export: Release 8.1.6.1.0 - Production on Sun Jun 11 18:07:45 2000 - (c) Copyright 1999 Oracle Corporation. All rights reserved. +(c) Copyright 1999 Oracle Corporation. All rights reserved. - - Connected to: Oracle8i Enterprise Edition Release 8.1.6.1.0 - Production - With the Partitioning option - JServer Release 8.1.6.0.0 - Production - Export done in US7ASCII character set and US7ASCII NCHAR character set - . exporting pre-schema procedural objects and actions - . exporting foreign function library names for user SERVICE_NAME - . exporting object type definitions for user SERVICE_NAME - About to export SERVICE_NAME's objects ... - . exporting database links - . exporting sequence numbers - . exporting cluster definitions - . about to export SERVICE_NAME's tables via Conventional Path ... - . exporting synonyms - . exporting views - . exporting stored procedures - . exporting operators - . exporting referential integrity constraints - . exporting triggers - . exporting indextypes - . exporting bitmap, functional and extensible indexes - . exporting posttables actions - . exporting snapshots - . exporting snapshot logs - . exporting job queues - . exporting refresh groups and children - . exporting dimensions - . exporting post-schema procedural objects and actions - . exporting statistics - Export terminated successfully without warnings.PostgreSQL.�Create a backup file and verify that it was created and has a reasonable size (several megabytes).
[root root]# su - service0 - [service0 service0]$ pg_dump -f /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp service0 - [service0 service0]$ ls -al /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp - -rw-rw-r-x 1 service0 service0 4005995 Feb 21 18:28 /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp - [service0 service0]$ exit - [root root]# - su - service0 - pg_dump -f /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp openacs-dev - ls -al /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp - exitBack up the file system.�Back up all of the files in the service, including the +Connected to: Oracle8i Enterprise Edition Release 8.1.6.1.0 - Production +With the Partitioning option +JServer Release 8.1.6.0.0 - Production +Export done in US7ASCII character set and US7ASCII NCHAR character set + . exporting pre-schema procedural objects and actions + . exporting foreign function library names for user SERVICE_NAME + . exporting object type definitions for user SERVICE_NAME + About to export SERVICE_NAME's objects ... + . exporting database links + . exporting sequence numbers + . exporting cluster definitions + . about to export SERVICE_NAME's tables via Conventional Path ... + . exporting synonyms + . exporting views + . exporting stored procedures + . exporting operators + . exporting referential integrity constraints + . exporting triggers + . exporting indextypes + . exporting bitmap, functional and extensible indexes + . exporting posttables actions + . exporting snapshots + . exporting snapshot logs + . exporting job queues + . exporting refresh groups and children + . exporting dimensions + . exporting post-schema procedural objects and actions + . exporting statistics +Export terminated successfully without warnings.
PostgreSQL.�Create a backup file and verify that it was created and has a reasonable size (several megabytes).
[root root]# su - service0 +[service0 service0]$ pg_dump -f /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp service0 +[service0 service0]$ ls -al /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp +-rw-rw-r-x 1 service0 service0 4005995 Feb 21 18:28 /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp +[service0 service0]$ exit +[root root]# +su - service0 +pg_dump -f /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp openacs-dev +ls -al /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp +exitBack up the file system.�Back up all of the files in the service, including the database backup file but excluding the auto-generated - supervise directory, which is + supervise directory, which is unneccesary and has complicated permissions.
In the tar command,
c create a - new tar archive
p preserves permissions.
s preserves file sort order
j compresses the output with bz2.
The --exclude clauses skips some daemontools files that + new tar archive
p preserves permissions.
s preserves file sort order
z compresses the output with gzip.
The --exclude clauses skips some daemontools files that are owned by root and thus cannot be backed up by the service owner. These files are autogenerated and we don't break anything by omitting them.
The --file clause specifies the name of the output file to be generated; we manually add the correct extensions.
The last clause, - /var/lib/aolserver/service0/, + /var/lib/aolserver/service0/, specifies the starting point for backup. Tar defaults to recursive backup.
[root root]# su - service0 - [service0 service0]$ tar -cpsj --exclude /var/lib/aolserver/service0/etc/daemontools/supervise --file /tmp/service0-backup.tar.bz2 /var/lib/aolserver/service0/ - tar: Removing leading `/' from member names - [service0 service0]$Suffer a catastrophic failure on your production system.�(We'll simulate this step)
[root root]# svc -d /service/service0 - [root root]# mv /var/lib/aolserver/service0/ /var/lib/aolserver/service0.lost - [root root]# rm /service/service0 - rm: remove symbolic link `/service/service0'? y - [root root]# ps -auxw | grep service0 - root 1496 0.0 0.0 1312 252 ? S 16:58 0:00 supervise service0 - [root root]# kill 1496 - [root root]# ps -auxw | grep service0 - [root root]# su - postgres - [postgres pgsql]$ dropdb service0 - DROP DATABASE - [postgres pgsql]$ dropuser service0 - DROP USER - [postgres pgsql]$ exit - logout - [root root]#
Restore the operating system and required software. +[service0 service0]$ tar -cpsz --exclude /var/lib/aolserver/service0/etc/daemontools/supervise \ + --file /tmp/service0-backup.tar.gz /var/lib/aolserver/service0/ +tar: Removing leading `/' from member names +[service0 service0]$
Suffer a catastrophic failure on your production system.�(We'll simulate this step)
[root root]# svc -d /service/service0 +[root root]# mv /var/lib/aolserver/service0/ /var/lib/aolserver/service0.lost +[root root]# rm /service/service0 +rm: remove symbolic link `/service/service0'? y +[root root]# ps -auxw | grep service0 +root 1496 0.0 0.0 1312 252 ? S 16:58 0:00 supervise service0 +[root root]# kill 1496 +[root root]# ps -auxw | grep service0 +[root root]# su - postgres +[postgres pgsql]$ dropdb service0 +DROP DATABASE +[postgres pgsql]$ dropuser service0 +DROP USER +[postgres pgsql]$ exit +logout +[root root]#
Restore the operating system and required software. You can do this with standard backup processes or by keeping copies of the install material (OS CDs, OpenACS tarball and supporting software) and repeating the install guide. Recreate the service user (service0).
Restore the OpenACS files and database backup file.
[root root]# su - service0 - [service0 service0]$ cd /var/lib/aolserver - [service0 aolserver]$ tar xjf /tmp/service0-backup.tar.bz2 - [service0 aolserver]$ chmod -R 775 service0 - [service0 aolserver]$ chown -R service0.web service0 - -Restore the database
Oracle.�
Set up a clean Oracle database user and - tablespace with the same names as the ones exported from (more information).
Invoke the import command
imp service0/service0 FILE=/var/lib/aolserver/service0/database-backup/nighty_backup.dmp FULL=YPostgres.�
Because of a bug in Postgres backup-recovery, database objects are not guaranteed to be created in the right order. To compensate, we pre-creating some critical items first, which leads to some harmless errors.
[root root]# su - postgres - [postgres 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 - [service0 web]$ createdb service0 - CREATE DATABASE - [service0 web]$ psql -f /var/lib/aolserver/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 - (many lines omitted) - [service0 web]$ psql service0 < /var/lib/aolserver/service0/database-backup/database-backup.dmp - (many lines omitted) - [service0 web]$ exit - [postgres pgsql]$ exit - logout -Activate the service
[root root]# ln -s /var/lib/aolserver/service0/etc/daemontools /service/service0 - [root root]# sleep 10 - [root root]# svgroup web /service/service0 - [root root]#The recommended backup strategy for a production sit is to use an automated script which first backs up the database to a file in /var/lib/aolserver/service0/database-backup and then backs up all of /var/lib/aolserver/service0 to a single zip file, and then copies that zip file to another computer.
Make sure that the manual backup process described above works.
Customize the default backup script. Edit /var/lib/aolserver/service0/etc/backup.sh with your specific parameters.
+[service0 service0]$ cd /var/lib/aolserver +[service0 aolserver]$ tar xzf /tmp/service0-backup.tar.gz +[service0 aolserver]$ chmod -R 775 service0 +[service0 aolserver]$ chown -R service0.web service0
Restore the database
Oracle.�
Set up a clean Oracle database user and + tablespace with the same names as the ones exported from (more information).
Invoke the import command
imp service0/service0 FILE=/var/lib/aolserver/service0/database-backup/nighty_backup.dmp FULL=YPostgres.�Because of a bug in Postgres backup-recovery, database objects are not guaranteed to be created in the right order. To compensate, we pre-creating some critical items first, which leads to some harmless errors.
[root root]# su - postgres +[postgres ~]$ 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 ~]$ su - service0 +[service0 ~]$ createdb service0 +CREATE DATABASE +[service0 ~]$ psql -f /var/lib/aolserver/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 +(many lines omitted) +[service0 ~]$ psql service0 < /var/lib/aolserver/service0/database-backup/database-backup.dmp +(many lines omitted) +[service0 ~]$ exit +[postgres ~]$ exit +logoutActivate the service
[root root]# ln -s /var/lib/aolserver/service0/etc/daemontools /service/service0 +[root root]# sleep 10 +[root root]# svgroup web /service/service0The recommended backup strategy for a production sit is to use an automated script which first backs up the database to a file in /var/lib/aolserver/service0/database-backup and then backs up all of /var/lib/aolserver/service0 to a single zip file, and then copies that zip file to another computer.
Make sure that the manual backup process described above works.
Customize the default backup script. Edit /var/lib/aolserver/service0/etc/backup.sh with your specific parameters.
Make sure the file is executable:
chmod +x backup.shSet this file to run automatically by adding a line to root's crontab. (Typically, with export EDITOR=emacs; crontab -e.) This example runs the backup script at 1:30 am every day.
30 1 * * * * sh /var/lib/aolserver/service0/etc/backup.shCVS-only backup is often appropriate for development sites. If you are already using CVS and your data is not important, you probably don't - need to do anything to back up your files. Just make - sure that your current work is checked into the system. - You can then roll back based on date - note the - current system time, down to the minute. For maximum - safety, you can apply a tag to your current - files. You will still need to back up your database.
Note that, if you did the CVS options in this document, the /var/lib/aolserver/service0/etc directory is not included in cvs and you may want to add it.
[root root]# su - service0 - [service0 service0]$ cd /var/lib/aolserver/service0 - [service0 service0]$ cvs commit -m "last-minute commits before upgrade to 4.6" - cvs commit: Examining . - cvs commit: Examining bin - (many lines omitted) - [service0 service0]$ cvs tag before_upgrade_to_4_6 - cvs server: Tagging bin - T bin/acs-4-0-publish.sh - T bin/ad-context-server.pl - (many lines omitted) - [service0 service0]$ exit - [root root]# - su - service0 - cd /var/lib/aolserver/service0 - cvs commit -m "last-minute commits before upgrade to 4.6" - cvs tag before_upgrade_to_4_6 - exitTo restore files from a cvs tag such as the one used above:
[root root]# su - service0 - [service0 service0]$ cd /var/lib/aolserver/service0 - [service0 service0]$ cvs up -r current - [service0 service0]$ exit - su - service0 - cd /var/lib/aolserver/service0 - cvs up -r current($Id$)View comments on this page at openacs.org + need to do anything to back up your files. Just make + sure that your current work is checked into the system. + You can then roll back based on date - note the + current system time, down to the minute. For maximum + safety, you can apply a tag to your current + files. You will still need to back up your database.Note that, if you did the CVS options in this document, the /var/lib/aolserver/service0/etc directory is not included in cvs and you may want to add it.
[root root]# su - service0 +[service0 service0]$ cd /var/lib/aolserver/service0 +[service0 service0]$ cvs commit -m "last-minute commits before upgrade to 4.6" +cvs commit: Examining . +cvs commit: Examining bin +(many lines omitted) +[service0 service0]$ cvs tag before_upgrade_to_4_6 +cvs server: Tagging bin +T bin/acs-4-0-publish.sh +T bin/ad-context-server.pl +(many lines omitted) +[service0 service0]$ exit +[root root]# +su - service0 +cd /var/lib/aolserver/service0 +cvs commit -m "last-minute commits before upgrade to 4.6" +cvs tag before_upgrade_to_4_6 +exitTo restore files from a cvs tag such as the one used above:
[root root]# su - service0 +[service0 service0]$ cd /var/lib/aolserver/service0 +[service0 service0]$ cvs up -r current +[service0 service0]$ exit +su - service0 +cd /var/lib/aolserver/service0 +cvs up -r current($Id$)View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/bootstrap-acs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/bootstrap-acs.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/bootstrap-acs.html 15 Dec 2003 15:03:46 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/bootstrap-acs.html 16 Dec 2003 13:58:40 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -Bootstrapping OpenACS By Jon Salz
+Bootstrapping OpenACS
Tcl code: /tcl/0-acs-init.tcl and /packages/acs-kernel/bootstrap.tcl
This document describes the startup (bootstrapping) process for an AOLserver Index: openacs-4/packages/acs-core-docs/www/complete-install.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/complete-install.html,v diff -u -r1.4.2.3 -r1.4.2.4 --- openacs-4/packages/acs-core-docs/www/complete-install.html 15 Dec 2003 15:03:46 -0000 1.4.2.3 +++ openacs-4/packages/acs-core-docs/www/complete-install.html 16 Dec 2003 13:58:40 -0000 1.4.2.4 @@ -1 +1 @@ -
Chapter�3.�Complete Installation View comments on this page at openacs.org +Chapter�3.�Complete Installation View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/configure.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/Attic/configure.html,v diff -u -r1.6.2.2 -r1.6.2.3 --- openacs-4/packages/acs-core-docs/www/configure.html 8 Dec 2003 15:41:16 -0000 1.6.2.2 +++ openacs-4/packages/acs-core-docs/www/configure.html 16 Dec 2003 13:58:40 -0000 1.6.2.3 @@ -1 +1 @@ -Chapter�4.�Configuring a New Service View comments on this page at openacs.org +Chapter�4.�Configuring a New Service View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/credits.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/credits.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/credits.html 15 Dec 2003 15:03:46 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/credits.html 16 Dec 2003 13:58:40 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -Appendix�C.�Credits Table of Contents
By Vinod Kurup
+Appendix�C.�Credits Table of Contents
Vinod Kurup put Index: openacs-4/packages/acs-core-docs/www/cvs-tips.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-tips.html,v diff -u -r1.6.2.3 -r1.6.2.4 --- openacs-4/packages/acs-core-docs/www/cvs-tips.html 15 Dec 2003 15:03:46 -0000 1.6.2.3 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.html 16 Dec 2003 13:58:40 -0000 1.6.2.4 @@ -1,11 +1,9 @@ -
Appendix�D.�Using CVS with an OpenACS Site +Appendix�D.�Using CVS with an OpenACS Site Add the Service to CVS - OPTIONAL.�These steps take an existing OpenACS directory and add it to a CVS - repository. -
Create and set permissions on a subdirectory in the local cvs repository.
[root root]# mkdir /cvsroot/service0 + repository.
Create and set permissions on a subdirectory in the local cvs repository.
[root root]# mkdir /cvsroot/service0 [root root]# chown service0.web /cvsroot/service0 [root root]# mkdir /cvsroot/service0 Index: openacs-4/packages/acs-core-docs/www/database-management.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/database-management.html,v diff -u -r1.14.2.4 -r1.14.2.5 --- openacs-4/packages/acs-core-docs/www/database-management.html 15 Dec 2003 15:03:46 -0000 1.14.2.4 +++ openacs-4/packages/acs-core-docs/www/database-management.html 16 Dec 2003 13:58:40 -0000 1.14.2.5 @@ -1,4 +1,4 @@ -Database Management +Database Management To run a database on a different machine than the @@ -10,25 +10,21 @@ permit specific remote clients to access. Access can be controlled ... (add notes from forum post)
Change the OpenACS service's configuration file to point to the remote database. Edit - /web/service0/etc/config.tcl + /var/lib/aolserver/service0/etc/config.tcl and change
to
Skip down for instructions on Deleting a PostgreSQL tablespace.
Should it become necessary to rebuild a tablespace from scratch, you can use the drop user command in SVRMGRL with the cascade option. This command will drop the user and every database object - the user owns.
-SVRMGR> drop user service0 cascade;+ the user owns.
SVRMGR> drop user service0 cascade;If this does not work because svrmgrl "cannot drop a user that is currently connected", make sure to kill the AOLserver using - this user. If it still does not work, do:
-SVRMGR> select username, sid, serial# from v$session where lower(username)='service0';and then
-SVRMGR> alter system kill session 'sid,serial#';+ this user. If it still does not work, do:
SVRMGR> select username, sid, serial# from v$session where lower(username)='service0';and then
SVRMGR> alter system kill session 'sid, serial#';where sid and serial# are replaced with the corresponding values for the open session.
Use with caution!
If you feel the need to delete everything - related to the service, you can also issue the following:
-SVRMGR> drop tablespace service0 including contents cascade constraints;+ related to the service, you can also issue the following:
SVRMGR> drop tablespace service0 including contents cascade constraints;Dropping a PostgreSQL tablespace is easy. You have to stop any AOLserver instances that are using the database that you wish to drop. If you're using daemontools, this is simple, just use the @@ -37,7 +33,7 @@ reread the inittab with /sbin/init q, and then restart-aolserver service0.
Then, to drop the db, just do:
-[service0 ~]$ dropdb service0 +[service0 ~]$ dropdb service0 DROP DATABASEThe "vacuum" command must be run periodically to reclaim space. The "vacuum analyze" form additionally collects statistics on the @@ -51,7 +47,6 @@ backup! The "vacuum" command is very reliable, but conservatism is the key to good system management. So, if you're using the export procedure described above, you don't need to do this extra step. -
Edit your crontab:
-[joeuser ~]$ crontab -eWe'll set vacuum up to run nightly at 1 AM. Add the following +
Edit your crontab:
[joeuser ~]$ crontab -eWe'll set vacuum up to run nightly at 1 AM. Add the following line:
-0 1 * * * /usr/local/pgsql/bin/vacuumdb birdnotes($Id$)View comments on this page at openacs.org +0 1 * * * /usr/local/pgsql/bin/vacuumdb service0($Id$)View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/db-api-detailed.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/db-api-detailed.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/db-api-detailed.html 15 Dec 2003 15:03:46 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/db-api-detailed.html 16 Dec 2003 13:58:40 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -Database Access API By Jon Salz. Revised and expanded by Roberto Mello (rmello at fslc dot usu dot edu), July 2002.
+Database Access API
Tcl procedures: /packages/acs-kernel/10-database-procs.tcl
Tcl initialization: /packages/acs-kernel/database-init.tcl
Index: openacs-4/packages/acs-core-docs/www/db-api.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/db-api.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/db-api.html 15 Dec 2003 15:03:47 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/db-api.html 16 Dec 2003 13:58:41 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -
The OpenACS Database Access API +
The OpenACS Database Access API By Pete Su and Jon Salz. Modified by Roberto Mello.
One of OpenACS's great strengths is that code written for it is Index: openacs-4/packages/acs-core-docs/www/dev-guide.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/dev-guide.html,v diff -u -r1.17.2.2 -r1.17.2.3 --- openacs-4/packages/acs-core-docs/www/dev-guide.html 8 Dec 2003 15:41:16 -0000 1.17.2.2 +++ openacs-4/packages/acs-core-docs/www/dev-guide.html 16 Dec 2003 13:58:41 -0000 1.17.2.3 @@ -1 +1 @@ -
Chapter�8.�Development Reference Table of Contents
- OpenACS Packages
- OpenACS Data Models and the Object System
- The Request Processor
- The OpenACS Database Access API
- Using Templates in OpenACS
- Groups, Context, Permissions
- Writing OpenACS Application Pages
- Parties in OpenACS
- OpenACS Permissions Tediously Explained
- Object Identity
- Programming with AOLserver
- Using HTML Forms
View comments on this page at openacs.org +Chapter�8.�Development Reference Table of Contents
- OpenACS Packages
- OpenACS Data Models and the Object System
- The Request Processor
- The OpenACS Database Access API
- Using Templates in OpenACS
- Groups, Context, Permissions
- Writing OpenACS Application Pages
- Parties in OpenACS
- OpenACS Permissions Tediously Explained
- Object Identity
- Programming with AOLserver
- Using HTML Forms
View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/doc-standards.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/doc-standards.html,v diff -u -r1.1.2.2 -r1.1.2.3 --- openacs-4/packages/acs-core-docs/www/doc-standards.html 8 Dec 2003 15:41:16 -0000 1.1.2.2 +++ openacs-4/packages/acs-core-docs/www/doc-standards.html 16 Dec 2003 13:58:41 -0000 1.1.2.3 @@ -1 +1 @@ -Chapter�10.�Documentation Standards View comments on this page at openacs.org +Chapter�10.�Documentation Standards View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/docbook-primer.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.html,v diff -u -r1.23.2.4 -r1.23.2.5 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 15 Dec 2003 15:03:47 -0000 1.23.2.4 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 16 Dec 2003 13:58:41 -0000 1.23.2.5 @@ -1,4 +1,4 @@ -OpenACS Documentation Guide +
OpenACS Documentation Guide By Claus Rasmussen, with additions by Roberto Mello and the OpenACS Community
@@ -36,7 +36,7 @@ In order to separate content and presentation, all OpenACS documentation will be marked up to conform to the DocBook XML DTD - + This enables us to publish in a variety of formats and relieves each contributor of the burden of presentation, freeing him to focus on content and sharing knowledge. @@ -57,7 +57,7 @@ list of elements and use more exotic features in your documents. The list is made up of SGML-elements but basically the same elements are valid in the XML DTD as long as you remember to: - +
Always close your tags with corresponding end-tags and to not use other tag minimization @@ -106,7 +106,7 @@ The documentation for each package will make up a little "book" that is structured like this - examples are emphasized: - +
book : Docs for one package - templating @@ -130,20 +130,20 @@ sources of these DocBook documents to get an idea of how they are tied together.- + Given that your job starts at the sect1-level, all your documents should open with a <sect1>-tag and end with the corresponding </sect1>.
- + You need to feed every <sect1> two attributes. The first attribute, id, is standard and can be used with all elements. It comes in very handy when interlinking between documents (more about this when talking about links in the section called “Links”). The value of id has to be unique throughout the book you're making since the id's in your sect1's will turn into filenames when the book is parsed into HTML.
- + The other attribute is xreflabel. The value of this is the text that will appear as the link when referring to this sect1.
@@ -158,7 +158,7 @@ </sect1>
- + Inside this container your document will be split up into <sect2>'s, each with the same requirements - id and xreflabel @@ -167,7 +167,7 @@ When it comes to naming your sect2's and below, prefix them with some abbreviation of the id in the sect1 such as requirements-overview.
- + For displaying a snippet of code, a filename or anything else you just want to appear as a part of a sentence, we will use the tag <computeroutput>. @@ -177,12 +177,12 @@ <programlisting> is used. Just wrap your code block in it; mono-spacing, indents and all that stuff is taken care of automatically.
- + Linking falls into two different categories: inside the book you're making and outside:
- 1. Inside linking, cross-referencing other parts of your book
By having unique id's you can cross-reference any part of your book with a simple tag, regardless of where that part is. -
Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
+Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
- Find information about creating a package in <xref linkend="packages-making-a-package"></xref>.And the output is:
@@ -206,7 +206,7 @@ packages-looks, the parser will try its best to explain where the link takes you.- 2. Linking outside the documentation
- + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different @@ -227,7 +227,7 @@ do it, so if you want to start converting your documents right away, start out with the ones without graphics ;)
- + To insert a graphic we use the elements <mediaobject>, <imageobject>, @@ -253,7 +253,7 @@ Put your graphics in a separate directory ("images") and link to them only with relative paths.
- + Here's how you make the DocBook equivalent of the three usual HTML-lists:
- 1. How to make an <ul>
Making an unordered list is pretty much like doing the same thing in HTML - if you close your <li>, that is. The only differences are that each list item has to be wrapped in something more, such as @@ -298,7 +298,7 @@ </variablelist>
- + DocBook supports several types of tables, but in most cases, the <informaltable> is enough: @@ -335,7 +335,7 @@ <table> for an example.
- + Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one - <emphasis>.
Index: openacs-4/packages/acs-core-docs/www/eng-standards-constraint-naming.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards-constraint-naming.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/eng-standards-constraint-naming.html 15 Dec 2003 15:03:47 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/eng-standards-constraint-naming.html 16 Dec 2003 13:58:41 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -
Constraint naming standard By Michael Bryzek
+Constraint naming standard Index: openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html 15 Dec 2003 15:03:47 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html 16 Dec 2003 13:58:41 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -
ACS File Naming and Formatting Standards By Michael Yoon and Aurelius Prochazka
+ACS File Naming and Formatting Standards Index: openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 15 Dec 2003 15:03:47 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 16 Dec 2003 13:58:41 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -
PL/SQL Standards +
PL/SQL Standards By Richard Li and Yon Feldman
OpenACS docs are written by the named authors, and may be edited Index: openacs-4/packages/acs-core-docs/www/eng-standards-versioning.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards-versioning.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/eng-standards-versioning.html 15 Dec 2003 15:03:47 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/eng-standards-versioning.html 16 Dec 2003 13:58:41 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -Release Version Numbering By Ron Henderson
+Release Version Numbering Index: openacs-4/packages/acs-core-docs/www/eng-standards.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards.html,v diff -u -r1.14.2.2 -r1.14.2.3 --- openacs-4/packages/acs-core-docs/www/eng-standards.html 8 Dec 2003 15:41:17 -0000 1.14.2.2 +++ openacs-4/packages/acs-core-docs/www/eng-standards.html 16 Dec 2003 13:58:41 -0000 1.14.2.3 @@ -1 +1 @@ -
Chapter�9.�Engineering Standards View comments on this page at openacs.org +Chapter�9.�Engineering Standards View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html,v diff -u -r1.11.2.4 -r1.11.2.5 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 15 Dec 2003 15:03:47 -0000 1.11.2.4 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 16 Dec 2003 13:58:41 -0000 1.11.2.5 @@ -1,4 +1,4 @@ -External Authentication Requirements People have plenty of usernames and passwords already, we +
External Authentication Requirements People have plenty of usernames and passwords already, we don't want them to have yet another. We want people to be able to log in to OpenACS with the same password they use to log in to any other system.
Besides, administrators have better things to do than create @@ -44,7 +44,7 @@ only one implementation of the authentication API, namly the one included in OpenACS Core.
Authentication Driver API: The service contract which authentication drivers implement.
Authentication:
-
Account Management (NO PICTURE YET)
Batch Synchronization (NO PICTURE YET)
Feature Status Description EXT-AUTH-01 A Extend Authentication/Acct Status API EXT-AUTH-03 A Account Creation API EXT-AUTH-05 A Password Management API EXT-AUTH-30 A Authority Management API
Feature Status Description EXT-AUTH-04 A Rewrite login, register, and admin pages to use APIs EXT-AUTH-38 A ad_form complain feature EXT-AUTH-19 A Rewrite password recovery to use API EXT-AUTH-21 A Rewrite email verification with API EXT-AUTH-28 A Username is email switch Users will log in using a username, a authority, and a +
Account Management (NO PICTURE YET)
Batch Synchronization (NO PICTURE YET)
Feature Status Description EXT-AUTH-01 A Extend Authentication/Acct Status API EXT-AUTH-03 A Account Creation API EXT-AUTH-05 A Password Management API EXT-AUTH-30 A Authority Management API
Feature Status Description EXT-AUTH-04 A Rewrite login, register, and admin pages to use APIs EXT-AUTH-38 A ad_form complain feature EXT-AUTH-19 A Rewrite password recovery to use API EXT-AUTH-21 A Rewrite email verification with API EXT-AUTH-28 A Username is email switch Users will log in using a username, a authority, and a password. The authority is the source for user/password verification. OpenACS can be an authority itself.
Each user in OpenACS will belong to exactly one authority, which can either be the "local" OpenACS users table, in which case the Index: openacs-4/packages/acs-core-docs/www/filename.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/filename.html,v diff -u -r1.22.2.4 -r1.22.2.5 --- openacs-4/packages/acs-core-docs/www/filename.html 15 Dec 2003 15:03:47 -0000 1.22.2.4 +++ openacs-4/packages/acs-core-docs/www/filename.html 16 Dec 2003 13:58:41 -0000 1.22.2.5 @@ -1,4 +1,4 @@ -
Detailed Design Documentation Template By You
+
Detailed Design Documentation Template By You
NOTE: Some of the sections of this template may not apply to your package, e.g. there may be no user-visible UI elements for a component of the OpenACS Core. Furthermore, it may be easier in some circumstances Index: openacs-4/packages/acs-core-docs/www/for-everyone.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/for-everyone.html,v diff -u -r1.13.2.2 -r1.13.2.3 --- openacs-4/packages/acs-core-docs/www/for-everyone.html 8 Dec 2003 15:41:17 -0000 1.13.2.2 +++ openacs-4/packages/acs-core-docs/www/for-everyone.html 16 Dec 2003 13:58:41 -0000 1.13.2.3 @@ -1 +1 @@ -
Part�I.�OpenACS For Everyone View comments on this page at openacs.org +Part�I.�OpenACS For Everyone View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/form-builder.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/form-builder.html,v diff -u -r1.1.2.2 -r1.1.2.3 --- openacs-4/packages/acs-core-docs/www/form-builder.html 15 Dec 2003 15:03:47 -0000 1.1.2.2 +++ openacs-4/packages/acs-core-docs/www/form-builder.html 16 Dec 2003 13:58:41 -0000 1.1.2.3 @@ -1,4 +1,4 @@ -Using HTML Forms Some elements have more than one choice, or can submit more than one value.
Creating the form element.�Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list " +Using HTML Forms Some elements have more than one choice, or can submit more than one value.
Creating the form element.�Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list " select foo, foo_id from foos Index: openacs-4/packages/acs-core-docs/www/general-documents.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/general-documents.html,v diff -u -r1.13.2.2 -r1.13.2.3 --- openacs-4/packages/acs-core-docs/www/general-documents.html 8 Dec 2003 15:41:17 -0000 1.13.2.2 +++ openacs-4/packages/acs-core-docs/www/general-documents.html 16 Dec 2003 13:58:41 -0000 1.13.2.3 @@ -1 +1 @@ -Chapter�1.�High level information: What is OpenACS? Table of Contents
View comments on this page at openacs.org +Chapter�1.�High level information: What is OpenACS? Table of Contents
View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/groups-design.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/groups-design.html,v diff -u -r1.15.2.2 -r1.15.2.3 --- openacs-4/packages/acs-core-docs/www/groups-design.html 8 Dec 2003 15:41:17 -0000 1.15.2.2 +++ openacs-4/packages/acs-core-docs/www/groups-design.html 16 Dec 2003 13:58:41 -0000 1.15.2.3 @@ -1,4 +1,4 @@ -Groups Design By Rafael H. Schloming and Mark Thomas
+Groups Design
User directory
Sitewide administrator directory
Subsite administrator directory
TCL script directory
Data model
PL/SQL file