[ViewVC] Annotation of: i-scream/projects/cms/source/server/README

i-scream Server README
======================

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
DBInterface
FilterManager
RootFilter
FilterMain
Client

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.

createtable

  Creates the ipacket table in the mySQL database. This is required for
  the database side of the server.

droptable

  Drops an ipacket table from the mySQL database if one exists.
Revision:	1.9
Committed:	Wed Mar 14 22:45:07 2001 UTC (24 years, 7 months ago) by tdb
Branch:	MAIN
CVS Tags:	PROJECT_COMPLETION
Changes since 1.8:	+10 -0 lines
Log Message:	Added details about the database Makefile.
#	User	Rev	Content
1	tdb	1.6	i-scream Server README
2			======================
3	tdb	1.1
4	tdb	1.6	Compiling
5			---------
6
7			The server can now easily be compiled without worrying about setting up any
8			of the CLASSPATH's, or setting the path to JacORB. It's all self contained.
9
10			Typical sequence to compile;
11
12			./configure
13			make build
14			make install prefix=/some/path
15			make clean
16
17			In more detail, the first line ensures that the required libraries are
18			available, and sets the Makefiles up so they know where everything is.
19			The second line compiles all of the code and creates a JAR file in the
20			build directory.
21			The install line installs the server and libraries to a given location,
22			along with the configuration files.
23			Finally, the last line cleans up.
24
25			Running
26			-------
27
28			It is recommended that the components are started up in the following order.
29
30			(This can be on multiple hosts if required, as long as the order is correct).
31	tdb	1.1
32	tdb	1.4	Core
33			ClientInterfaceMain
34	tdb	1.6	DBInterface
35	tdb	1.4	FilterManager
36	tdb	1.6	RootFilter
37	tdb	1.4	FilterMain
38	tdb	1.9	Client
39	tdb	1.1
40	tdb	1.6	It is not necessary to start both the ClientInterfaceMain and DBInterface,
41			the server will handle only one or both. Multiple Filter's can be started
42			as required.
43	tdb	1.1
44	tdb	1.4	These are all loaded through the ComponentManager. More details on how to
45			operate this will be provided later on. Typing "make run" will make an
46			attempt to load it up.
47	tdb	1.1
48	tdb	1.6	Check build/etc/default.properties to set the startup list and order.
49
50	tdb	1.4	nb. You will need to ensure that the relevant libraries are in the
51			build/lib directory. See the README in there for details.
52	tdb	1.5
53			Makefile
54			========
55			The following targets are available;
56
57			build
58
59			Compile the entire server package, include the IDL file. Generates the
60			JAR file for the final package.
61
62			run
63
64			Run's the server from the JAR file in /build.
65
66			clean
67
68			Cleans all compiled code, and javadoc pages.
69
70			distclean
71
72			Also cleans files left by configure, including the libraries.
73
74			install
75
76			Installs the server to a given directory. Also takes a prefix;
77			make install prefix = /usr/i-scream
78
79			cvsbuild
80
81			Builds any tagged version of the server from CVS. This saves the need to
82			checkout a version to build it, as it's all done automatically;
83			make install rev = RELEASE_1
84			Default tag is HEAD.
85
86			javadoc
87
88			Builds all the javadoc pages in the `doc' directory.
89	tdb	1.7
90			buildutil
91
92	tdb	1.8	(it is recommended you run a "make clean" first)
93	tdb	1.7	Builds a seperate JAR file, in `build' called `iscream-util.jar'.
94			This file contains just the uk.ac.ukc.iscream.util package for
95			use in other parts of the system, such as the clients.
96	tdb	1.9
97			createtable
98
99			Creates the ipacket table in the mySQL database. This is required for
100			the database side of the server.
101
102			droptable
103
104			Drops an ipacket table from the mySQL database if one exists.