CollabNet Enterprise Edition

(Free Download Readme.html)

CollabNet Enterprise Edition (CEE) provides a collaborative development environment where globally distributed project members can work as one team throughout the lifecycle of a project. This special "Free Download" offering, valid for use by up to fifteen users, lets you deploy and use CollabNet Enterprise Edition behind your company's firewall.

Additional users above 15 may be added for a small incremental per-user fee. More information on this is available on www.collab.net/products and is also available for purchase through the "Buy Now" button on www.collab.net.

Contents

1. Prerequisites

Hardware

The hardware required for installing CollabNet Enterprise Edition is as follows:

For best practices, consider the following recommendations:

• Hot swap backup server – maintained for any mission critical application.
• Test or stage server – to test patches and practice upgrade process.
• Net Application storage server – for live backup process.

Operating System

A complete installation of the Red Hat Enterprise Linux ES release 3 (Taroon Update 6) operating system is required. You must perform the installation on a clean system.

Important: The server must be dedicated to the CollabNet Enterprise Edition installation.

[TOC]

2. Supported Browsers

These are the recommended and tested browsers. Others may work, but have not been tested with this version of the software.

• Internet Explorer 6.0 for Windows with Service Pack 2
• Firefox 1.5.1 for Windows and Linux

[TOC]

3. Defining the hostname

Before installing CollabNet Enterprise Edition, you must define a hostname for the server.

Follow these steps to define the hostname:

1. Edit the /etc/hosts file and add an entry for the IP address and hostname of the server where you are installing CollabNet Enterprise Edition, as follows:

   [IP address] [hostname]

   Example:
   1.2.3.4 abc.collab.net

2. Run this command to verify the hostname:

   hostname

   For the example, the result would be abc.collab.net.

[TOC]

4. Configuring the DNS

CollabNet Enterprise Edition requires DNS for most operations to specify which project is being accessed. Each new project name that gets created within the CollabNet Enterprise Edition domain is prepended to the domain URL to make a subdomain automatically accessible upon project creation. For example, when you create a new project named "networking" in the "collabnet.yourcompany.org" domain, you are immediately redirected to the URL "networking.collabnet.yourcompany.org". For this, you must have a DNS entry for the new URL pointing to the domain's IP address.

The most direct way to accomplish this is with a wildcard DNS entry, similar to the following, in the named zone file (for example, /var/named/db.yourcompany.org):

; Canonical name
collabnet.yourcompany.org     IN      A       1.2.3.4

; Wildcard
*.collabnet.yourcompany.org   IN      A       1.2.3.4
  

Note: The wildcard must be an A record.

Workarounds

If the DNS host is not configured for wildcards, workarounds are available, but require more administrative oversight and maintenance.

You can use either of these alternatives:

• Modify the /etc/hosts file on each client system that connects to the CollabNet Enterprise Edition host, with a unique entry for each project pointing to the IP address of the host.
  For example, edit the /etc/hosts or c:\windows\system32\drivers\etc\hosts file as follows:

  127.0.0.1	localhost	localhost.localdomain
  1.2.3.4		collabnet.yourcompany.org www.collabnet.yourcompany.org cvs.collabnet.yourcompany.org
  1.2.3.4		networking.collabnet.yourcompany.org 

• Place a new entry in the named zone file for each project, pointing it to the IP address of the CollabNet Enterprise Edition host.

Notes:

• The entries must be in place prior to creating CEE projects.
• The project names referenced in the /etc/hosts file or named zone file must be syntactically the same as the project names that are subsequently created.

Until these considerations are satisfied, projects can be created but will remain unusable.

[TOC]

5. Installing CollabNet Enterprise Edition

To install CollabNet Enterprise Edition you need to download the installer script, edit the configuration file and run the setup script.

Important: Before proceeding with the installation make sure that you have defined the hostname for your server. Perform the installation as the root user.

Follow these steps to install:

1. Log in to your system as the root user.
2. Download the wrapper script from the openCollabNet site.
   • To download using the command line, enter this command:

     wget http://open.collab.net/files/documents/Onsite-Installer.zip

   • To download using a browser, follow these steps:
     1. Click the "Download Now" link for the free download offering for up to fifteen users.
     2. Save the script.
3. Unzip the script with this command:

   unzip Onsite-Installer.zip

   The files onsite.conf, copyright.txt, license.txt, setup.sh, installer.py, site-options.conf, onsite-sanity-check.sh and req_pkg.list are extracted to the Onsite-Installer directory.

4. Set the DOMAIN token in the site-options.conf file to the one of the following values:
   • the domain name of your site which has a valid DNS entry
   • the hostname that you defined prior to the installation
5. You can use the onsite.conf file to customize the installer. The installation requires a number of Open Source software packages. By default, the installer downloads them for you from their respective websites. However, you can edit the onsite.conf file so that the installer gets these packages from other locations. Please see the section on Editing configuration options for details.
   

   Note: This step is optional.

6. Change to the directory containing the extracted files, as follows:

   cd [Onsite-Installer]

7. Invoke the setup script with this command:

   ./setup.sh

8. Respond to the CollabNet and Java licensing terms and conditions.

   When you accept the licensing terms and conditions, the installer.py script gets invoked and does the following:

   • Downloads and unpacks two installation tarballs - one for the Open Source packages and the other for proprietary CollabNet packages.
   • Installs each of the required software packages.
   • Verifies that your environment has all the necessary packages.
   • Installs CollabNet Enterprise Edition in the directory specified in the onsite.conf file.
   • Prepares the application and database data for a new installation by "bootstrapping" the data.
   • Starts the CollabNet Enterprise Edition instance.
   • Displays the URL for the site, for example, http://www.abc.collab.net.
9. Launch a web browser and connect to the host where CollabNet Enterprise Edition is installed.
10. In the Login page, enter the following information and click the Login button.
    • Username: root
    • Password: changeme
    Note: When you log in, you will be asked to change the root password.

[TOC]

6. Editing the configuration files

Editing the configuration files for the installation is optional. You can configure the options for the location of the Open Source packages, the directory where CollabNet Enterprise Edition gets installed, and the log files that get created during the installation.

onsite.conf

You can customize the installer by editing the following tokens in the onsite.conf file:

• rpm_path: If you have already downloaded the Open Source the packages to your server, you can use this token to specify their location. The setup.sh script then skips the download and takes the packages from the location specified here.
  Note: The default value is /root/tmp-r/rpms.
• Download: If this option is set to 0, the software packages are installed from the path on your local network specified with the url token. If this option is set to 1, the software packages are installed from the URLs specified with the link tokens.
  Note: The default value is 1.
• url: Use this token to set a path on your local network, for the Open Source packages.
  For example, url=http://domain.yourcompany.com/packages/rpms.tar.gz
• link: For each Open Source package, use this token to set the URL from where it can be obtained.
  For example, link=http://downloads.mysql.com/archives/mysql-4.0/MySQL-4.0.26-0.src.rpm, for MySQL.
  Note: Instead of the default URL specified in the link token, you can specify a different URL to download an Open Source package.
• installer_path: Use this token to specify the directory where CollabNet Enterprise Edition gets installed.
  Note: The default value for this token is /u1/sourcecast. If you change this value in onsite.conf, you must also replace all occurrences of /u1/sourcecast in site-options.conf with the same value. For example, if you set the installer_path token to /opt/cee in onsite.conf, you must change all occurrences of /u1/sourcecast to /opt/cee in site-options.conf.
• log_path: Use this token to specify the location for the log files that get created during installation.
  Note: The default value is /tmp/onsite-installer-log.

[TOC]

7. Log files

The setup.sh script logs entries to the following log files, which you can use to troubleshoot problems:

The default location for the log files is /tmp/onsite-installer-log.

[TOC]

8. Starting, stopping and checking the status of CollabNet Enterprise Edition

You can use the sourcecastctl script to start, stop and check the status of your CollabNet Enterprise Edition instance, or a specific component. The sourcecastctl script resides in the [installer_path]/runtime/scripts directory.

Note: You must invoke this script as the root user or use sudo.

Usage

• To check the status of the instance, use this command:

  sudo [installer_path]/runtime/scripts/sourcecastctl status

• To start the instance, use this command:

  sudo [installer_path]/runtime/scripts/sourcecastctl start

• To stop the instance, use this command:

  sudo [installer_path]/runtime/scripts/sourcecastctl stop

• To use this script for a specific component, for example, jboss, enter the name of the component as follows:

  sudo [installer_path]/runtime/scripts/sourcecastctl start jboss

[TOC]

9. Adding users, patches and upgrades

Please contact Support at cnsupport@collab.net or 800-228-3047 | 650-228-2561 to receive all the benefits of CollabNet Enterprise Edition. This includes adding additional users, additional features, patches or upgrades.

[TOC]

10. Support

Support is available in several ways:

• Online: By registering on our openCollabNet site, you may access tip sheets, FAQs, and other discussion forums. The link is: http://www.open.collab.net/servlets/Join.
• Support Offerings: CollabNet offers world-class support for this download, available through the “Buy Now” button on www.collab.net with multiple support plans.
• Per Incident Support: You may also elect to have support provided to you on a per-incident (“per call”) basis (bundled support plans). More information may be found here.
• Already a Customer: If you have already purchased support you may contact Support:
  • Email: cnsupport@collab.net (name, phone, and email required)
  • Phone: 650-228-2561 (M-F 8am-5pm PT)
  • Self-Service Portal
    • http://www.collab.net/support/login.html
    • Username (usually your email address)
    • Password (never provide/reveal to anyone)
    • Both are required to submit online requests (cases)

[TOC]