head	1.38;
access;
symbols
	TIGRIS_1_1_0RC2:1.37
	TIGRIS_1_1_0RC1:1.37
	TIGRIS_1_1:1.37.0.4
	TIGRIS_1_0_8:1.37
	TIGRIS_1_0_8RC3:1.37
	TIGRIS_1_0_8RC2:1.37
	TIGRIS_1_0_8RC1:1.37
	TIGRIS_1_0_7:1.37
	TIGRIS_1_0_7RC3:1.37
	TIGRIS_1_0_7RC2:1.37
	TIGRIS_1_0_7RC1:1.37
	TIGRIS_1_0_6:1.37
	TIGRIS_1_0_6RC5:1.37
	TIGRIS_1_0_6RC4:1.37
	TIGRIS_1_0_6RC3:1.37
	TIGRIS_1_0_6RC2:1.37
	TIGRIS_1_0_6RC1:1.37
	TIGRIS_1_0_5:1.37
	TIGRIS_1_0_5RC6:1.37
	TIGRIS_1_0_5RC5:1.37
	TIGRIS_1_0_5RC4:1.37
	TIGRIS_1_0_5RC3:1.37
	TIGRIS_1_0_5RC2:1.37
	TIGRIS_1_0_5RC1:1.37
	TIGRIS_1_0_4:1.37
	TIGRIS_1_0_3:1.37
	TIGRIS_1_0_2:1.37
	TIGRIS_1_0_1:1.37
	TIGRIS_1_0:1.37.0.6
	TIGRIS_1_0_0:1.37
	TIGRIS_1_0_0_RC1:1.37.0.2
	HELM_PEER_PORT_BRANCH:1.33.0.2
	TIGRIS_0_9_2_4:1.32
	TIGRIS_0_9_2_3:1.32
	TIGRIS_0_9_2:1.32.0.6
	TIGRIS_0_9_0:1.32.0.4
	TIGRIS_0_8_4:1.32.0.2
	TIGRIS_710_FF:1.32
	TIGRIS_706:1.32
	TIGRIS_705:1.32
	TIGRIS_704:1.32
	TIGRIS_703:1.32
	TIGRIS_702:1.32
	TIGRIS_701:1.32
	TIGRIS_SEP_13_2000:1.30.0.2
	TIGRIS_BASELINE:1.32;
locks; strict;
comment	@# @;


1.38
date	2001.07.23.20.07.54;	author dlr;	state Exp;
branches;
next	1.37;

1.37
date	2001.03.09.05.20.39;	author dlr;	state Exp;
branches;
next	1.36;

1.36
date	2001.02.22.22.13.06;	author dlr;	state Exp;
branches;
next	1.35;

1.35
date	2001.02.22.22.07.49;	author dlr;	state Exp;
branches;
next	1.34;

1.34
date	2001.02.22.21.16.05;	author dlr;	state Exp;
branches;
next	1.33;

1.33
date	2001.01.22.23.59.01;	author lucas;	state Exp;
branches;
next	1.32;

1.32
date	2000.09.20.19.19.51;	author kmaples;	state Exp;
branches;
next	1.31;

1.31
date	2000.09.14.02.20.32;	author ed;	state Exp;
branches;
next	1.30;

1.30
date	2000.09.13.18.33.30;	author ed;	state Exp;
branches;
next	1.29;

1.29
date	2000.09.08.17.27.07;	author kmaples;	state Exp;
branches;
next	1.28;

1.28
date	2000.09.02.17.19.50;	author ed;	state Exp;
branches;
next	1.27;

1.27
date	2000.08.22.20.03.13;	author ed;	state Exp;
branches;
next	1.26;

1.26
date	2000.08.22.00.53.59;	author dlr;	state Exp;
branches;
next	1.25;

1.25
date	2000.08.21.22.15.05;	author kmaples;	state Exp;
branches;
next	1.24;

1.24
date	2000.08.21.20.27.40;	author kmaples;	state Exp;
branches;
next	1.23;

1.23
date	2000.08.14.22.19.27;	author ed;	state Exp;
branches;
next	1.22;

1.22
date	2000.08.01.18.10.08;	author ryan;	state Exp;
branches;
next	1.21;

1.21
date	2000.07.20.20.42.59;	author dlr;	state Exp;
branches;
next	1.20;

1.20
date	2000.07.20.20.35.47;	author dlr;	state Exp;
branches;
next	1.19;

1.19
date	2000.07.20.19.27.06;	author gene;	state Exp;
branches;
next	1.18;

1.18
date	2000.07.15.00.33.04;	author dlr;	state Exp;
branches;
next	1.17;

1.17
date	2000.07.14.23.45.15;	author dlr;	state Exp;
branches;
next	1.16;

1.16
date	2000.07.14.23.05.17;	author dlr;	state Exp;
branches;
next	1.15;

1.15
date	2000.07.14.23.00.31;	author dlr;	state Exp;
branches;
next	1.14;

1.14
date	2000.07.14.19.19.19;	author dlr;	state Exp;
branches;
next	1.13;

1.13
date	2000.07.14.07.17.38;	author ryan;	state Exp;
branches;
next	1.12;

1.12
date	2000.07.13.05.38.31;	author dlr;	state Exp;
branches;
next	1.11;

1.11
date	2000.07.12.23.35.40;	author jon;	state Exp;
branches;
next	1.10;

1.10
date	2000.07.12.23.14.46;	author jon;	state Exp;
branches;
next	1.9;

1.9
date	2000.07.12.19.51.24;	author jon;	state Exp;
branches;
next	1.8;

1.8
date	2000.07.12.18.54.04;	author jon;	state Exp;
branches;
next	1.7;

1.7
date	2000.07.06.02.07.32;	author dlr;	state Exp;
branches;
next	1.6;

1.6
date	2000.06.27.03.00.50;	author jon;	state Exp;
branches;
next	1.5;

1.5
date	2000.06.13.19.59.17;	author dlr;	state Exp;
branches;
next	1.4;

1.4
date	2000.06.09.04.33.54;	author dlr;	state Exp;
branches;
next	1.3;

1.3
date	2000.06.08.16.30.11;	author dlr;	state Exp;
branches;
next	1.2;

1.2
date	2000.06.08.03.56.04;	author dlr;	state Exp;
branches;
next	1.1;

1.1
date	2000.06.07.23.07.01;	author dlr;	state Exp;
branches;
next	;


desc
@@


1.38
log
@Removed Joist reference.
@
text
@Tigris Sandbox Installation and Verification

Copyright (c) 2000-2001 CollabNet, Inc.
$Id: INSTALL,v 1.37 2001/03/09 05:20:39 dlr Exp $


[] INSTALLATION []

The following steps should get you up and running with a Tigris install on a production-type machine.  These are not instructions for use in a shared development environment.

If things don't work to your liking, please don't hestitate to fix them.  If 
this installation document does not reflect reality, please make the 
appropriate changes (or at the very least contact someone who can).


1. Verify that Apache, MySQL, swish-e, and all other required services are
installed on your target deployment machine.  The RPM's and installation instructions can be found at <http://helm.tigris.org/project_download.html>.  Use the suggested paths.

TODO: Replace this step with a bunch of RPM installs, adding network install 
instructions as well.

2. Check out the required soruces from CVS using the CVSROOT 

have an account and think that you should, email <dev@@helm.tigris.org>.  
Otherwise, you can checkout the modules as the user 'guest'.

    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs login

The path of /usr/local/tigris is used generally for production installs and that will be used in these instructions.

    cd /usr/local
    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs co -d tigris sandbox

Move into the newly created directory.

    cd tigris

Checkout the Tigris modules.

    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs co anzu eyebrowse helm tigrisinst
    

3. Edit scripts/env.sh to set the necessary environment variables.  

    SANDBOX=/usr/local/tigris
    COOKIE_DOMAIN=[the last two elements of the FQDN of the machine]
    DATABASE_NAME=tigris
    DATABASE_ADMIN_PASSWORD=[whatever the MySQL root password is]
    IZ_DATABASE_NAME=issues
    STANDARD_PORTS=true

4.  cd helm/scripts and run './install.sh'

5.  goto http://FQDN and see if it works...
@


1.37
log
@Inconsequential updates.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.36 2001/02/22 22:13:06 dlr Exp $
d40 1
a40 1
    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs co anzu eyebrowse helm joist tigrisinst
@


1.36
log
@Testing Emacs VC again
CVS: ----------------------------------------------------------------------
CVS: PR:
CVS:   If this change addresses a PR in the problem report tracking
CVS:   database, then enter the PR number(s) here.
CVS: Obtained from:
CVS:   If this change has been taken from another system,
CVS:   then name the system in this line, otherwise delete it.
CVS: Submitted by:
CVS:   If this code has been contributed to this project by someone else; i.e.,
CVS:   they sent us a patch or a new module, then include their name/email
CVS:   address here. If this is your work then delete this line.
CVS: Reviewed by:
CVS:   If we are doing pre-commit code reviews and someone else has
CVS:   reviewed your changes, include their name(s) here.
CVS:   If you have not had it reviewed then delete this line.
@
text
@d3 2
a4 2
Copyright (c) 2000 Collab.Net, Inc.
$Id: INSTALL,v 1.35 2001/02/22 22:07:49 dlr Exp $
d48 1
a48 1
    DATABASE_ADMIN_PASSWORD=whatever the root MySQL password is
@


1.35
log
@Emacs VC test
CVS: ----------------------------------------------------------------------
CVS: PR:
CVS:   If this change addresses a PR in the problem report tracking
CVS:   database, then enter the PR number(s) here.
CVS: Obtained from:
CVS:   If this change has been taken from another system,
CVS:   then name the system in this line, otherwise delete it.
CVS: Submitted by:
CVS:   If this code has been contributed to this project by someone else; i.e.,
CVS:   they sent us a patch or a new module, then include their name/email
CVS:   address here. If this is your work then delete this line.
CVS: Reviewed by:
CVS:   If we are doing pre-commit code reviews and someone else has
CVS:   reviewed your changes, include their name(s) here.
CVS:   If you have not had it reviewed then delete this line.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.34 2001/02/22 21:16:05 dlr Exp $
a54 1

@


1.34
log
@Testing CVS client.
CVS: This should not show up.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.33 2001/01/22 23:59:01 lucas Exp $
d23 1
a23 1
cvs.tigris.org:/cvs.  You will need a tigris.org CVS account.  If you do not 
d55 1
@


1.33
log
@Updated the doc to better follow the current reality.  These instructions are for building a production-type box as opposed to setting up a sandbox on a shared dev box
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.32 2000/09/20 19:19:51 kmaples Exp $
a54 1

@


1.32
log
@Added note to ignore system warning when doing a 'make' on joist.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.31 2000/09/14 02:20:32 ed Exp $
d9 1
a9 1
The following steps should get you up and running with a Tigris sandbox.
d17 1
a17 4
installed on your target deployment machine.  If you are using a shared 
Collab.Net server, this has probably already been done for you.  The RPM's and 
installation instructions can be found at 
<http://helm.tigris.org/project_download.html>.  Use the suggested paths.
a27 1
    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs co sandbox
d29 1
a29 4
If you'd like, you may move the sandbox directory to another directory
name or location; its fully specificied path will be part of the
configuration (step 3).  /usr/local/tigris is often used.  Move into the
newly created sandbox directory.
d31 6
a36 1
    cd sandbox
d40 1
a40 1
    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs co joist helm
a41 190
If you have access, you may want to checkout sourceXchange as well.  Please 
note that Helm and sourceXchange cannot currently both be installed in the 
same sandbox at once.

    cvs -d :pserver:${USER}@@projects.collab.net:/cvs login
    cvs -d :pserver:${USER}@@projects.collab.net:/cvs checkout sourcexchange

TODO: Allow Helm and sourceXchange to both be installed into the same sandbox.

3. Edit sandbox/scripts/env.sh to set the necessary environment variables.  
The provided version is moving toward a default production installation of
Tigris, so developers wishing to set up a development sandbox on our 
development server 'swallow.collab.net' will have to make a number of edits to 
this file for installation to function properly.  Likely culprits and their 
'swallow.collab.net' values are as follows:

    HOSTNAME=swallow.collab.net
    DOMAIN=swallow.collab.net
    MAIL_HOST=swallow.collab.net
    IN_PRODUCTION=false
    STANDARD_PORTS=false
    DATABASE_NAME=tigris_${UID}

TODO: Create a sourceXchange-specific version of env.sh.

4. Source sandbox/scripts/env.sh to set all of the environment variables 
you will need to configure your Tigris sandbox.  You will have to source this 
file each time you login to your sandbox.  The provided example does this for 
you after being added to your ~/.bash_profile file.

    # Tigris/sourceXchange sandbox environment
    TIGRIS_ENV=${HOME}/sandbox/scripts/env.sh
    if [ -r ${TIGRIS_ENV} ]; then
        . ${TIGRIS_ENV}
    else
        echo "Could not source ${TIGRIS_ENV}"
    fi

5. Run `sandbox/scripts/configure.pl`.  This script does substition of tokens 
in the form of '__KEYWORD__' throughout the sandbox configuration files 
(ending in '.in').

    ${SANDBOX}/scripts/configure.pl

If you'd like to install to standard ports, you'll need to make sure that the
environmental STANDARD_PORTS is set to 'true' in env.sh prior to running 
configure.pl.

6. Follow the steps outlined in the installation documentation (generally 
INSTALL) for the components that you wish to run.  Joist should be the first 
component installed, as it is generally a dependancy of other components.
  
    For Tigris see INSTALL in ${SANDBOX}/joist and ${SANDBOX}/helm

Please note: helm's INSTALL document is out of date.  Though it does have
some useful information, please do not follow the instructions in it --
just move to step 7 for it.

7. For each each module you checked out of CVS, build and install it into your 
Tigris instantiation.  

    cd ${SANDBOX}/[each module]
    make
    make install

Note that you must do this as well for bugzilla, cvsweb, and search if you
want those components to be active.

[Note: you may encounter the following error when performing 'make' in joist:

Issued 1 system warning:

*** Warning: The file "/usr/local/tigris/site/java" is not a valid directory.

This can be ignored; the 'site/java' directory is created as part of the 'make
install'.]

8. After installing all the components which should be active, run
reconfigure.pl:
    $SANDBOX/scripts/reconfigure.pl

9. Skip this step if you are sandboxing on swallow.

Create Tigris' programmatic users: tigrisa, tigrisc, tigrisq, and chown the 
user data and configuration directories installed to sandbox/data their proper 
owner.  Please note: the home directories for these users  are important (at
least, for tigrisq -- and probably for the others as well).  These directories
are currently $SANDBOX/data/helm/apache (tigrisa),
$SANDBOX/data/helm/cvs (tigrisc), and $SANDBOX/data/helm/qmail (tigrisq).

You must have sudo access to run this script.  If you don't have it 
and think that you should, contact your system administrator get it.  
Otherwise, have this step done for you.
**** DO NOT DO THIS STEP IF YOU ARE SANDBOXING ON SWALLOW ****

    ${SANDBOX}/scripts/patch_permisions

TODO: Remove the use of sudo from this script.

10. Add your Tigris database user and database.



    mysql -u root -p mysql < ${SANDBOX}/helm/sql/create_sandboxed_db.sql
    mysql -u root -p mysql < ${SANDBOX}/helm/sql/create_db_user.sql

You will also have to update the mysql metadata table.

    mysqladmin -u root -p reload

11. Initialize your new database with the Tigris schema and initial data.

    mysql -u ${DATABASE_USER} -p${DATABASE_PASSWORD} ${DATABASE_NAME} < ${SANDBOX}/joist/sql/org/joist/joist.sql

    mysql -u ${DATABASE_USER} -p${DATABASE_PASSWORD} ${DATABASE_NAME} < ${SANDBOX}/helm/sql/build_database.sql

Your ${DATABASE_NAME} environment variable is set to tigris_${USERID} by 
default.
 
12. Make sure that there is an --allow-root option in the cvs entry in 
/etc/inetd.conf for your sandbox 
(i.e. /home/jrobbins/sandbox/data/helm/cvs/repository).  If it is not in 
there, your sandbox CVS repository will not be accessible.

If you are installing on a box other than swallow, make sure /etc/inetd.conf
has an entry somewhat like the following for cvs: 

        cvspserver stream tcp nowait tigrisc /usr/sbin/tcpd /usr/bin/cvs -L --allow-root=/cvs pserver

cvspserver should have entries like the following in /etc/services:

        cvspserver      2401/tcp                # CVS client/server operations
        cvspserver      2401/udp                # CVS client/server operations

TODO: replace inetd w/ tcpserver.

13. Start your instance of Tigris server using the sandboxctl script.

    ${SANDBOX}/scripts/sandboxctl start

TODO: sandboxctl's startssl does not currently work out of the box.  The SSL 
certificate must be somehow generated by this installation process.  The 
current workaround is switching the command= option from startssl to start.

If you are working on swallow, the port number of the server is 8000 + $UID.
If we ever hit UIDs >= 2000, the configure.pl script will have to be modified
so that it picks a larger separation between Apache port and JServ port.

TODO: Add support for unix domain sockets to JServ.

14. Skip this step if you are sandboxing on swallow.

Set up control files for qmail in /var/qmail/control.  The relevant files
are rcpthosts and virtualdomains.  The domain to be used will be identified
as foo.bar (though it could have three or more parts).  Currently, an
entry in each of these files is required for each helm project which is
added; in the examples below, two projects are included, 'www' and 'core':

rcpthosts:
        foo.bar
        www.foo.bar
        core.foo.bar

virtualdomains:
        foo.bar:tigrisq
        www.foo.bar:tigrisq-www
        core.foo.bar:tigrisq-core

[] VERIFICATION []

The following steps should help you verify that your Tigris installation is 
functioning correctly.

1. Visit http://$HOSTNAME:[your port]/servlets/TLogin where your 
port = 8000 + ${UID} (i.e. 8000 + 1043 = 9043).
Login with the username 'root', and the password 'changeme'.

2. Go to the domain config servlet and check all parameter values.

TODO: Provide the URL here.

3. Add some users, check sandbox/tigrisq/.qmail-* to see progress.
You will not be able to email these users, just check the validity of
their config files.

TODO: Why won't these users be emailable (if they have valid addresses
to forward to)?

4. Add some projects, checking sandbox/tigrisc/repository, sandbox/tigrisq, 
and $SANDBOX/tigrisa/conf, and $SANDBOX/html to see progress.
d43 1
a43 2
5. To test auto-publishing functionality, do a cvs checkout as one of the 
users you created.
d45 6
a50 2
    cvs -d :pservers:${USER}@@${HOSTNAME}:/home/${USER}/sandbox/tigrisc/respository login
    cvs -d :pservers:${USER}@@${HOSTNAME}:/home/${USER}/sandbox/tigrisc/respository co [your project]
d52 1
a52 1
Publish a HTML file to the site.
d54 1
a54 5
    cd [your project]/www
    cat > index.html
    type some junk and control-D
    cvs add index.html
    cvs commit -m 'new files'
a55 1
Then browse http://${HOSTNAME}:[your portnumber]/project/$PROJECT/
@


1.31
log
@create the joist tables as well
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.30 2000/09/13 18:33:30 ed Exp $
d111 9
@


1.30
log
@add instructions to install bugzilla, cvsweb, & search (if desired);
add a step for running reconfigure.pl
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.29 2000/09/08 17:27:07 kmaples Exp $
d136 2
d146 2
@


1.29
log
@Removed reference to deprecated var in env.sh
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.28 2000/09/02 17:19:50 ed Exp $
d109 8
a116 1
8. Skip this step if you are sandboxing on swallow.
d134 1
a134 1
9. Add your Tigris database user and database.
d143 1
a143 1
10. Initialize your new database with the Tigris schema and initial data.
d150 1
a150 1
11. Make sure that there is an --allow-root option in the cvs entry in 
d167 1
a167 1
12. Start your instance of Tigris server using the sandboxctl script.
d181 1
a181 1
13. Skip this step if you are sandboxing on swallow.
@


1.28
log
@clarify certain steps:
* in step 2, note that a different directory path may be used, since
  this is our standard practice
* in step 8, describe the home directories required for the programatic
  users (important for tigrisq, at least)
* in step 11, show the contents which should be present in
  /etc/inetd.conf and /etc/services
* add a new step -- 13 -- to cover qmail setup for sandboxes off swallow
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.27 2000/08/22 20:03:13 ed Exp $
a60 1
    APACHE_HOST_IP=63.211.145.5
@


1.27
log
@document the switch from move_sandbox to configure.pl in various places.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.26 2000/08/22 00:53:59 dlr Exp $
d33 4
a36 1
Move into the newly created sandbox directory.
d110 3
a112 1
8. Create Tigris' programmatic users: tigrisa, tigrisc, tigrisq, and chown the 
d114 6
a119 1
owner.  You must have sudo access to run this script.  If you don't have it 
d149 12
d169 3
a171 3
The port number of the server is 8000 + $UID.  If we ever hit UIDs >= 2000, 
the configure.pl script will have to be modified so that it picks a larger
separation between Apache port and JServ port.
d175 1
d177 15
@


1.26
log
@Trying to differentiate between various possible values a bit more, while attempting to move towards a out-of-the-box production install.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.25 2000/08/21 22:15:05 kmaples Exp $
d148 1
a148 1
the move_sandbox script will have to be modified so that it picks a larger
@


1.25
log
@Minor changes to keep the INSTALL doc consistent with env.sh
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.24 2000/08/21 20:27:40 kmaples Exp $
d52 12
a63 8
Tigris, so developers wishing to set up a development sandbox on our development
server 'swallow' will have to make a number of edits to this file for installation
to function properly.  Likely culprits and their 'swallow' values are as 
follows:

   IN_PRODUCTION=false
   STANDARD_PORTS=false
   DATABASE_NAME=tigris_${UID}
@


1.24
log
@Updated instructions to include running of 'configure.pl' for the config of
.in files as opposed to the (depricated) script 'move_sandbox'
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.23 2000/08/14 22:19:27 ed Exp $
d51 9
a59 2
The provided version is for a default Tigris installation on our development 
server 'swallow'.  You will need to customize this to your environment.
@


1.23
log
@correct order of arguments to mysql; and add a note not to follow the
instructions in helm/INSTALL
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.22 2000/08/01 18:10:08 ryan Exp $
d69 1
a69 1
5. Run `sandbox/scripts/move_sandbox`.  This script does substition of tokens 
d73 1
a73 1
    ${SANDBOX}/scripts/move_sandbox
d75 3
a77 4
If you'd like to install to standard ports, you'll need to supply the -b 
option.

    ${SANDBOX}/scripts/move_sandbox -b
@


1.22
log
@added a comment about patch_permissions which is evil when sandboxing on swallow
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.21 2000/07/20 20:42:59 dlr Exp $
d86 4
d110 2
a111 2
    mysql mysql -u root -p < ${SANDBOX}/helm/sql/create_sandboxed_db.sql
    mysql mysql -u root -p < ${SANDBOX}/helm/sql/create_db_user.sql
d115 1
a115 1
    mysqladmin reload -u root -p
d119 1
a119 1
    mysql ${DATABASE_NAME} -u ${DATABASE_USER} -p${DATABASE_PASSWORD} < ${SANDBOX}/helm/sql/build_database.sql
@


1.21
log
@Fixed typo.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.20 2000/07/20 20:35:47 dlr Exp $
d98 1
@


1.20
log
@Cleanup.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.19 2000/07/20 19:27:06 gene Exp $
d116 1
a116 1
Your ${DATABASE_NAME} is environment variable is set to tigris_${USERID} by 
@


1.19
log
@Noted current problem w/ installing both sourceXchange and Helm at once in the same sandbox.  Must fix this soon.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.18 2000/07/15 00:33:04 dlr Exp $
a97 1
TODO: Remove the use of sudo from this script.
d101 2
d114 1
a114 1
    mysql $DATABASE_NAME -u $DATABASE_USER -p$DATABASE_PASSWORD < $SANDBOX/helm/sql/build_database.sql
d116 1
a116 1
Your $DATABASE_NAME is environment variable is set to tigris_$USERID by 
d145 2
a146 2
1. Visit http://$HOSTNAME:$PORTNUMBER/servlets/TLogin where
PORTNUMBER = 8000 + $USERID (i.e. 8000 + 1043 = 9043)
d166 2
a167 2
    cvs -d :pservers:$USER@@$HOSTNAME:/home/$YOURLOGIN/sandbox/tigrisc/respository login
    cvs -d :pservers:$USER@@$HOSTNAME:/home/$YOURLOGIN/sandbox/tigrisc/respository co $PROJECT
d171 1
a171 1
    cd PROJECT/www
d177 1
a177 1
Then browse http://$HOSTNAME:$PORTNUMBER/project/$PROJECT/
@


1.18
log
@Noted the -b option to move_sandbox.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.17 2000/07/14 23:45:15 dlr Exp $
d41 3
a43 1
If you have access, you may want to checkout sourceXchange as well.
d47 2
@


1.17
log
@' --> ", duh
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.16 2000/07/14 23:05:17 dlr Exp $
d66 2
a67 2
  in the form of '__KEYWORD__' throughout the sandbox configuration files 
  (ending in '.in').
d69 6
a74 1
    ./scripts/move_sandbox
@


1.16
log
@Hmm, the database should probably exist before we start granting
permissions to it.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.15 2000/07/14 23:00:31 dlr Exp $
d62 1
a62 1
        echo 'Could not source ${TIGRIS_ENV}'
@


1.15
log
@Added instructions for creating the Tigris database user.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.14 2000/07/14 19:19:19 dlr Exp $
d95 1
a96 1
    mysql mysql -u root -p < ${SANDBOX}/helm/sql/create_sandboxed_db.sql
@


1.14
log
@Merged in TIGRIS-SANDBOX-HOWTO written by Ryan Marsh and myself.
@
text
@d4 1
a4 1
$Id: INSTALL,v 1.13 2000/07/14 07:17:38 ryan Exp $
d93 1
a93 1
9. Make your Tigris database.
d95 1
@


1.13
log
@removed some ambiguity, added some organization and notes
@
text
@d1 1
a1 2
Sandbox Installation Document
$Id: INSTALL,v 1.12 2000/07/13 05:38:31 dlr Exp $
d3 2
a4 1
Known steps towards getting a Tigris sandbox up and running:
a5 3
1. Verify that Apache, MySQL, swish-e, and all other required components are
installed. The RPM's and installation instructions can be
found at <http://helm.tigris.org/project_download.html>  Use the same paths.
d7 1
a7 1
  TODO: Replace this step with a bunch of RPM installs.
d9 1
a9 4
2. Check out the sandbox from CVS using the CVSROOT cvs.tigris.org:/cvs.
	Ex. 
	cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs login
	cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs co sandbox
d11 25
a35 2
3. Set the necessary environment variables.  The provided example is for a 
  development installation of sourceXchange (as of June 7, 2000).
d37 1
a37 1
TODO: give defaults for a Tigris install.
d39 3
a41 41
    # Tigris/sourceXchange sandbox environment
    SANDBOX=${HOME}/sandbox
    DOMAIN=collab.net
    MAIL_HOST=projects.collab.net
    MAIL_LIST=lists.sourcexchange.com
    MAIL_ACCOUNT=mailman
    DATABASE_HOST=womb.collab.net
    DATABASE_NAME=sourcex
    DATABASE_USER=webserver
    DATABASE_PASSWORD=I8_2Much
    BRAND=sourcex
    BRANDSITE=tigris.org
    SERVLET_TEMPLATE_ROOT=${SANDBOX}/site/templates
    BRAND_TEMPLATE_ROOT=${SANDBOX}/brands/${BRAND}
    HOSTNAME=swallow.collab.net
*   USE_COOKED_TEMPLATES=true
*   HTDOC_ROOT=${SANDBOX}/data/helm/htdoc

    export SANDBOX DOMAIN MAIL_HOST MAIL_LIST MAIL_ACCOUNT DATABASE_HOST \
           DATABASE_NAME DATABASE_USER DATABASE_PASSWORD BRAND BRANDSITE \
           SERVLET_TEMPLATE_ROOT BRAND_TEMPLATE_ROOT HTDOC_ROOT \
           HOSTNAME USE_COOKED_TEMPLATES

  For people (like that silly guy Jon) who use tcsh:

    setenv SANDBOX ${HOME}/sandbox
    setenv DOMAIN collab.net
    setenv MAIL_HOST projects.collab.net
    setenv MAIL_LIST lists.sourcexchange.com
    setenv MAIL_ACCOUNT mailman
    setenv DATABASE_HOST womb.collab.net
    setenv DATABASE_NAME sourcex
    setenv DATABASE_USER webserver
    setenv DATABASE_PASSWORD I8_2Much
    setenv BRAND sourcex
    setenv BRANDSITE tigris.org
    setenv SERVLET_TEMPLATE_ROOT ${SANDBOX}/site/templates
    setenv BRAND_TEMPLATE_ROOT ${SANDBOX}/brands/${BRAND}
    setenv HOSTNAME swallow.collab.net
*   setenv USE_COOKED_TEMPLATES true
*   setenv HTDOC_ROOT ${SANDBOX}/data/helm/htdoc
d43 1
a43 19
  The env vars SANDBOX and BRAND and brand are needed during builds of the 
  software, so make sure that they persist after installation.
 
* If you are doing sourcex, set HTDOC_ROOT to $SANDBOX/site/html
  If you are doing helm, you have to do a make install
  in $sandbox/helm/data that will copy initial versions of the 
  tigris-controlled config files to $sandbox/data/helm/apache.  Set 
  USE_COOKED_TEMPLATES to false if you're doing helm...it's not yet 
  compatible with the template-cooker.

4. Move into your sandbox directory.

    cd $SANDBOX

  Check out whatever additional components that you wish to install.

  For a Tigris instance:
    cvs -d :pserver:${USER}@@cvs.tigris.org:/cvs checkout joist helm
  For a SourceXchange instance (requires above):
d46 22
a67 2
5. Run the move_sandbox script--it will rejigger the paths and ports for your 
  user.  Your working directory should still be your sandbox directory:
d72 2
a73 2
  INSTALL) for the components that you wish to run.  Joist should be the first 
  component installed, as it is generally a dependancy of other components.
d77 19
a95 1
7. (opt) For sourcex: Execute the generateStats scripts
d97 1
a97 1
    cd ${SANDBOX}/site/sql; ./generateStats
d99 1
a99 1
8. Start the server using the sandboxctl script.
d101 1
a101 1
    ./scripts/sandboxctl start
d103 21
a124 3
The port number of the server is 8000 + $UID. If we ever hit UIDs >= 2000, the 
move_sandbox script will have to be modified so that it picks a larger
separation between Apache port and jserv port.
d127 40
a166 3
If things don't work to your liking, please don't hestitate to fix them.  If 
this installation document does not reflect reality, please make the 
appropriate changes (or at the very least contact someone who can).
@


1.12
log
@Added USE_COOKED_TEMPLATES
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.11 2000/07/12 23:35:40 jon Exp $
d6 4
a9 2
- Verify that Apache, MySQL, swish-e, etc. are installed.  They're available 
  from <http://helm.tigris.org/project_download.html>.  Use the same paths.
d12 4
a15 1
- Check out the sandbox from CVS using the CVSROOT cvs.tigris.org:/cvs.
d17 1
a17 1
- Set the necessary environment variables.  The provided example is for a 
d20 2
d74 1
a74 1
- Move into your sandbox directory.
d80 1
d82 1
d85 1
a85 1
- Run the move_sandbox script--it will rejigger the paths and ports for your 
d90 1
a90 1
- Follow the steps outlined in the installation documentation (generally 
d93 2
d96 1
a96 1
- For sourcex: Execute the generateStats scripts
d100 1
a100 1
- Start the server using the sandboxctl script.
@


1.11
log
@document generateStats wisdom
PR:
Obtained from:
Submitted by:
Reviewed by:
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.10 2000/07/12 23:14:46 jon Exp $
d30 1
d36 1
a36 1
           HOSTNAME
d53 2
a55 1
    setenv HOSTNAME swallow.collab.net
d63 3
a65 1
  tigris-controlled config files to $sandbox/data/helm/apache
@


1.10
log
@added hostname env variable

PR:
Obtained from:
Submitted by:
Reviewed by:
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.9 2000/07/12 19:51:24 jon Exp $
d80 4
@


1.9
log
@another bit of wisdom from jason for setting the HTDOC_ROOT variables
correctly.
PR:
Obtained from:
Submitted by:
Reviewed by:
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.8 2000/07/12 18:54:04 jon Exp $
d29 1
d34 2
a35 1
           SERVLET_TEMPLATE_ROOT BRAND_TEMPLATE_ROOT HTDOC_ROOT
d53 1
@


1.8
log
@could someone please fill in these new env variables with default values
so that i can setup a new sandbox?

also, in the future, if you add a new env variable please DOCUMENT IT! :-)
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.7 2000/07/06 02:07:32 dlr Exp $
d26 4
a29 5
    BRANDSITE=FIXME: WHAT GOES HERE?
    SERVLET_TEMPLATE_ROOT=FIXME: WHAT GOES HERE?
    BRAND_TEMPLATE_ROOT=FIXME: WHAT GOES HERE?
    HTDOC_ROOT=FIXME: WHAT GOES HERE?
    SITE_ROOT=FIXME: WHAT GOES HERE?
d32 2
a33 1
           DATABASE_NAME DATABASE_USER DATABASE_PASSWORD BRAND
d47 4
a50 5
    setenv BRANDSITE FIXME: WHAT GOES HERE?
    setenv SERVLET_TEMPLATE_ROOT FIXME: WHAT GOES HERE?
    setenv BRAND_TEMPLATE_ROOT FIXME: WHAT GOES HERE?
    setenv HTDOC_ROOT FIXME: WHAT GOES HERE?
    setenv SITE_ROOT FIXME: WHAT GOES HERE?
d54 5
@


1.7
log
@Reformatted to match existing layout.
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.6 2000/06/27 03:00:50 jon Exp $
d26 5
d47 5
@


1.6
log
@added instructions for tcsh
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.5 2000/06/13 19:59:17 dlr Exp $
d30 1
a30 1
For people (like that silly guy Jon) who use tcsh:
d32 10
a41 10
setenv SANDBOX ${HOME}/sandbox
setenv DOMAIN collab.net
setenv MAIL_HOST projects.collab.net
setenv MAIL_LIST lists.sourcexchange.com
setenv MAIL_ACCOUNT mailman
setenv DATABASE_HOST womb.collab.net
setenv DATABASE_NAME sourcex
setenv DATABASE_USER webserver
setenv DATABASE_PASSWORD I8_2Much
setenv BRAND sourcex
@


1.5
log
@Noted that Joist is a dependancy of most components, so should be
installed first.
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.4 2000/06/09 04:33:54 dlr Exp $
d29 13
@


1.4
log
@Noted env vars that need to persist past sandbox installation.
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.3 2000/06/08 16:30:11 dlr Exp $
d47 3
a49 2
- Follow the installation steps for the components that you wish to run (as 
  outlined in their installation documentation).
@


1.3
log
@Informed that JServ currently doesn't run off UNIX domain sockets.
Changed HELP to TODO.
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.2 2000/06/08 03:56:04 dlr Exp $
d29 3
@


1.2
log
@Added braces to an env var in one of the examples.
@
text
@d2 1
a2 1
$Id: INSTALL,v 1.1 2000/06/07 23:07:01 dlr Exp $
d55 1
a55 1
HELP: Can JServ run off of a unix domain socket?
@


1.1
log
@Sandbox installation document--a rough draft.
@
text
@d2 1
a2 1
$Id: $
d16 1
a16 1
    SANDBOX=$HOME/sandbox
@

