Install TeamForge 16.7: All services on a single RHEL/CentOS 6.8 server

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

Important: See:
All the following services run on a single RHEL/CentOS 6.8 server (we call this my.app.host).
Remember:
  • It is critical that you start with a fresh server, without any software installed. You must have root access to the server.
  • While you can run both EventQ and TeamForge on the same server, CollabNet recommends such an approach only for testing purposes. It's always recommended to run EventQ on a separate server for optimal scalability.
Attention: Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.
  1. Install Red Hat Enterprise Linux/CentOS 6.8 and log in as root.
    Warning: 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. If the TeamForge server has SELinux enabled, run it in 'Permissive' mode temporarily while installing or upgrading TeamForge.
    1. Verify if SELinux is running in enforcing mode.
      • getenforce
    2. If the output of the getenforce command is "Permissive", continue with the next step. If not, run the following command to bring it to 'Permissive' mode.
      • setenforce 0
    See Set up SELinux to have TeamForge run in SELinux mode after completing the installation or upgrade.
  4. Important: Do this only if you are upgrading TeamForge on RHEL/CentOS 6.8.
    Delete the python-crypto package.
    • yum erase python-crypto
  5. Configure your TeamForge installation repository.
    • TeamForge installation repository configuration for sites with internet access
    1. Contact the CollabNet Support and download the TeamForge 16.7 installation repository package to /tmp.
    2. Install the repository package.
      • yum install -y /tmp/collabnet-teamforge-repo-16.7-1.noarch.rpm
    3. Refresh your repository cache.
      • yum clean all
    • TeamForge installation repository configuration for sites without internet access
    1. Contact the CollabNet Support to get the auxiliary installer package for TeamForge 16.7 disconnected installation and save it in /tmp.
      • Red Hat Enterprise Linux/CentOS 6.8 64 bit RPM package: CTF-Disconnected-media-16.7.879-116.rhel6.x86_64.rpm
    2. Unpack the disconnected installation package.
      • rpm -ivh <package-name>
    3. Note: If the Red Hat Enterprise Linux/CentOS installation DVD is mounted already, skip the following instructions. If not, mount the DVD.
      Mount the Red Hat Enterprise Linux/CentOS installation DVD. The DVD contains the necessary software and utilities required for installing TeamForge without internet access.

      In the following commands, replace "cdrom" with the identifier for your server's CD/DVD drive, if necessary.

      • cd /media/
      • mkdir cdrom
      • mount /dev/cdrom ./cdrom/

      If there are any spaces in the automount, unmount it first and mount it as a filepath, with no spaces.

    4. Create a yum configuration file that points to the Red Hat Enterprise Linux/CentOS installation DVD.
      • vi /etc/yum.repos.d/cdrom.repo
      Here's a sample yum configuration file.
      [RHEL-CDROM] 
name=RHEL CDRom 			
baseurl=file:///media/cdrom/Server/
gpgfile=file:///media/cdrom/RPM-GPG-KEY-redhat-release 
enabled=1
gpgcheck=0
    5. Verify your yum configuration files.
      • yum list httpd
      • yum list apr
    6. Download the code search installation package, CodeSearch-installer-2.1.3-1.noarch.rpm from https://ctf.open.collab.net/sf/go/rel4193 and save it in the /tmp directory. To install the Black Duck Code Sight installer, run the following command.
      • cd /tmp
      • rpm -ivh CodeSearch-installer-2.1.3-1.noarch.rpm
  6. Install the following application packages.
    1. TeamForge: To install the TeamForge application packages run the following command:
      • yum install teamforge
    2. GIT: To install the GIT packages run the following command.
      • yum install teamforge-git
    3. To install Black Duck Code Sight run the following command.
      • yum install teamforge-codesearch
  7. Set up your site's master configuration file.
    • vi /opt/collabnet/teamforge/etc/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. Add 'binary' to the HOST_localhost token if you are installing Nexus. 
      HOST_localhost=app database datamart etl indexer subversion cvs gerrit codesearch binary
    5. Configure the database and datamart settings.
      Tip: 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 user name values are arbitrary alphanumeric strings.
    6. TeamForge 7.1 and later support automatic password creation. See AUTO_DATA for more information.
    7. 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.
    8. 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.
    9. 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.
    10. 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.
      Important: Remember to use the same key in the external SCM integration server also.
    11. 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__}
    12. If you have LDAP set up for external authentication, you must set the “REQUIRE_USER_PASSWORD_CHANGE” site options token to false.
    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. Ensure to set the token SELINUX_SETUP=true.
    17. 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?
    18. Enable the POSTGRES_INTERFACE token in the site-options.conf file if the value of "ifconfig -a" is not eth0/enp0*.
    19. Configure TeamForge site options to proxy EventQ through TeamForge. For more information, see "EventQ and TeamForge on the same server" section in this topic: Proxying EventQ through TeamForge. Also see Proxy settings and ports used by TeamForge EventQ services.
    20. Save the site-options.conf file.
  8. Create the runtime environment.
    • /opt/collabnet/teamforge/installer/install.sh
  9. Set up the initial site data (bootstrap).
    • /opt/collabnet/teamforge/installer/bootstrap-data.sh
  10. Start TeamForge.
    • /etc/init.d/collabnet start

Note: Gerrit is configured as part of the post installation tasks included in the post-install.py script. As a result, Gerrit's status would be Not configured during startup, which you can safely ignore.

  1. Important: 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?.
  2. 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.
  3. Restart the collabnet services.
    • /etc/init.d/collabnet restart
  4. Install EventQ. See EventQ installation walk-through
  5. 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.
Parent topic: Install TeamForge 16.7 on RHEL/CentOS
Related concepts
TeamForge installation/upgrade/configuration/administration FAQs