Install TeamForge 8.1 with all services on a single server

The easiest way to install TeamForge is to install it on a single server, dedicated to TeamForge taking the default configuration settings. We call this a "dedicated" install.

1. Install SuSE Linux Enterprise Server 11 SP2 and log in as root.
   • See Platform specification for TeamForge 8.1 for the full platform requirements.
   • See the SuSE Linux Enterprise Server deployment guide for help.
   Important: Don't customize your installation. Select only the default packages list.
2. Check your basic networking setup. See Set up networking for your TeamForge server for details.
3. Configure your TeamForge 8.1 installation repository. See TeamForge installation repository configuration for SUSE.
4. Install the following application packages.
   1. TeamForge: To install the TeamForge application packages run the following command:
      • zypper install teamforge
   2. GIT: To install the GIT packages run the following command.
      • zypper install teamforge-git
   3. To install Black Duck Code Sight run the following command.
      • zypper install teamforge-codesearch
5. Set up your site's master configuration file.
   • vi /opt/collabnet/teamforge-installer/8.1.0.1/conf/site-options.conf
   1. Configure the HOST token.

      HOST_localhost=app database datamart etl indexer subversion cvs

      DOMAIN_localhost=my.app.domain.com

   2. Add 'gerrit' to the HOST_localhost token if you are installing Git.

      HOST_localhost=app database datamart etl indexer subversion cvs gerrit

   3. Add 'codesearch' to the HOST_localhost token if you are installing Black Duck Code Sight.

      HOST_localhost=app database datamart etl indexer subversion cvs gerrit codesearch

   4. Configure the database and datamart settings.
      Note: For more information about configuring variables, see site-options.conf

      DATABASE_TYPE=postgresql

      DATABASE_USERNAME=ctfuser

      DATABASE_NAME=ctfdb

      DATABASE_READ_ONLY_USER=ctfrouser

      REPORTS_DATABASE_USERNAME=ctfrptuser

      REPORTS_DATABASE_NAME=ctfrptdb

      REPORTS_DATABASE_READ_ONLY_USER=ctfrptrouser

      REPORTS_DATABASE_MAX_POOL_SIZE=30

      Note: The database name and username values are arbitrary alphanumeric strings.
   5. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
   6. Password obfuscation
      

      The password obfuscation is enabled by default. As a result, all password-related tokens are encrypted in all the TeamForge configuration files.

      Restriction: The password-related tokens cannot contain the following characters in the site-options.conf file: $<>/\'"`
      • To disable password obfuscation, set OBFUSCATION_ENABLED=false.
      • To configure the obfuscation key, set OBFUSCATION_KEY=<Any AlphaNumeric value with length >= 8 bytes>. The default value of OBFUSCATION_KEY token is XSJt43wN.
   7. Turn on the SSL for your site by editing the relevant variables in the site-options.conf file. To generate the SSL certificates, see Generate SSL certificates.

      • SSL=on

      • SSL_CERT_FILE

      • SSL_KEY_FILE

      • SSL_CHAIN_FILE

      Note: The SSL_CERT_FILE and SSL_KEY_FILE tokens need an absolute path. The SSL_CHAIN_FILE token is optional.
   8. If the token REQUIRE_PASSWORD_SECURITY is enabled, then set a value for the token, PASSWORD_CONTROL_EFFECTIVE_DATE.
      CAUTION:
      The Password Control Kit (PCK) disables, deletes or expires user accounts that don't meet the password security requirements starting from the date set for the PASSWORD_CONTROL_EFFECTIVE_DATE token. If a date is not set, the PCK disables, deletes or expires user accounts immediately. See PASSWORD_CONTROL_EFFECTIVE_DATE for more information.
   9. Include the SCM_DEFAULT_SHARED_SECRET token in the site-options.conf file of the primary TeamForge server and provide it with a value of 16-24 characters. Remember to use the same key in the external SCM integration server also.
   10. If the token REQUIRE_RANDOM_ADMIN_PASSWORD is already set to true, then set the token ADMIN_EMAIL with a valid email address. ADMIN_EMAIL=root@{__APPLICATION_HOST__}
   11. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
   12. Ensure to set the token DEDICATED_INSTALL=true. This makes the installation process very simple as the TeamForge installer takes care of configuring the Apache and PostgreSQL automatically.
   13. Make sure that the following tokens have a value if ETL is enabled.

       SOAP_ANONYMOUS_SHARED_SECRET

       ETL_SOAP_SHARED_SECRET

   14. Configure Black Duck Code Sight tokens if you are installing Black Duck Code Sight. See Black Duck Code Sight site-option tokens.
   15. To enable the history protection feature of TeamForge Git integration, set the GERRIT_FORCE_HISTORY_PROTECTION=true. For more information, see GERRIT_FORCE_HISTORY_PROTECTION.
   16. Make sure the PostgreSQL tokens in the site-options.conf file are set as recommended in the following topic: What are the right PostgreSQL settings for my site?
   17. Save the site-options.conf file.
6. Run the install_jdk_suse.sh script.
   • cd /opt/collabnet/teamforge-installer/8.1.0.1
   • ./install_jdk_suse.sh
7. Recreate the runtime environment.
   • cd /opt/collabnet/teamforge-installer/8.1.0.1
   • ./install.sh -r -I -V
8. Set up the initial site data (bootstrap).
   • ./bootstrap-data.sh
9. Start TeamForge.
   • /etc/init.d/collabnet start
10. Note: If the token REQUIRE_USER_PASSWORD_CHANGE is set to true, login to TeamForge user interface, change the admin password and then run the post-install.py script.
    Run the TeamForge post installation script. For more information, see post-install.py.
    • /opt/collabnet/teamforge/runtime/scripts/post-install.py
    Note: In case you face any GIT-related issues while running the post-install.py script, see Post install fails for GIT. What should I do?.
11. If you have installed Black Duck Code Sight, then install the license for Black Duck Code Sight. For more information, see Install the Black Duck Code Sight license.
12. Restart the collabnet services.
    • /etc/init.d/collabnet restart
13. Apply some finishing touches and make sure everything is running smoothly.
    1. Reboot the server and make sure all services come up automatically at startup.
    2. Log into your site as the administrator. The value of the DOMAIN variable in the site-options.conf file is the URL to log into.
    3. Create a sample project. See Create a TeamForge project.
    4. Write a welcome message to your site's users. See Create a site-wide broadcast.