THE BIG BROTHER SYSTEM AND NETWORK MONITOR
==========================================
Version 1.9c
May 15th, 2002

(c) Copyright Quest Software, Inc.  1997-2002  All rights reserved.

If you're new to BB, we suggest that you  subscribe to the
BB mailing list.  To do so, follow these instructions:

Send an e-mail to MajorDomo@bb4.com
In the body of the e-mail message (not the Subject line),
place the statement: 

    subscribe bb 


We have searchable archives of the mailing list available
at http://support.bb4.com.  Thanks to Nick Silberstein
for initially creating and housing it.

When you have finished installing BB on all of your
monitored hosts, you might want to check out the FTP archive
that contains many contributed scripts.  Adam Goryachev
house them at ftp://ftp.deadcat.net/pub/BB or
http://www.deadcat.net/

Sans '98 & '99 presentations are available at
http://bb4.com/propaganda.html.  These presentations
may fill in some details.

Really Quick and Dirty Install Procedure for Big Brother
========================================================

WARNING: For security reasons, it is best to install and run
	 BB as its own user and not as root.  (but use the
	 root account during the install process, at the end
	 you'll change ownership to the chosen BB user ID)
	 

*** READ THE README.SECURITY FILE BEFORE PROCEEDING ***

You've extracted the BB archive and this is the directory
structure that was created:

bb<version>/                  (i.e.  bb18d/) referred as $BBHOME
bbvar/acks/                   referred as $BBACKS
     /data/                   referred as $BBATA
     /disabled/               referred as $BBDISABLED
     /hist/                   referred as $BBHIST 
     /histlogs/               referred as $BBHISTLOGS
     /logs/                   referred as $BBLOGS

1.      cd bb<version>        (i.e.: cd bb18d)
	This directory is often refered as BBHOME or $BBHOME
        cd ./install
        ./bbconfig &lt;OS-NAME&gt;
        where OS-NAME is  bsdi sco3 sco freebsd solaris hpux9 hpux
                                linux sunos netbsd osf ultrix irix
                                unixware redhat aix dynix debian dgux
				caldera mandrake
        Note that &lt;OS-NAME&gt; is optional, BB will try to figure it out.

        If you are running Linux you may have to provide the proper 
                distribution name:

		./bbconfig redhat
		./bbconfig debian
		./bbconfig caldera
		./bbconfig mandrake
		./bbconfig linux

	./bbconfig will ask you questions about your setup
	be ready with:
                BBHOME: directory where BB resides
                        (usually the choice given by BB is correct)
		If the old-style structure be kept 
		If you intend to use FQDN(Fully qualified domain names)
		Which host(s) is(are) the BBDISPLAY(s)
		Which host(s) is(are) the BBPAGER(s)
		If the current host is a BBDISPLAY/BBPAGER
		Default e-mail recipient for notification
		URL you intend to view BB with
		URL of the BB CGI scripts
		The user id of your web server 


2.	cd ../src
	type "make"
	then type "make install"

	If you have trouble compiling, refer to the README file
	located at src/README

	for those who are upgrading then go to "Upgrading BB" section

3.	cd ../etc

	edit bb-hosts, put your hosts names in there.  Refer to install/README.
	This is the core of Big Brother.  You must read the docs here.
	edit bbdef.sh, set alarm levels and things.  If you want to use
	fully qualified domain name hosts then make sure you set FQDN=TRUE
	in etc/bbdef.sh.  If this is the first host you install and intend
	to use it as the display/notification server as well as the server
	that test the network services then your bb-hosts should contain
	this line:

	xxx.xxx.xxx.xxx	this.host.name	# BBDISPLAY BBPAGER BBNET


4.	./bbchkcfg.sh
	Checks the bbdef.sh/bbinc.sh/bbsys.sh source scripts for invalid entries
	./bbchkhosts.sh
	Checks the bb-hosts file for errors

5.	cd ../..
	ln -s <bbdir> bb	where <bbdir> is the new version directory (e.g. bb18d)

	This is useful as you don't have to change the directory in your
	startup script. (see section 11)

        cd bb
        chown -R bbuser .       where bbuser is the user you defined 
                                in the install process. This makes sure
                                that the bbuser can write/read into
                                the BB directory sttructure as you will
                                probably install while in the root account

	cd ..
	chown -R bbuser bbvar

6.      ln -s /full_path_to_bb/www /WWW/bb (where /WWW is the Document Root dir).
        Make sure the permissions are correct.  Configure your web server
        for this directory if need be.
	Also make sure that your web server follows symbolic links
	Note: use the location of the bb link in step 5)

7.	cd <bbdir>		where <bbdir> is the new version directory (e.g. bb18d)
	or
	cd <bb>			where <bb> is the directory link you created in
				section 5
	./runbb.sh start
	examine the BBOUT file for any errors. By default the BBOUT log file
	is located in $BBHOME.  The location of BBOUT is defined by the value
	of the BBOUT variable in bbdef.sh

	NB The HTML summary pages (bb.html/bb2.html) should be available
	2 minutes after the startup.  Don't panic the'll be there if
	you are patient. In your browser, you should be able to
	see the results at http://yourwebhost/bb/ or
	http://yourwebhost/bb/bb.html  (assuming you used /bb as BB URL root)

8.	Debug, and look at all the docs.

9.	Check the online documentation!  It lives under:
	http://bb4.com/bb/help/bb-help.html

10.	This will have enabled you to have a display/pager server set up.
	At this point no clients are running.  When you have all of
	your hosts defined in etc/bb-hosts then
	use install/bbclient to create a tarball for BB clients of the same
	OS/HW type.  If you have different OS/HW platforms then
	reinstall BB on each one (then use the bbclient to create a tarball
	for each identical OS/HW client) and don't forget to copy your master
	bb-hosts file to it. Run through the install procedure to make
	sure that the clients are also installed properly(bbchkcfg.sh/bbchkhosts.cfg)

11.	If you wish to start BB automatically at startup, we suggest the
	following command in your startup script:

	su - <bbuser> -c "cd <BBHOME>;./runbb.sh start"

	<bbuser> is the user you chose at install
	<BBHOME> is the target directory in which BB was extracted
		 or where you've created the bb directory link
		 as per section 5. e.g. bb18d


For the Web Stuff
=================

All Web-based things live in the www directory.  In order for the bb
stuff to work correctly, this directory must be linked into your Web
site somewhere.  I suggest something like the following(this should have
been done in step 6):

ln -s /home/sean/bb/www /WWW/bb (where /WWW is the Document Root dir).

You should then be able to access BB with the URL http:/bb/bb.html


For the Pager Stuff
===================

You need kermit and a mode(s).  It should be working...

1.	Edit etc/bbsys.sh and define the variables
	KERMIT (where kermit lives) and MAIL (with flag for
	subject header) if they are not defined in bbsys.local
	generated during the configuration.  Note that qpage
	and sendpage should be considered for paging.

	If you're using SMS paging (mainly Europe) read Jacob's
	readme: install/README.SMS

2.	For the notification configuration, please customize the
	etc/bbwarnsetup.cfg file  and the etc/bbwarnrules.cfg file.
	Also consult the online help.

3.	For Web-based paging/acknowlegement,  web/bb-ack.sh should have
	been installed by ./install/bbconfig

	THIS STEP IS ONLY IF SOMEBODY CLICKS ON THE "PAGE/ACK"
	BUTTON OF bb.html/bb2.html . THE REAL PAGING/EMAIL/SMS
	NOTIFICATION IS TAKEN CARE BY STEP 2.


Upgrading BB
============

If you are upgrading from a previous version then do these steps after
the preliminary install of BB:

If your previous version of BB was pre-1.5 then follow these next steps
otherwise jump to "Upgrading BB (Part 2)"

We assume that the BBVAR/BBLOGS/BBHIST/BBHISTLOGS/BBDATA/BBDISABLE
modified in $BBHOME/etc/bbinc.sh.

cd BBTOP/bbvar  (BBTOP is where you unpacked BB)
rm -f logs acks hist histlogs notes data disabled
mv OLDBBHOME/www/logs .
mv OLDBBHOME/www/acks .
mv OLDBBHOME/www/hist . 
mv OLDBBHOME/www/histlogs .
mv OLDBBHOME/www/data .
mv OLDBBHOME/disabled . 

Upgrading BB (Part 2)
=====================

cd <bbdir>	where <bbdir> is the directory of the new install
cd www
rm -r notes
# Replace OLDBBHOME by the full path of BBHOME defined in your previous install
mv OLDBBHOME/www/notes .
cd ..
cd ext				If you have external scripts
cp OLDBBHOME/ext/* . 		Only copy the ones you created !!!
				Don't overwrite the scripts distributed
cp OLDBBHOME/ext/hist/* hist/
cp OLDBBHOME/ext/rep/* rep/
cp OLDBBHOME/ext/mkbb/* mkbb/	Only copy the ones you created !!!
				Don't overwrite the scripts distributed
cp OLDBBHOME/ext/pg/* pg/	Only copy the ones you created !!!
				Don't overwrite the scripts distributed
				(This directory is new in BB 1.6)
copy anything else in there (lardd,the state,...) to here

cd ..
cd etc
cp OLDBBHOME/etc/bb-hosts .		Depending of your current setup
cp OLDBBHOME/etc/bbwarnrules.cfg .	copy and edit appropriate config files
cp OLDBBHOME/etc/bbwarnsetup.cfg .	Run diff between old file and new
cp OLDBBHOME/etc/bb-dftab .		file as format may have been changed
cp OLDBBHOME/etc/bb-proctab .
cp OLDBBHOME/etc/bb-cputab .
cp OLDBBHOME/etc/bb-msgstab .
cp OLDBBHOME/etc/bb-bbexttab .
cp OLDBBHOME/etc/security .

vi bbdef.sh			Set environment variables for your setup
vi bbinc.sh

cd ../..
# if you already have a link called bb used to access your BB install
rm bb
ln -s <bbdir> bb		Setup bb as a link to the new bbdir
				directory such that it's easier
				to refer rc scripts to bb/ without
				having to change them every time
				you upgrade.

If you have special changes that you have incorporated into BB
then it is the time to carry them over now.


Have fun.
--
Sean MacGuire					info@bb4.com
http://bb4.com
