/BriefCase Quick-Start Installation --------------------------------------- Release 3.5 establishes a new directory infrastructure to support concurrent installation and use of multiple releases of /BriefCase and, thus, to facilitate installation and testing of new releases prior to full deployment. In addition, advanced configuration features support sharing of multiple repositories and geographically diverse repository "mirrors" for high-availability. These instructions assume the installation of the default configuration (server and client on the same host) from a /BriefCase distribution on CDROM. If you download the tarball from our website, you will need to untar it into a temporary directory and use directory in place of "/mnt/cdrom" in the sample commands. If you have questions or need assistance, send email to: BriefCase@applied-cs-inc.com ----------------------------------------------------------------------------- For a new installation (i.e. the first time /BriefCase is installed), login as root and: 1 - System administration tasks: - Add the group "BCadmin" to /etc/group (may need to be done with a manual edit if your admin tools does not handle group names with upper-case letters properly. - Add the user bcadmin, primary group BCadmin. 2 - On the /BriefCase server host, create a directory tree to contain /BriefCase installations and cd into it, e.g.: mkdir -p /opt/BCase cd /opt/BCase 3 - Mount the /BriefCase 3.5 Distribution CD and extract the /BriefCase files: tar xvzf /mnt/cdrom/BriefCase-3.5.tgz or, if your tar command does not support the "z" flag for unzipping gzip'd files, use the gzip command with the -d flag: gzip -d < /mnt/cdrom/BriefCase-3.5.tgz | tar xvf - This will install the /BriefCase distribution in its own subdirectory, e.g.: /opt/BCase/BriefCase-3.5 4 - Change the ownership and group of the installation tree to bcadmin with the command: chown -R bcadmin /opt/BCase/BriefCase-3.5 then cd into the new installation and run the "set_admins" script to restrict administrative script use to members of the BCadmin group: cd /opt/BCase/BriefCase-3.5 ./set_admins 5 - Make a symbolic link from the installation directory to /BriefCase, e.g.: ln -s /opt/BCase/BriefCase-3.5 /BriefCase 6 - While operating systems other than Solaris 2.x may not provide the "nawk" (new awk) program, per se, the awk program may be the equivalent of the new awk. Use the "/BriefCase/checkNawk" command to determine the status of nawk your server and client system(s) and suggest solutions if nawk or an equivalent program is not available. 7 - Choose which filesystem is to contain the /BriefCase repository (preferably one that is backed up on a regular basis) and therein create a group-writable directory named "projRCS", owned by the bcadmin user with group BCadmin: /bin/mkdir -p /export/projRCS /bin/chown bcadmin:BCadmin /export/projRCS /bin/chmod 775 /export/projRCS Create a symbolic link for it to /projRCS, e.g.: ln -s /export/projRCS /projRCS 8 - Choose which filesystem is to contain the /BriefCase staging area. Therein, create a directory named "Stage/home" in it, e.g. /export/Stage/home, make it world writable and create a symbolic link for /export/Stage to /Stage, e.g.: /bin/mkdir -p /export/Stage/home chmod 777 /export/Stage/home ln -s /export/Stage /Stage Refer to the Installation and Customization chapter of the Reference and User's Guide in the /BriefCase/docs directory for details regarding the steps outlined above or for more about how to customize an installation for your specific client/server configuration or to meet other requirements. The /BriefCase User's Guide and Reference is contained in the book.* files. The book.ps file may be viewed with ghostview or imagetool (Solaris) or printed (170+ pages, including table of contents and index) on a PostScript printer. The book.pcl file can be printed directly on an HP LaserJet printer and the book.txt file can be viewed with a text editor. ------------------------------------------------------------------- A Testing Milestone for the Default Installation. ------------------------------------------------------------------- To test the default (stand-alone) installation, login as the "bcadmin" user (assumed to be a Bourne/Korn/BASH shell user) and connect to /BriefCase with the "dot" (.) command: . /BriefCase/BC.profile If you created the "bcadmin" user as a C-Shell user, use the "source" command: source /BriefCase/BC.login The resulting /BriefCase banner should contain lines like: ... Using /BriefCase(tm) Rev 3.5 installed at: /BriefCase` ... Client: dellbk.acsi.com CPU: x86 OS: linux BCServer: acsidev2.acsi.com CPU: i586 OS: Linux ... identifying the host name, CPU type and OS of the client and server hosts. If it does not, there is am installation or configuration problem and /BriefCase is unlikely to work properly until the it is resolved. Refer to the Installation section of the /BriefCase User's Guide. If the banner seems to be correct, the basic installation and default configuration are correct. To complete the installation, login as the root user again. 1 - Generate the /BriefCase manpages with the command: /BriefCase/.tools/gen_manpages 6 - Determine which releases of diff and rcs are installed on your system by entering the commands: diff -v # shld display "diff - GNU diffutils version 2.7" rcs -V # shld display "RCS version 5.7" to display their respective version info. If your system does not have the GNU diffutils version 2.7 and RCS version 5.7 installed, your will need to build and install them from the /BriefCase/GNU diff-2.7 and rcs-5.7 directories. The detailed procedure is in the /BriefCase book, but here is a synopsis which should get you started (on a Linux system, at least. NOTE that the procedure below DEPENDS on the "connection to /BriefCase" (step 4, above) for proper settings of $CPU and $OS for your system. If $CPU and $OS are not set properly, these steps WILL NOT WORK! To build the diff-2.7 utilities: 1 - cd /BriefCase/GNU/diff-2.7 2 - INSTALL=/bin/cp configure --prefix=/BriefCase/$CPU/$OS/bin 3 - make install To build the RCS-5.7 utilities: 1 - cd /BriefCase/GNU/rcs-5.7 2 - INSTALL=/bin/cp configure --prefix=/BriefCase/$CPU/$OS/bin 3 - edit the generated file "./src/Makefile" and change the line: bindir = $(exec_prefix)/bin to bindir = $(exec_prefix) NOTE: if you rerun the configure step, you must re-edit the generated ./src/Makefile 4 - make install If you do not have a C compiler and make capability, contact us via email at briefcase@applied-cs-inc.com and we will help you obtain and install suitable binaries for your system. Assuming you have the proper RCS and diff binaries installed, you should be able to run the /BriefCase test suite: 1 - Login as a non-root user (e.g. bcadmin) and create a "testing" subdirectory under $HOME. Connect to /BriefCase with the command: . /BriefCase/BC.profile # for Bourne/Korn/BASH or source /BriefCase/BC.login # for C-Shell 2 - Copy the /BriefCase test scripts into $HOME/testing and cd to $HOME/testing: cp /BriefCase/testing/* $HOME/testing cd $HOME/testing The tests will be run in the $HOME/testing directory. 3 - Examine the test_defines file to to be sure that "GRP" is set to a known group, of which the current userid is a member. The distributed test_defines recognizes the Solaris (SunOS), Linux and FreeBSD operating systems but may need to be modified for other OSs. 4 - Run a full test by entering the command: "reg_test" 5 - If there are any failures (look for the work "FAIL" in the reg_test.log file), tar up the *.log files and email them to with a description of your installation. I will try to suggest a cause and/or solution. For a full client/server installation, the /Stage and /BriefCase directories need to be exported from the server host (read-write and readonly, respectively) and mounted on the client host(s). The /projRCS filesystem (the /BriefCase repository) should NOT be exported. For server/client host configuration and testing details, please refer to the /BriefCase 3.5 User's Guide and Reference found in the /BriefCase/docs directory. ----------------------------------------------------------------------------- HOW TO Upgrade from a previously installed release of /BriefCase 1 - Ensure that the directory into which you are about to install is different from the directory in which your current release of /BriefCase is installed and follow the new installation steps (above). 2 - Edit the new BCconfig and host.setup files to reflect local customizations made to those files in the old installation If you have customized BCconfig to account for client host differences (architecture, OS, printers etc.) those changes should be migrated to files named for each client host in the /BriefCase/profiles directory. Use the /BriefCase/profiles/default file as a template for host profile(s). 3 - Copy your installation's client-host profiles from /BriefCase/profiles to new installation's profiles directory. 7 - Test the new installation by running the regression test suite and evaluating the results as described above. If you would like more in-depth training in or consulting services covering any aspect of SCM using /BriefCase, please detail your desires and/or requirements via email to: admin@applied-cs-inc.com Thanks for considering /BriefCase as your Software Configuration Management system!