--- projects/cms/source/server/README 2000/12/12 21:10:28 1.3.2.2 +++ projects/cms/source/server/README 2001/01/22 03:02:37 1.8 @@ -1,21 +1,94 @@ -i-scream Server Startup -======================= +i-scream Server README +====================== -Recommended startup sequence of components: +Compiling +--------- +The server can now easily be compiled without worrying about setting up any +of the CLASSPATH's, or setting the path to JacORB. It's all self contained. + +Typical sequence to compile; + +./configure +make build +make install prefix=/some/path +make clean + +In more detail, the first line ensures that the required libraries are +available, and sets the Makefiles up so they know where everything is. +The second line compiles all of the code and creates a JAR file in the +build directory. +The install line installs the server and libraries to a given location, +along with the configuration files. +Finally, the last line cleans up. + +Running +------- + +It is recommended that the components are started up in the following order. + +(This can be on multiple hosts if required, as long as the order is correct). + Core ClientInterfaceMain -DBInterfaceMain +DBInterface FilterManager -RootFilterMain +RootFilter FilterMain -It is not necessary to start both the ClientInterfaceMain and DBInterfaceMain, -the server will handle only one. Multiple Filter's can be started as required. +It is not necessary to start both the ClientInterfaceMain and DBInterface, +the server will handle only one or both. Multiple Filter's can be started +as required. These are all loaded through the ComponentManager. More details on how to operate this will be provided later on. Typing "make run" will make an attempt to load it up. +Check build/etc/default.properties to set the startup list and order. + nb. You will need to ensure that the relevant libraries are in the build/lib directory. See the README in there for details. + +Makefile +======== +The following targets are available; + +build + + Compile the entire server package, include the IDL file. Generates the + JAR file for the final package. + +run + + Run's the server from the JAR file in /build. + +clean + + Cleans all compiled code, and javadoc pages. + +distclean + + Also cleans files left by configure, including the libraries. + +install + + Installs the server to a given directory. Also takes a prefix; + make install prefix = /usr/i-scream + +cvsbuild + + Builds any tagged version of the server from CVS. This saves the need to + checkout a version to build it, as it's all done automatically; + make install rev = RELEASE_1 + Default tag is HEAD. + +javadoc + + Builds all the javadoc pages in the `doc' directory. + +buildutil + + (it is recommended you run a "make clean" first) + Builds a seperate JAR file, in `build' called `iscream-util.jar'. + This file contains just the uk.ac.ukc.iscream.util package for + use in other parts of the system, such as the clients.