Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml,v diff -u -r1.11 -r1.12 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml 20 Aug 2003 16:20:18 -0000 1.11 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml 28 Oct 2003 22:07:41 -0000 1.12 @@ -4,131 +4,206 @@ %myvars; ]> - - Overview - - - by Vinod Kurup - - - - Purpose of this document - - - This document will describe how to install, configure, and - maintain an installation of OpenACS &version; on a Unix-like - system, including all supporting software. All examples - in this chapter are part of the OpenACS &version;-P or - OpenACS &version;-O Reference Platform, which use Red - Hat 8.0. Differences between the Reference Platform - and common alternate platforms (Red Hat 9, Debian) are noted where known. - - - - - Requirements - - You will need a PC (or equivalent) with at least these minimum - requirements: - - - Pentium processor - 128 MB RAM - (much more if you want Oracle) - 4 GB hard drive - - You will need all everthing marked REQUIRED in software. + + Installation Overview - - If you want to serve pages to people outside of your machine, you'll - need a network connection of some type. - + + by Vinod Kurup + - - Running a reliable database-backed web server requires experience - with the server's environment, in this case UNIX. UNIX is not always - an intuitive environment and this guide cannot hope to explain every - nuance. You should be comfortable with the following tasks before - attempting an installation: + + Basic Steps + + The basic steps to getting OpenACS up and running are: - - - - Adding users, groups, setting passwords - - - (For Oracle) Starting an X server and running an X program remotely - - - Basic file management using cp, rm, - mv, and cd - - - - Compiling a program using ./config and make. - - + + Install an OS (Linux, FreeBSD, OpenBSD, , , ). + + + Install a database (Oracle or + PostgreSQL). + - - You can complete this install without the above knowledge, - but if anything goes wrong it may take extra time to - understand and correct the problem. Some useful UNIX resources. + + Install the AOLserver webserver. + + + Create a unique database and system user. + Install the OpenACS tarball, start and AOLserver instance, and + use the OpenACS web pages to complete installation + (). + + + + + Binaries and other shortcuts + + + The patched version of AOLserver we use is not currently + available in a precompiled binary. + + + + The packaged version of + PostGreSQL in Debian and Red Hat and FreeBSD ports works fine. + + + Jonathan Marsden has created RPMs (at + http://www.xc.org) + for OpenACS 4.5 but there are not yet any for version + &version;. + + + An experimental script automating OpenACS checkout + and installation is in the openacs cvs tree at + /etc/install.sh. + + + + + + + Requirements + + You will need a PC (or equivalent) with at least these minimum + requirements: - - + + Pentium processor + 128 MB RAM + (much more if you want Oracle) + 4 GB hard drive + A Unix-like operating system with tcl, tdom, and + a mail transport agent. () + + All of the software that you will need is free and open-source, except for Oracle. You can obtain a free copy of Oracle for development purposes. This is described in the section. + linkend="install-oracle-getit"/> section. - - - - - Steps involved - - The basic steps to getting OpenACS up and running are: - - - - Install an OS - - Install a database (Oracle or - PostgreSQL) - - - Install a webserver (AOLServer) - - - Copy the OpenACS files into place and start the OpenACS installer, which will configure a database instance. - - - - - - How to use this guide - - - This is text you will see on +
+ Compatibility Matrix + + + + + + + + + + + + + + + OpenACS Version + 3.2.5 + 4.5 + 4.6 + 4.6.1 + 4.6.2 + 4.6.3 + 5.0.0 + + + AolServer + 3 + Verified + + + 3.3+ad13 + Verified + + + 3.3oacs1 + Verified + + + 3.4.2 + No + + + 3.4.2oacs1 + Verified + + + 3.5.5 + Verified + + + 4 + Verified but not for production + + + PostGreSQL + 7.0 + Verified + + + 7.2.x + Verified + + + 7.3.2 - 7.3.4 + No + Verified + + + Oracle + 8.1.6 + Verified + + + 8.1.7 + Verified + + + 9i + No + Untested + + + + +
+ + + + + How to use this guide + + + This is text you will see on screen, such as a Button or link in a radio button list or menu. - - This is text that you will type. - - This is text from a program or file which you may need to + + This is text that you will type. + + This is text from a program or file which you may need to examine or edit: - if {$database == "oracle"} { + if {$database == "oracle"} { set db_password "mysitepassword" } - - - This is text that you will + + + This is text that you will see and type in a command shell, including text you may have to change. It is followed by a list of just the commands, which you can copy and paste. - [root@localhost root]# su - nsadmin + [root@localhost root]# su - nsadmin [nsadmin@localhost aolserver]$ svc -d /service/server1 [nsadmin@localhost aolserver]$ dropdb server1 DROP DATABASE @@ -138,12 +213,106 @@ svc -d /service/server1 dropdb server1 createdb server1 - - - - - - What if I get stuck? + + + + + Paths and Users + +
+ Assumptions in this section + + + + + Fully qualified domain name of your server + yourserver.test + + + name of administrative access account + remadmin + + + OpenACS service + + service0 + +service0 + + + OpenACS service account + service0 + + + OpenACS database name + service0 + + + Root of OpenACS service file tree + /var/lib/aolserver/service0 + + + Location of source code tarballs for new software + /tmp + + + The OpenACS tarball contains some files which + are useful while setting up other software. Those + files are located at: + /tmp/&tarballpath;/packages/acs-core-docs/www/files + + + Database backup directory + /var/lib/aolserver/service0/database-backup + + + Service config files + /var/lib/aolserver/service0/etc + + + Service log files + /var/lib/aolserver/service0/log + + + Compile directory + /usr/local/src + + + PostGreSQL directory + /usr/local/pgsql + + + AOLServer directory + /usr/local/aolserver + + + + +
+ + + None of these locations are set in stone - they're simply + the values that we've chosen. The values that you'll + probably want to change, such as service name, are + marked like this. The other + values we recommend you leave unchanged unless you have a + reason to change them. + + + + Some of the paths and user accounts have been changed from + those recommended in previous versions of this document to + improve security and maintainability. See this + thread for discussion. + + + + + + + + Getting Help during installation We'll do our best to assure that following our instructions will get @@ -153,7 +322,7 @@ - + Keep track of the commands you are run and record their output. I like to do my installations in a shell inside of emacs (M-x shell) so that I can save @@ -163,7 +332,7 @@ - + We'll point out where the error logs for the various pieces of software are. Output from those logs will help us help you. Don't worry if you feel overwhelmed by all the information in the error @@ -174,31 +343,31 @@ - + Search the bboards at openacs.org - you'll often find many people who have struggled through the same spot that you're in. - + The bottom of each page has a link to OpenACS.org, where you can post comments and read other users comments about the contents of the page. - + Ask questions at the irc channel on openprojects.net (#openacs). They're knowledgeable and quite friendly if you can keep them on topic. - + Post a question on the bboards. Make sure you've done a search first. When you do post, be sure to include @@ -210,268 +379,16 @@ - + If you find errors in this document or if you have ideas about making it better, please post them in our BugTracker. - - - + + + + + ($Id$) - - Is there an easier way? - - - After reading through this tome, you may ask yourself if there is a - better way. Well, not quite. Jonathan Marsden has created RPMs (at - http://www.xc.org) - for OpenACS 4.5 but there are not yet any for version - &version;. There has been talk about automating the install process, - but that hasn't happened yet. Stay tuned! - - - - - - Where did this document come from? - - This document was created by Vinod Kurup, but it's really - just plagiarism from a number of documents that came before it. If - I've used something that you've written without proper credit, let me - know and I'll fix it right away. - - Versions 4.6.2 to present were edited by Joel Aufrecht. - - - These are a few of my sources: - - - ArsDigita installation guide - - - - OpenACS 3.x installation guide - - - - Gilbert Wong's FreeBSD - installation guide - - - - Vinod Kurup's Brief OpenACS4 - installation guide - - - - Joel - Aufrecht's OpenACS 4.5 Quick Guide. - - - - - Please also see the section for more acknowledgements. - - - - - Linux Install Guides - - Here's a list of some helpful documentation for various OS's - - - - - Painless Debian - GNU/Linux by Stephen van Egmond - - - - - Official - Debian Guide - - - - - - RedHat - - - - - - Mandrake - - - - - - SuSE - - - - - - - - - Security Information - - Once you get your OS installed, it's imperative that you secure your - installation. As Jon Griffin repeatedly warns us, "No distribution is - secure out of the box." The Reference Platform implements - some basic precautions, but security is a process, not a - condition. If you are responsible for a computer hooked to the - internet, you are responsible for learning some rudiments of - security, such as monitoring the state of a computer, - maintaining patch levels, and keeping backups. We recommend - these resources: - - - - - - Securing and Optimizing Linux - version 2.0 - - - - Jon - Griffin's notes - - - Linux Administrators - Security Guide - - - Installation - of a Secure Webserver - - - - Bruce - Schneier's Crypto-Gram, especially The - security patch treadmill and Monitoring First. - - - - - - - Resources - - - Here are some resources that OpenACS users have found useful. - - - - Books - - - - - Philip - and Alex's Guide to Web Publishing - A very readable - guide to database-backed community websites. - - - - - - UNIX - Power Tools - An excellent introduction to the - command line tools and basic programs of UNIX - - - - - - UNIX - System Administration Handbook (formerly the "red book" - - now the "purple" book) - - - - - - UNIX - System Administrator's Bible - (LePage and Iarerra 1998; - IDG) - - - - - - Running - Linux - - Learning - Gnu Emacs - - - - Linux - in a Nutshell - - - - - - - - Web Sites - - - - - The UNIX - Reference Desk - - - - - - The Linux Documentation - Project - - - - - - LPI - certification exam preps - A series of articles from - IBM developerworks on basic and intermediate Linux skills - (requires registration) - - - - - - - - - ($Id$) - - +