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

Dos and Don’ts

Here’s a list of dos, don’ts and points to remember when you install or upgrade TeamForge.


  • Understand TeamForge installation requirements and plan your installation or upgrade.
  • Get your TeamForge license key and keep it handy.
  • Verify your basic networking setup before installing or upgrading TeamForge. See Set Up Networking for TeamForge.
  • Look for new or modified site-options.conf tokens and update your site-options.conf file as required during the upgrade process. See Site Options Change Log.
  • Set up a TeamForge Stage Server before you upgrade your Production Server.
  • Stop TeamForge services on all servers in a distributed setup while upgrading to TeamForge 21.2.
  • Uninstall hot fixes and add-ons, if any, before you start the TeamForge 21.2 upgrade procedure.
  • As a result of changes to the logging framework in Java 9, the PrintGCDetails and PrintGCTimeStamps logging options are no longer supported. Remove these options from the following tokens while upgrading to TeamForge 18.1 or later. TeamForge provision fails otherwise.



  • Do not customize your operating system installation. Select only the default packages list.
  • While upgrading TeamForge, whether in place or on new hardware, always reuse the old site-options.conf file and make changes as necessary. Do not try to start with a new site-options.conf file. Reusing the old site-options.conf avoids many potential problems, particularly around the management of usernames and passwords.
  • Do not manually modify TeamForge-managed site option tokens such as the AUTO_DATA token. See AUTO_DATA for more information.
  • If you are creating symlinks, note that you must create symlinks only to the TeamForge data directory (/opt/collabnet/teamforge/var). You should not create symlinks to TeamForge application directories (such as /opt/collabnet).

Points to Remember

  • Installing or upgrading TeamForge needs root privileges. You must log on as root or use a root shell to install or upgrade TeamForge.
  • SSL is enabled by default and a self-signed certificate is auto-generated. However, you can use a few site-options.conf tokens to adjust this behavior. To generate the SSL certificates, see Generate SSL Certificates.
  • For the ETL service to run as expected in a distributed TeamForge installation, all servers must have the same time zone.
  • If you have Git integration on a separate server, both TeamForge and Git servers must have their time and date synchronized. Similarly, if Subversion is on a separate server, both TeamForge and Subversion servers must have their time and date synchronized.
  • It’s highly recommended that you install the TeamForge Baseline services on a separate server as the baselining process can consume considerable CPU and database resources. For more information, see Install TeamForge in a Distributed Setup.
  • No backup is required for same hardware upgrades. However, you can create a backup as a measure of caution. See Back up and Restore TeamForge for more information.
  • Always use compatible JDBC drivers meant for specific database versions. See JDBC Drivers Reference for more information. Also see: Why do ETL jobs fail post TeamForge upgrade?
  • You can run the initial load job any time after the installation of TeamForge. We recommend that you run it before you hand over the site to the users. For more information, see ETL Initial Load Jobs.
  • SOAP50 APIs and event handlers are no longer supported in TeamForge 16.10 and later. Use the latest TeamForge SOAP/REST APIs.
  • TeamForge 21.2 installer expects the system locale to be LANG=en_US.UTF-8. TeamForge create runtime (teamforge provision) fails otherwise.
  • Installing TeamForge with service-specific FQDNs (instead of machine-specific host/domain names) is highly recommended so that you will be able to change the system landscape at a later point in time without having any impact on the URLs (in other words, end users do not have to notice or change anything). For example, you can create FQDNs specifically for services such as Subversion, Git, mail, Codesearch and so on. For more information, see Service-specific FQDNs.
  • All such service-specific FQDNs must belong to a single sub domain and it is recommended to create a new sub domain for TeamForge.
  • If you are using service-specific FQDNs
    • A wildcard SSL cert is required. SNI SSL cert cannot be used.
    • When SSL is enabled and no custom SSL certificates are provided, a self-signed wildcard cert is generated for the sub domain.
    • When SSL is enabled and a custom SSL certificate is provided, the CN of the certificate is verified to be a wildcard CN.
  • The ability to run separate PostgreSQL instances for TeamForge database and datamart on the same server is being deprecated in TeamForge 17.11. If you have TeamForge database and datamart on separate PostgreSQL instances on the same server and if you are upgrading on a new hardware, you must Create a Single Cluster for Both Database and Datamart while upgrading to TeamForge 17.11 or later.
  • While upgrading TeamForge-Git integration servers, it is important that Git master and slave servers are upgraded to the same version of TeamForge-Git integration. On sites with Git Replica Servers, you must upgrade the Git Replica Servers first and then upgrade the master Git servers.
  • From TeamForge 19.3, TeamForge Webhooks-based Event Broker is installed automatically when you install/upgrade TeamForge. In other words, you don’t have to run the command yum install teamforge-webr separately.
  • Call back URLs registered with WEBR are lost when you restart WEBR. This means, a TeamForge/Jboss restart must follow immediately after you stop or restart WEBR.
  • TeamForge supports Monit for monitoring services and recovering failed services. Monit is installed on the TeamForge Application server to monitor the health of services and restart the services when they fail. Monit log file is located at /opt/collabnet/teamforge/log/monit/monit.log.

Single Server Setup

You can install TeamForge on both RHEL 8.4 and RHEL/CentOS 7.9. In this single server setup, all the following TeamForge services are installed on a single RHEL/CentOS server.

TeamForge Application Server (server-01)

  • TeamForge Application Server (ctfcore)
  • Database Server (ctfcore-database and ctfcore-datamart)
  • Mail Server (mail)
  • Code Search Server (codesearch)
  • ETL Server (etl)
  • Git Integration Server (gerrit and gerrit-database)
  • Review Board (reviewboard, reviewboard-database and reviewboard-adapter)1
  • Binary (binary and binary-database)
  • SCM Integration Server (subversion)
  • Search Server (search).
  • CLI Server (cliserver)
  • TeamForge Baseline (baseline, baseline-database, baseline-post-install)2
  • TeamForge Webhooks-based Event Broker (webr webr-database)
  • Service Monitor (service-monitor)

Do This Step by Step on the TeamForge Application Server (server-01)

  1. Install RHEL 8.4 or RHEL/CentOS 7.9 and log on as root.

    The host must be registered with the Red Hat Network if you are using Red Hat Enterprise Linux.

    See the RHEL 8.4 Installation Guide or RHEL RHEL/CentOS 7.9 Installation Guide for help.

    Delete the python-crypto package if you are installing TeamForge on RHEL/CentOS 7.9. yum erase python-crypto
  2. Check your networking setup. See Set up Networking for more information.

  3. TeamForge Installation Repository Configuration for Sites with Internet Access

    1. Contact the CollabNet Support and download the TeamForge 21.2 installation repository package to /tmp.
    2. Install the repository package.
      yum install -y /tmp/collabnet-teamforge-repo-21.2-0-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 21.2 disconnected installation and save it in /tmp.
      • RHEL 8.4 64 bit: CTF-Disconnected-media-21.2.223-511.rhel8.x86_64.rpm
    2. Unpack the disconnected installation package.
      rpm -ivh <package-name>
    3. If you are installing TeamForge 21.2 on RHEL 8.4, contact the CollabNet Support to get the file and unzip it to /opt/collabnet/teamforge/service/reviewboard/resources/SOURCES/python-modules-sources.
         unzip -d /opt/collabnet/teamforge/service/reviewboard/resources/SOURCES/python-modules-sources
    4. If not mounted already, mount the RHEL/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.

    5. Create a yum configuration file that points to the RHEL/CentOS installation DVD.
      vi /etc/yum.repos.d/cdrom.repo

      Here’s a sample yum configuration file.

      name=RHEL CDRom 			
    6. Verify your yum configuration files.
      yum list httpd
      yum list apr
  4. Install the TeamForge application packages.

    yum install teamforge

    Install Monit.

    1. Download Monit for

      • RHEL 8.x from the EPEL repository.

        rpm -ivh epel-release-latest-8.noarch.rpm
      • RHEL/CentOS 7.x from the EPEL repository.

        rpm -ivh epel-release-latest-7.noarch.rpm
    2. Install Monit.

       yum install monit

    Install the Baseline packages.

    yum install teamforge-baseline
  5. Set up your site’s master configuration file.
    vi /opt/collabnet/teamforge/etc/site-options.conf

    host:SERVICES Token

    server-01:SERVICES=ctfcore ctfcore-database service-monitor search mail codesearch etl ctfcore-datamart subversion gerrit gerrit-database binary binary-database reviewboard reviewboard-database reviewboard-adapter cliserver baseline baseline-database baseline-post-install webr webr-database

    host:PUBLIC_FQDN Token

    Save the site-options.conf file.

    For further customization of your site configuration (SSL settings, password policy settings, PostgreSQL settings, LDAP settings and so on):

    SSL Tokens

    SSL is enabled by default and a self-signed certificate is auto-generated. Use the following tokens to adjust this behavior.

    • To generate the SSL certificates, see Generate SSL certificates.
    • Have the custom SSL certificate and private key for custom SSL certificate in place and provide their absolute paths in these tokens. SSL_CHAIN_FILE (intermediate certificate) is optional.
    • You can also encrypt the data traffic between the application and database servers and between the ETL and datamart servers in a distributed setup. Use the DATABASE_SSL token to do that. See Encrypt Database Network Traffic.

    Password Tokens

    Prevent Cross-site Scripting

    An attacker could potentially upload an HTML page to TeamForge that contains active code, such as JavaScript. This active code would then be executed by clients’ browsers when they view the page, which can harm the system.

    To prevent an attack of this sort, you can specify whether or not HTML code is displayed in TeamForge. This flag applies to all documents, tracker, task, and forum attachments, and files in the file release system.

    Set the SAFE_DOWNLOAD_MODE token according to your requirements. For more information, see SAFE_DOWNLOAD_MODE.

    PostgreSQL Tokens and Settings

    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?

    Save the site-options.conf file.

  6. Provision services.
    teamforge provision
    TeamForge 21.2 installer expects the system locale to be LANG=en_US.UTF-8. TeamForge create runtime (teamforge provision) fails otherwise.
  7. Verify TeamForge installation.
    1. Reboot the server and make sure all services come up automatically at startup.
    2. Log on to the TeamForge web application using the default Admin credentials.
      • Username: admin
      • Password: admin
    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.

Post Install Tasks

Also See…

FAQs on Install / Upgrade / Administration

  1. TeamForge 21.2 supports Review Board 3.0.15 on RHEL 8.4 and Review Board 3.0.15 on RHEL/CentOS 7.9. 

  2. It’s highly recommended that you install the TeamForge Baseline services on a separate server as the baselining process can consume considerable CPU and database resources. For more information, see Install TeamForge in a Distributed Setup