| Prev | Next |
Table of Contents
Tutorials and reference material for creating new OpenACS packages. -
Table of Contents
Tutorials and reference material for creating new OpenACS packages. +
Table of Contents
Table of Contents
Table of Contents
Download the Analog source tarball in -/tmp. Unpack, compile, and install analog.
[root@yourserver aolserver]# cd /usr/local/src -[root@yourserver src]# tar xzf /tmp/analog-5.32.tar.gz -[root@yourserver src]# cd analog-5.32 -[root@yourserver analog-5.32]# make +Install Analog web file analyzer 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 +[root analog-5.32]# make cd src && make make[1]: Entering directory `/usr/local/src/analog-5.32/src' (many lines omitted) ***IMPORTANT: You must read the licence before using analog *** make[1]: Leaving directory `/usr/local/src/analog-5.32/src' -[root@yourserver analog-5.32]# cd .. -[root@yourserver src]# mv analog-5.32 /usr/share/ -[root@yourserver src]# +[root analog-5.32]# cd .. +[root src]# mv analog-5.32 /usr/share/ +[root src]# cd /usr/local/src tar xzf /tmp/analog-5.32.tar.gz 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 -N -r1.25 -r1.26 --- openacs-4/packages/acs-core-docs/www/aolserver.html 11 Dec 2003 23:08:45 -0000 1.25 +++ openacs-4/packages/acs-core-docs/www/aolserver.html 4 Feb 2004 16:47:32 -0000 1.26 @@ -1,8 +1,8 @@ -Install AOLserver 3.3oacs1 by Vinod Kurup
+Install AOLserver 3.3oacs1
Unpack the Aolserver tarball.�Download the aolserver tarball and unpack it.
[root@yourserver root]# cd /usr/local/src -[root@yourserver src]# wget --passive http://uptime.openacs.org/aolserver-openacs/aolserver3.3oacs1.tar.gz +
Unpack the Aolserver tarball.�Download the aolserver tarball and unpack it.
[root root]# cd /usr/local/src +[root src]# wget --passive http://uptime.openacs.org/aolserver-openacs/aolserver3.3oacs1.tar.gz --15:38:08-- http://uptime.openacs.org/aolserver-openacs/aolserver3.3oacs1.tar.gz => `aolserver3.3oacs1.tar.gz' Resolving uptime.openacs.org... done. @@ -13,16 +13,16 @@ 100%[====================================>] 3,858,074 66.56K/s ETA 00:00 15:39:05 (66.56 KB/s) - `aolserver3.3oacs1.tar.gz' saved [3858074/3858074] -[root@yourserver src]# tar xzf aolserver3.3oacs1.tar.gz -[root@yourserver src]# +[root src]# tar xzf aolserver3.3oacs1.tar.gz +[root src]# cd /usr/local/src wget --passive http://uptime.openacs.org/aolserver-openacs/aolserver3.3oacs1.tar.gz tar xzf aolserver3.3oacs1.tar.gzThis section also relies on some OpenACS files, which you can get with the section called “Unpack the OpenACS tarball”.
Compile AOLserver.�Compile and install AOLserver. First, prepare the installation directory and the source code. The message about BUILD-MODULES can be ignored.
root@yourserver root]# mkdir -p /usr/local/aolserver -[root@yourserver root]# cd /usr/local/src/aolserver -[root@yourserver aolserver]# ./conf-clean +[root root]# cd /usr/local/src/aolserver +[root aolserver]# ./conf-clean cat: BUILD-MODULES: No such file or directory Done. -[root@yourserver aolserver]#mkdir -p /usr/local/aolserver +[root aolserver]#mkdir -p /usr/local/aolserver cd /usr/local/src/aolserver ./conf-cleanIf you are using Oracle, edit @@ -35,8 +35,8 @@ the environment variables properly.
conf-inst should contain the location where AOLserver is to be installed. Overwrite the - tarball's default value with our default value, /usr/local/aolserver:
[root@yourserver aolserver]# echo "/usr/local/aolserver" > conf-inst -[root@yourserver aolserver]#conf-make should contain the + tarball's default value with our default value, /usr/local/aolserver:
[root aolserver]# echo "/usr/local/aolserver" > conf-inst +[root aolserver]#conf-make should contain the name of the GNU Make command on your system. It defaults to gmake. Debian users: ln -s /usr/bin/make /usr/bin/gmake.
Set an environment variable that the nspostgres driver Makefile needs to compile correctly and run @@ -46,7 +46,7 @@ postgresql from apt-get may need to make these symlinks: ln -s /usr/include/postgresql/ /usr/include/pgsql - and ln -s /usr/lib/postgresql /usr/local/pgsql)
[root@yourserver aolserver]# export POSTGRES=/usr/local/pgsql; ./conf + and ln -s /usr/lib/postgresql /usr/local/pgsql)[root aolserver]# export POSTGRES=/usr/local/pgsql; ./conf Building in /usr/local/aolserver with the following modules: aolserver @@ -67,28 +67,28 @@ Creating ... ================================================================== Done Building Sat Mar 8 10:31:35 PST 2003 -[root@yourserver aolserver]#+[root aolserver]#
This takes about 5 minutes. It builds aolserver, several modules, and the database driver. (Upgraders, note that the postgres database driver has changed from postgres.so to nspostgres.so). All of the results are logged to files in /usr/local/src/aolserver/log. If you run into problems running AOLserver, check these files for build errors.
Add a database-specific wrapper script.�This script sets database environment variables before starting AOLserver; this allows the AOLserver instance can communicate with the database. There is one script each for Oracle and PostgreSQL. They don't conflict, so if you plan - to use both databases, install both.
Oracle
[root@yourserver aolserver]# cd /usr/local/aolserver/bin -[root@yourserver bin]# cp /tmp/openacs-5.0.0b4/packages/acs-core-docs/www/files/nsd-oracle.txt ./nsd-oracle -[root@yourserver bin]# chmod 750 nsd-oracle -[root@yourserver bin]# + to use both databases, install both.
Oracle
[root aolserver]# cd /usr/local/aolserver/bin +[root bin]# cp /tmp//packages/acs-core-docs/www/files/nsd-oracle.txt ./nsd-oracle +[root bin]# chmod 750 nsd-oracle +[root bin]# cd /usr/local/aolserver/bin -cp /tmp/openacs-5.0.0b4/packages/acs-core-docs/www/files/nsd-oracle.txt ./nsd-oracle -chmod 750 nsd-oraclePostgreSQL
[root@yourserver aolserver]# cd /usr/local/aolserver/bin -[root@yourserver bin]# cp /tmp/openacs-5.0.0b4/packages/acs-core-docs/www/files/nsd-postgres.txt ./nsd-postgres -[root@yourserver bin]# chmod 755 nsd-postgres -[root@yourserver bin]# +cp /tmp//packages/acs-core-docs/www/files/nsd-oracle.txt ./nsd-oracle +chmod 750 nsd-oraclePostgreSQL
[root aolserver]# cd /usr/local/aolserver/bin +[root bin]# cp /tmp//packages/acs-core-docs/www/files/nsd-postgres.txt ./nsd-postgres +[root bin]# chmod 755 nsd-postgres +[root bin]# cd /usr/local/aolserver/bin -cp /tmp/openacs-5.0.0b4/packages/acs-core-docs/www/files/nsd-postgres.txt ./nsd-postgres +cp /tmp//packages/acs-core-docs/www/files/nsd-postgres.txt ./nsd-postgres chmod 755 nsd-postgresInstall tDOM.�Download the tDOM tarball, unpack it, adjust the configuration file to match our patched - distribution of aolserver, and compile it.
[root@yourserver root]# cd /usr/local/src -[root@yourserver src]# wget --passive http://www.tdom.org/tDOM-0.7.8.tar.gz + distribution of aolserver, and compile it.[root root]# cd /usr/local/src +[root src]# wget --passive http://www.tdom.org/tDOM-0.7.8.tar.gz --16:40:58-- http://www.tdom.org/tDOM-0.7.8.tar.gz => `tDOM-0.7.8.tar.gz' Resolving www.tdom.org... done. @@ -100,9 +100,9 @@ 16:41:04 (138.06 KB/s) - `tDOM-0.7.8.tar.gz' saved [826613/826613] -[root@yourserver src]# tar xzf tDOM-0.7.8.tar.gz -[root@yourserver src]# cd tDOM-0.7.8/unix -[root@yourserver unix]# +[root src]# tar xzf tDOM-0.7.8.tar.gz +[root src]# cd tDOM-0.7.8/unix +[root unix]# cd /usr/local/src wget --passive http://www.tdom.org/tDOM-0.7.8.tar.gz tar xzf tDOM-0.7.8.tar.gz @@ -114,22 +114,22 @@ aolsrc="/usr/local/src/aolserver/aolserver" ../configure --enable-threads --disable-tdomalloc \ --with-aolserver=$aolsrc \ - --with-tcl=$aolsrc/tcl8.3.2/unixAnd configure and compile:
[root@yourserver unix]# sh CONFIG + --with-tcl=$aolsrc/tcl8.3.2/unixAnd configure and compile:
[root unix]# sh CONFIG creating cache ./config.cache checking for memmove... yes (many lines omitted) creating Makefile creating tdomConfig.sh -[root@yourserver unix]# make +[root unix]# make gcc -pipe -DHAVE_UNISTD_H=1 -DHAVE_LIMITS_H=1 -DTCL_THREADS=1 -DHAVE_GETCWD=1 -DHAVE_OPENDIR=1 -DHAVE_STRSTR=1 -DHAVE_STRTOL=1 (many lines omitted) -Wl,-rpath,/usr/local/lib -o tcldomsh;\ fi -[root@yourserver unix]# cp libtdom0.7.8.so /usr/local/aolserver/bin/ -[root@yourserver unix]# cd /usr/local/aolserver/bin/ -[root@yourserver bin]# ln -s libtdom0.7.8.so libtdom.so -[root@yourserver bin]# +[root unix]# cp libtdom0.7.8.so /usr/local/aolserver/bin/ +[root unix]# cd /usr/local/aolserver/bin/ +[root bin]# ln -s libtdom0.7.8.so libtdom.so +[root bin]# sh CONFIG make @@ -144,10 +144,10 @@ or it will fail. Grant the web group permission to write to /usr/local/aolserver/log and - /usr/local/aolserver/servers.[root@yourserver root]# cd /usr/local/aolserver -[root@yourserver aolserver]# chown -R root.web log servers -[root@yourserver aolserver]# chmod -R g+w log servers -[root@yourserver aolserver]# ls -l + /usr/local/aolserver/servers.[root root]# cd /usr/local/aolserver +[root aolserver]# chown -R root.web log servers +[root aolserver]# chmod -R g+w log servers +[root aolserver]# ls -l total 32 drwxr-sr-x 2 root root 4096 Mar 8 12:57 bin drwxr-xr-x 3 root root 4096 Mar 8 10:34 include @@ -156,7 +156,7 @@ drwxr-sr-x 3 root root 4096 Mar 8 10:31 modules -rw-r--r-- 1 root root 7320 Mar 31 2001 sample-config.tcl drwxrwsr-x 3 root web 4096 Mar 8 10:31 servers -[root@yourserver aolserver]# +[root aolserver]# cd /usr/local/aolserver chown -R root.web log servers @@ -165,8 +165,8 @@ correctly. We'll use the sample config file provided with AOLserver. This file will attempt to guess your IP address and hostname. It will then start up the server at port 8000 of that - IP address.[root@yourserver aolserver]# ./bin/nsd -t sample-config.tcl -u nobody -g web -[root@yourserver aolserver]# [08/Mar/2003:15:07:18][31175.8192][-main-] Notice: config.tcl: starting to read config file... + IP address.[root aolserver]# ./bin/nsd -t sample-config.tcl -u nobody -g web +[root aolserver]# [08/Mar/2003:15:07:18][31175.8192][-main-] Notice: config.tcl: starting to read config file... [08/Mar/2003:15:07:18][31175.8192][-main-] Warning: config.tcl: nsssl not loaded -- key/cert files do not exist. [08/Mar/2003:15:07:18][31175.8192][-main-] Warning: config.tcl: nscp not loaded -- user/password is not set. @@ -181,15 +181,15 @@ didn't guess your hostname or ip correctly, you'll get a false negative test. -[root@yourserver aolserver]# lynx localhost:8000+
[root aolserver]# lynx localhost:8000You should see a "Welcome to AOLserver" page. If this doesn't work, try going to http://127.0.0.1:8000/. If this still doesn't work, check out the Troubleshooting AOLserver section below. Note that you will not be able to browse to the web page from another machine, because AOLserver is only listening to the local address. -
Shutdown the test server:
[root@yourserver aolserver]# killall nsd -[root@yourserver aolserver]#+
Shutdown the test server:
[root aolserver]# killall nsd +[root aolserver]#The killall command will kill all processes with the name nsd, @@ -230,4 +230,4 @@ set hostname [ns_info hostname] #set address [ns_info address] set address 0.0.0.0
Install - Analog web file analyzer. (OPTIONAL)
($Id$)View comments on this page at openacs.org + Analog web file analyzer. (OPTIONAL)($Id$)View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/aolserver4.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/aolserver4.html,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/acs-core-docs/www/aolserver4.html 4 Feb 2004 16:47:32 -0000 1.2 @@ -0,0 +1,80 @@ +Install AOLserver 4
Retrieve TCL 8.4 (or higher).�Download and install TCL 8.4
If you have not installed TCL already, download the latest TCL version from Sourceforge
[root root]# cd /usr/local/src +[root src]# wget http://heanet.dl.sourceforge.net/sourceforge/tcl/tcl8.4.5-src.tar.gz +[root src]# tar xfz tcl8.4.5-src.tar.gz +[root src]# cd tcl8.4.5/unix +[root unix]# ./configure --enable-threads +[root unix]# make install +[root root]# +cd /usr/local/src +wget http://heanet.dl.sourceforge.net/sourceforge/tcl/tcl8.4.5-src.tar.gz +tar xfz tcl8.4.5-src.tar.gz +cd tcl8.4.5/unix +./configure --enable-threads +make install + +Retrieve AOLserver.�Download the aolserver from CVS.
[root root]# cd /usr/local/src +[root src]# mkdir aolserver +[root src]# cd aolserver +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co -r aolserver_v40_r2 aolserver +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nscache +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nsrewrite +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nspostgres +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nssha1 +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nsoracle +[root aolserver]# cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nsxml +[root aolserver]# wget http://www.tdom.org/tDOM-0.7.8.tar.gz +[root aolserver]# tar xvfz tDOM-0.7.8.tar.gz +[root root]# +cd /usr/local/src +mkdir aolserver +cd aolserver +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co -r aolserver_v40_r2 aolserver +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nscache +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nsrewrite +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nspostgres +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nssha1 +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nsoracle +cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/aolserver co nsxml +wget http://www.tdom.org/tDOM-0.7.8.tar.gz +tar xvfz tDOM-0.7.8.tar.gzConfigure, compile and install AOLserver.�
[root aolserver]# cd aolserver +[root aolserver]# cd aolserver +[root aolserver]# ./configure --with-tcl=/usr/local/lib/ +[root aolserver]# make installConfigure, compile and install the modules.� +
Install nsoracle (if you want to use Oracle)
[root /usr/local/src/aolserver/nscache]# cd ../nsoracle +[root /usr/local/src/aolserver/nsrewrite]# make installSteps so far
cd /usr/local/src/aolserver/ +./configure --with-tcl=/usr/local/lib/ +make install +cd ../nscache +make install +cd ../nsrewrite +make install +cd ../nsoracle +make installInstall nspostgres (if you want to use Postgres)
[root nsrewrite]# cd ../nspostgres +[root nspostgres]# sudo make install POSTGRES=/usr/local/pgsql ACS=1 INST=/usr/local/aolserverIf you run into problems with libpq.a do the following (and repeat the step above)
[root nspostgres]# sudo ranlib /usr/local/pgsql/lib/libpq.aIf you run into problems with the linker, edit the Makefile. Add -lnsdb to the MODLIBS var.
MODLIBS = -L$(PGLIB) -lpq -lnsdbIf the make fails you will have to edit nssha1.c. Comment out the following 2 lines (lines 139-140):
// typedef unsigned int u_int32_t; +// typedef unsigned char u_int8_t;Now install nssha1:
[root nssha1]# make installEdit the CONFIG file. Uncomment the instructions meant for AOLserver 4, but edit it to look like this:
../configure --enable-threads --disable-tdomalloc + --prefix=/usr/local/aolserver --with-tcl=/usr/local/libNow you can compile and configure tDOM
[root unix]# sh CONFIG +[root unix]# make install+
Add a database-specific wrapper script.�This script + sets database environment variables before starting + AOLserver; this allows the AOLserver instance can + communicate with the database. There is one script each for + Oracle and PostgreSQL. They don't conflict, so if you plan + to use both databases, install both.
Oracle
[root aolserver]# cd /usr/local/aolserver/bin +[root bin]# cp /tmp//packages/acs-core-docs/www/files/nsd-oracle.txt ./nsd-oracle +[root bin]# chmod 750 nsd-oracle +[root bin]# +cd /usr/local/aolserver/bin +cp /tmp//packages/acs-core-docs/www/files/nsd-oracle.txt ./nsd-oracle +chmod 750 nsd-oraclePostgreSQL
[root aolserver]# cd /usr/local/aolserver/bin +[root bin]# cp /tmp//packages/acs-core-docs/www/files/nsd-postgres.txt ./nsd-postgres +[root bin]# chmod 755 nsd-postgres +[root bin]# +cd /usr/local/aolserver/bin +cp /tmp//packages/acs-core-docs/www/files/nsd-postgres.txt ./nsd-postgres +chmod 755 nsd-postgresChange startup script (optional).�If you want to run AOLserver on a port below 1024 (normally, for a webserver you will use 80), you will have to change the /var/lib/aolserver/service0/etc/daemontools/run script according to the documentation found there (namely: Add the -b yourip:yourport switch)
($Id: aolserver4.html,v 1.2 2004/02/04 16:47:32 joela Exp $)View comments on this page at openacs.org 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 -N -r1.23 -r1.24 --- openacs-4/packages/acs-core-docs/www/apm-design.html 11 Dec 2003 23:08:45 -0000 1.23 +++ openacs-4/packages/acs-core-docs/www/apm-design.html 4 Feb 2004 16:47:32 -0000 1.24 @@ -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 @@ -87,7 +87,7 @@ packages for other OpenACS users to download and install.
For a simple illustration of the difference between ACS without APM (pre-3.3) and ACS with APM (3.3 and beyond), consider a hypothetical ACS installation that uses only two of the thirty-odd modules available circa ACS -3.2 (say, bboard and e-commerce):
[D]APM itself is part of a package, the OpenACS Kernel, an OpenACS +3.2 (say, bboard and e-commerce):
APM itself is part of a package, the OpenACS Kernel, an OpenACS service that is the only mandatory component of an OpenACS installation.
The OpenACS is a platform for web-based application software, and any software platform has the potential to develop problems like those described above. Fortunately, there are many precedents for systematic solutions, 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 -N -r1.18 -r1.19 --- openacs-4/packages/acs-core-docs/www/apm-requirements.html 11 Dec 2003 23:08:45 -0000 1.18 +++ openacs-4/packages/acs-core-docs/www/apm-requirements.html 4 Feb 2004 16:47:32 -0000 1.19 @@ -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 -N -r1.3 -r1.4 --- openacs-4/packages/acs-core-docs/www/automated-testing-best-practices.html 11 Dec 2003 23:08:45 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/automated-testing-best-practices.html 4 Feb 2004 16:47:32 -0000 1.4 @@ -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 -N -r1.18 -r1.19 --- openacs-4/packages/acs-core-docs/www/backup-recovery.html 23 Jan 2004 15:09:52 -0000 1.18 +++ openacs-4/packages/acs-core-docs/www/backup-recovery.html 4 Feb 2004 16:47:32 -0000 1.19 @@ -1,8 +1,13 @@ -
Backup and Recovery By Don Baccus with additions - by Joel Aufrecht
+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,171 @@ 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@localhost root]# su - service0 - [service0@localhost service0]$ pg_dump -f /var/lib/aolserver/service0/database-backup/before_upgrade_to_4.6.dmp service0 - [service0@localhost 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@localhost service0]$ exit - [root@localhost 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@yourserver root]# su - service0 - [service0@yourserver 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@yourserver service0]$Suffer a catastrophic failure on your production system.�(We'll simulate this step)
[root@yourserver root]# svc -d /service/service0 - [root@yourserver root]# mv /var/lib/aolserver/service0/ /var/lib/aolserver/service0.lost - [root@yourserver root]# rm /service/service0 - rm: remove symbolic link `/service/service0'? y - [root@yourserver root]# ps -auxw | grep service0 - root 1496 0.0 0.0 1312 252 ? S 16:58 0:00 supervise service0 - [root@yourserver root]# kill 1496 - [root@yourserver root]# ps -auxw | grep service0 - [root@yourserver root]# su - postgres - [postgres@yourserver pgsql]$ dropdb service0 - DROP DATABASE - [postgres@yourserver pgsql]$ dropuser service0 - DROP USER - [postgres@yourserver pgsql]$ exit - logout - [root@yourserver root]#
Restore the operating system and required software. + recursive backup.
[root root]# su - service0 +[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@yourserver root]# su - service0 - [service0@yourserver service0]$ cd /var/lib/aolserver - [service0@yourserver aolserver]$ tar xjf /tmp/service0-backup.tar.bz2 - [service0@yourserver aolserver]$ chmod -R 775 service0 - [service0@yourserver 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@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 - [service0@yourserver web]$ createdb service0 - CREATE DATABASE - [service0@yourserver web]$ psql -f /var/lib/aolserver/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 - (many lines omitted) - [service0@yourserver web]$ psql service0 < /var/lib/aolserver/service0/database-backup/database-backup.dmp - (many lines omitted) - [service0@yourserver web]$ exit - [postgres@yourserver pgsql]$ exit - logout -Activate the service
[root@yourserver root]# ln -s /var/lib/aolserver/service0/etc/daemontools /service/service0 - [root@yourserver root]# sleep 10 - [root@yourserver root]# svgroup web /service/service0 - [root@yourserver 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.
+ 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 xzf /tmp/service0-backup.tar.gz +[service0 aolserver]$ chmod -R 775 service0 +[service0 aolserver]$ chown -R service0.web service0Restore 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.�If the database user does not already exist, create it.
[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 ~]$ exit +Because of a bug in Postgres backup-recovery, database objects are not guaranteed to be created in the right order. In practice, running the OpenACS initialization script is always sufficient to create any out-of-order database objects. Next, restore the database from the dump file. The restoration will show some error messages at the beginning for objects that were pre-created from the OpenACS initialization script, which can be ignored.
[root root]# 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@localhost root]# su - service0 - [service0@localhost service0]$ cd /var/lib/aolserver/service0 - [service0@localhost service0]$ cvs commit -m "last-minute commits before upgrade to 4.6" - cvs commit: Examining . - cvs commit: Examining bin - (many lines omitted) - [service0@localhost 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@localhost service0]$ exit - [root@localhost 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@localhost root]# su - service0 - [service0@localhost service0]$ cd /var/lib/aolserver/service0 - [service0@localhost service0]$ cvs up -r current - [service0@localhost 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 -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/bootstrap-acs.html 11 Dec 2003 23:08:45 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/bootstrap-acs.html 4 Feb 2004 16:47:32 -0000 1.25 @@ -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 -N -r1.6 -r1.7 --- openacs-4/packages/acs-core-docs/www/complete-install.html 11 Dec 2003 23:08:45 -0000 1.6 +++ openacs-4/packages/acs-core-docs/www/complete-install.html 4 Feb 2004 16:47:32 -0000 1.7 @@ -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/configuring-new-site.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-new-site.html,v diff -u -N --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/acs-core-docs/www/configuring-new-site.html 4 Feb 2004 16:47:32 -0000 1.2 @@ -0,0 +1,4 @@ +Chapter�4.�Configuring a new OpenACS Site Table of Contents
In this chapter, Configuring refers to making changes to a new OpenACS site through the web interface. In crude terms, these changes happen in the database, and are upgrade-safe. Customizing refers to changes that touch the file system, and require some planning if easy upgradability is to be maintained.
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 -N -r1.23 -r1.24 --- openacs-4/packages/acs-core-docs/www/credits.html 19 Nov 2003 15:44:49 -0000 1.23 +++ openacs-4/packages/acs-core-docs/www/credits.html 4 Feb 2004 16:47:32 -0000 1.24 @@ -1,4 +1,4 @@ -Appendix�C.�Credits Table of Contents
By Vinod Kurup
+Appendix�C.�Credits Table of Contents
Vinod Kurup put @@ -32,4 +32,4 @@
All questions and comments regarding this guide should be posted on the OpenACS forums. -
($Id$)View comments on this page at openacs.org +($Id$)View comments on this page at openacs.org 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 -N -r1.8 -r1.9 --- openacs-4/packages/acs-core-docs/www/cvs-tips.html 11 Dec 2003 23:08:45 -0000 1.8 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.html 4 Feb 2004 16:47:32 -0000 1.9 @@ -1,19 +1,17 @@ -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@yourserver root]# mkdir /cvsroot/service0 -[root@yourserver root]# chown service0.web /cvsroot/service0 -[root@yourserver root]# + 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 -chown service0.web /cvsroot/service0Add the repository location to the user environment.
[root@yourserver root]# su - service0 -[service0@yourserver service0]$ emacs .bashrcPut this string into /home/service0/.bashrc:
export CVSROOT=/cvsroot[service0@yourserver service0]$ exit +chown service0.web /cvsroot/service0Add the repository location to the user environment.
[root root]# su - service0 +[service0 service0]$ emacs .bashrcPut this string into /home/service0/.bashrc:
export CVSROOT=/cvsroot[service0 service0]$ exit logout -[root@yourserver root]#Import all files into cvs. In order to work on +[root root]#
Import all files into cvs. In order to work on files with source control, the files must be checked out from cvs. So we will import, move aside, and then check out all of the files. In the cvs import command, @@ -22,33 +20,33 @@ plus this string, i.e. /cvsroot/service0. - "OpenACS" is the vendor tag, and "openacs-5-0-0b4" is the + "OpenACS" is the vendor tag, and "" is the release tag. These tags will be useful in upgrading and - branching. -m sets the version comment.
[root@yourserver root]# su - service0 -[service0@yourserver service0]$ cd /web/service0 -[service0@yourserver service0]$ cvs import -m "initial install" service0 OpenACS openacs-5-0-0b4 + branching. -m sets the version comment.[root root]# su - service0 +[service0 service0]$ cd /web/service0 +[service0 service0]$ cvs import -m "initial install" service0 OpenACS N service0/license.txt N service0/readme.txt (many lines omitted) N service0/www/SYSTEM/flush-memoized-statement.tcl No conflicts created by this import -[service0@yourserver service0]$ +[service0 service0]$ su - service0 cd /web/service0 -cvs import -m "initial install" service0 OpenACS openacs-5-0-0b4Move the original directory to a temporary location, and check out the cvs repository in its place. If the service starts correctly, come back and remove the temporary copy of the uploaded files.
[service0@yourserver service0]$ cd .. -[service0@yourserver web]$ mv service0 service0.orig -[service0@yourserver web]$ cvs checkout service0 +cvs import -m "initial install" service0 OpenACSMove the original directory to a temporary location, and check out the cvs repository in its place. If the service starts correctly, come back and remove the temporary copy of the uploaded files.
[service0 service0]$ cd .. +[service0 web]$ mv service0 service0.orig +[service0 web]$ cvs checkout service0 cvs checkout: Updating service0 U service0/license.txt (many lines omitted) U service0/www/SYSTEM/dbtest.tcl U service0/www/SYSTEM/flush-memoized-statement.tcl -[service0@yourserver web]$ exit +[service0 web]$ exit logout -[root@yourserver web]# +[root web]# cd .. mv service0 service0.orig cvs checkout 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 -N -r1.16 -r1.17 --- openacs-4/packages/acs-core-docs/www/database-management.html 11 Dec 2003 23:08:45 -0000 1.16 +++ openacs-4/packages/acs-core-docs/www/database-management.html 4 Feb 2004 16:47:32 -0000 1.17 @@ -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 -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/db-api-detailed.html 11 Dec 2003 23:08:45 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/db-api-detailed.html 4 Feb 2004 16:47:32 -0000 1.25 @@ -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 -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/db-api.html 11 Dec 2003 23:08:45 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/db-api.html 4 Feb 2004 16:47:32 -0000 1.25 @@ -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 -N -r1.19 -r1.20 --- openacs-4/packages/acs-core-docs/www/dev-guide.html 11 Dec 2003 23:08:45 -0000 1.19 +++ openacs-4/packages/acs-core-docs/www/dev-guide.html 4 Feb 2004 16:47:32 -0000 1.20 @@ -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 -N -r1.2 -r1.3 --- openacs-4/packages/acs-core-docs/www/doc-standards.html 11 Dec 2003 21:39:47 -0000 1.2 +++ openacs-4/packages/acs-core-docs/www/doc-standards.html 4 Feb 2004 16:47:32 -0000 1.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 -N -r1.25 -r1.26 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 11 Dec 2003 23:08:45 -0000 1.25 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 4 Feb 2004 16:47:32 -0000 1.26 @@ -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>.
@@ -378,8 +378,8 @@ bash$ xsltproc /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/html/chunk.xsl filename.xml
You could also look at the acs-core-docs Makefile - for examples of how these documents are generated.` -
+ for examples of how these documents are generated. +
The LDP Author Guide has a lot of good information, a table of docbook elements and their "look" in HTML and lots of good links 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 -N -r1.23 -r1.24 --- openacs-4/packages/acs-core-docs/www/eng-standards-constraint-naming.html 19 Nov 2003 15:44:50 -0000 1.23 +++ openacs-4/packages/acs-core-docs/www/eng-standards-constraint-naming.html 4 Feb 2004 16:47:32 -0000 1.24 @@ -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 -N -r1.23 -r1.24 --- openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html 19 Nov 2003 15:44:50 -0000 1.23 +++ openacs-4/packages/acs-core-docs/www/eng-standards-filenaming.html 4 Feb 2004 16:47:32 -0000 1.24 @@ -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 -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 11 Dec 2003 23:08:46 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 4 Feb 2004 16:47:32 -0000 1.25 @@ -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 -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/eng-standards-versioning.html 11 Dec 2003 23:08:46 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/eng-standards-versioning.html 4 Feb 2004 16:47:32 -0000 1.25 @@ -1,41 +1,26 @@ -Release Version Numbering By Ron Henderson
+Release Version Numbering OpenACS version numbers help identify at a high-level what is in a particular release and what has changed since the last release. A "version number" is really just a string of the form: -
major-minor-release
-A change in the major version number indicates a fundamental -change in the architecture of the system, e.g. OpenACS 3 to ACS 4. A -change in the minor version number signifies the addition of -new modules and minor data model changes, e.g. OpenACS 3.1 to OpenACS 3.2. -The final release number indicates the relative maturity of a -release and marks things like bug fixes; it follows the ordered -progression: -
-alpha -beta -0 (production release) -1 -2 -... --So typical release version numbers would be: -
-openacs-3.2.5 -openacs-4.0.beta --The first is a relatively mature release of the OpenACS 3.2 base code -and the second is a non-public release of OpenACS 4.0 that probably still -has lots of bugs. -
+
major.minor.dot[ milestone ]
A major number change indicates a fundamental change in the architecture of the system, e.g. OpenACS 3 to ACS 4. A major change is required if core backwards compatibility is broken, if upgrade is non-trivial, or if the platform changes substantially.
A minor change represents the addition of new functionality or changed UI.
A dot holds only bug fixes and security patches. Dot releases are always recommended and safe. +
A milestone marker indicates the state of the release:
d, for development, means the release is in active development and is not in its intended released form.
a, for alpha, means new development is complete and code checkins are frozen. Alpha builds should work well enough to be testable.
b, for beta, means most severe bugs are fixed and end users can start trying the release.
Release Candidate builds (rc) are believed to meet all of the criteria for release and can be installed on test instances of production systems.
Final releases have no milestone marker. (Exception: In CVS, they are tagged with -final to differentiate them from branch tags.) +
Milestone markers are numbered: d1, d2, ..., a1, b1, rc1, etc.
A complete sequence of milestones between two releases:
5.0.0 +5.0.0rc2 +5.0.0rc1 +5.0.0b4 +5.0.0b1 +5.0.0a4 +5.0.0a3 +5.0.0a1 +5.0.0d1 +4.6.3Version numbers are also recorded in the CVS repository so that the code tree can be restored to the exact state it was in for a particular release. To translate between a distribution tar file -(acs-3.2.2.tar.gz) and a CVS tag, just swap '.' for '-' and add the -release date. The entire release history of the toolkit is recorded -in the tags for the top-level readme.txt file: +(acs-3.2.2.tar.gz) and a CVS tag, just swap '.' for '-'.The entire release history of the toolkit is recorded in the tags for the top-level readme.txt file:
> cvs log readme.txt RCS file: /usr/local/cvsroot/acs/readme.txt,v @@ -74,20 +59,4 @@So what distinguishes an alpha release from a beta release? Or from a production release? We follow a specific set of rules for how OpenACS makes the transition from one state of maturity to -the next.
Every release must pass the minimum requirements that it cleanly -installs and cleanly upgrades from the previous version of OpenACS. In -addition to this the release label implies:
- development -
This is the default state for the head of the current release branch. We -make no guarantees about this code.
- alpha -
All tickets of severity critical have been closed and the -distribution has no known installation or upgrade problems.
- beta -
All tickets of severity serious or greater have been closed -and all documentation is up to date (version history, release notes, -new module docs, etc.).
- production [0, 1, ...] -
All tickets of severity medium or greater have been closed, -including issues reported from outside users.
In the future we will guarantee that more mature releases -incorporate all the fixes for earlier problems by developing a -detailed set of regression tests. For now we try to enforce this by -restricting work on the release branch to fixing reported problem in -the current release, e.g. no new features or big changes to -fundamental behavior.
($Id$)View comments on this page at openacs.org +the next. These rules are fine-tuned with each release; an example is 5.0.0 Milestones and Milestone Criteria($Id$)View comments on this page at openacs.org 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 -N -r1.16 -r1.17 --- openacs-4/packages/acs-core-docs/www/eng-standards.html 11 Dec 2003 23:08:46 -0000 1.16 +++ openacs-4/packages/acs-core-docs/www/eng-standards.html 4 Feb 2004 16:47:32 -0000 1.17 @@ -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 -N -r1.13 -r1.14 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 11 Dec 2003 23:08:46 -0000 1.13 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 4 Feb 2004 16:47:32 -0000 1.14 @@ -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 -N -r1.24 -r1.25 --- openacs-4/packages/acs-core-docs/www/filename.html 11 Dec 2003 23:08:46 -0000 1.24 +++ openacs-4/packages/acs-core-docs/www/filename.html 4 Feb 2004 16:47:32 -0000 1.25 @@ -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 @@ -114,7 +114,7 @@ within the OpenACS, this section's details are likely to shift from UI specifics to template interface specifics.
- Under OpenACS 5.0.0b4, parameters are set at two levels: at the global level by + Under OpenACS , parameters are set at two levels: at the global level by the OpenACS-admin, and at the subsite level by a sub-admin. In this section, list and discuss both levels of parameters.
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 -N -r1.14 -r1.15 --- openacs-4/packages/acs-core-docs/www/for-everyone.html 19 Nov 2003 15:44:50 -0000 1.14 +++ openacs-4/packages/acs-core-docs/www/for-everyone.html 4 Feb 2004 16:47:32 -0000 1.15 @@ -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 -N -r1.3 -r1.4 --- openacs-4/packages/acs-core-docs/www/form-builder.html 11 Dec 2003 23:08:46 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/form-builder.html 4 Feb 2004 16:47:32 -0000 1.4 @@ -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 @@ -9,4 +9,6 @@ {options $foo_options} }This will result in a single name/value pair coming back in the submitted form. Handle this within the same ad_form structure, in the -new_data and -edit_data. In the example, it is available as $foo
See also the W3C spec for "The SELECT, OPTGROUP, and OPTION elements". -
($Id$)View comments on this page at openacs.org +Here are some common errors and what to do when you + encounter them:
($Id$)View comments on this page at openacs.org 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 -N -r1.14 -r1.15 --- openacs-4/packages/acs-core-docs/www/general-documents.html 19 Nov 2003 15:44:50 -0000 1.14 +++ openacs-4/packages/acs-core-docs/www/general-documents.html 4 Feb 2004 16:47:32 -0000 1.15 @@ -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 -N -r1.17 -r1.18 --- openacs-4/packages/acs-core-docs/www/groups-design.html 11 Dec 2003 23:08:46 -0000 1.17 +++ openacs-4/packages/acs-core-docs/www/groups-design.html 4 Feb 2004 16:47:32 -0000 1.18 @@ -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
