Site options change log

Change log of site-options.conf tokens.

Important: While upgrading to a latest TeamForge release, make sure that obsolete site option tokens, if any, are removed from the site-options.conf file of the TeamForge version you are upgrading to.

TeamForge 17.11

Obsolete tokens
  • ENABLE_CACHING_WITH_MEMCACHED
  • MEMCACHED_SERVER_HOST
  • MEMCACHED_SERVER_PORT
  • MEMCACHED_SERVER_TTL
  • SSL_CA_CERT
  • Separate ports for database and datamart on the same server
    The ability to run separate PostgreSQL instances for TeamForge database and datamart on the same server is being deprecated.
    • During TeamForge installation, the REPORTS_DATABASE_PORT token should no longer be used to assign a separate port for datamart on the server that also runs the TeamForge database. The following warning shows up if you use the REPORTS_DATABASE_PORT token with a custom port number (other than the default value, which is 5432).

      Using two separate Postgres clusters for database and datamart on the same machine is deprecated. Consider deploying the two clusters on two machines or using a single cluster for both databases.

    • If you have the TeamForge database and datamart running on separate PostgreSQL instances on the same server:
      • New hardware upgrade: If you are upgrading on a new hardware, it is highly recommended to create a dump of both the database and datamart and load them into the same PostgreSQL instance. For more information, see Upgrade on new hardware: Create a single cluster for both Database and Datamart
      • Same hardware upgrade: If you are upgrading on the same hardware, you may still choose to use the REPORTS_DATABASE_PORT and have the database and datamart running on two separate PostgreSQL instances. However, support for REPORTS_DATABASE_PORT token may end in one of the future TeamForge releases, when you may have to dump and load both the database and datamart on the same PostgreSQL instance anyway.

TeamForge 17.8

Obsolete tokens
  • JAMES_ACCEPTED_RELAYS
  • REPORTS_LIFECYCLE_METRICS

TeamForge 17.4

Obsolete tokens
  • GERRIT_FORCE_HISTORY_PROTECTION
  • ORC_HOSTNAME
  • ORC_SSL_CA_CERT_FILE
  • ORC_PORT
  • ORC_PROXIED_PATH
  • ORC_PROTOCOL
  • ORCHESTRATE_ENABLED
  • POSTGRES_INTERFACE_IP
  • POSTGRES_INTERFACE
New tokens
Default values for site-options.conf tokens

Default values have been assigned to the following site-options.conf tokens and are therefore removed from the default TeamForge 17.4 site-otpions-default.conf file.

Warning: If you are upgrading from TeamForge 17.1 (or earlier) to TeamForge 17.4 (or later) and if you have been using your own values for the following tokens, you must make sure you use the same values in your site-options.conf file post upgrade to TeamForge 17.4.
# CTF Core
SCM_ADMIN_PASSWORD=$auto$
IAF_DBPASS=$auto$
SCM_DEFAULT_SHARED_SECRET=$auto$
SOAP_ANONYMOUS_SHARED_SECRET=$auto$

# Database
DATABASE_USERNAME=teamforge
DATABASE_NAME=teamforge
DATABASE_PASSWORD=$auto$
DATABASE_READ_ONLY_USER=teamforge_reader
DATABASE_READ_ONLY_PASSWORD=$auto$

# Datamart
REPORTS_DATABASE_USERNAME=teamforge_datamart
REPORTS_DATABASE_NAME=teamforge_datamart
REPORTS_DATABASE_PASSWORD=$auto$
REPORTS_DATABASE_READ_ONLY_USER=teamforge_datamart_reader
REPORTS_DATABASE_READ_ONLY_PASSWORD=$auto$

# ETL
ETL_SOAP_SHARED_SECRET=$auto$

# Gerrit
GERRIT_DATABASE_PASSWORD=$auto$

# RabbitMQ
RABBITMQ_APP_ADMIN_USER=guest
RABBITMQ_APP_ADMIN_PASSWORD=$auto$
RABBITMQ_APP_CTF_USER=ctf
RABBITMQ_APP_CTF_PASSWORD=$auto$
RABBITMQ_APP_SERVICES_USER=eventq
RABBITMQ_APP_SERVICES_PASSWORD=$auto$
RABBITMQ_PERMISSION_PUBLISHER=permission_publisher
RABBITMQ_PERMISSION_PUBLISHER_PASSWORD=$auto$

# Mongo
MONGODB_APP_DATABASE_NAME=eventq
MONGODB_ADMIN_DATABASE_NAME=admin
MONGODB_APP_ADMIN_USER=admin
MONGODB_APP_ADMIN_PASSWORD=$auto$
MONGODB_APP_BACKUP_USER=backup
MONGODB_APP_BACKUP_PASSWORD=$auto$
MONGODB_APP_SERVICES_USER=eventq
MONGODB_APP_SERVICES_PASSWORD=$auto$

# HAProxy
HAPROXY_STATS_PASSWORD=$auto$

# Binary
IAF_DBNAME=iafdb
IAF_DBUSER=iafdbusr

# James Admin (for management interface)
JAMES_ADMIN_USER=admin
JAMES_ADMIN_PASSWORD=$auto$

TeamForge 17.1

Obsolete tokens
  • BDCS_ADMIN_PASSWORD
  • BDCS_ADMIN_USERNAME
  • BDCS_HOST
  • BDCS_SSL
  • BDCS_TOMCAT_PORT
  • BDCS_SDK_SEARCH_LIMIT_MAX
  • BDCS_SSL_CERT_FILE
  • BDCS_SSL_KEY_FILE
  • BDCS_SSL_CA_CERT_FILE
  • BDCS_SSL_CHAIN_FILE
  • BDCS_SCAN_SOURCE_DIR_ROOT
  • BDCS_INSTALL_PATH
  • BDCS_PGSQL_HOME_DIR_ROOT
  • BDCS_PGSQL_PORT
  • BDCS_TOMCAT_MX_IN_MB
  • BDCS_TOMCAT_SHUTDOWN_PORT
Newly added tokens

TeamForge 16.10

Obsolete tokens
  • SSH_TUNNEL_ENABLED
  • SELINUX_SETUP
  • SELINUX_ENABLED
Newly added tokens

TeamForge 16.7

Obsolete tokens
  • TeamForge 16.7 installer automatically sets JAVA_HOME during installation or upgrade. Therefore, the JAVA_HOME site options token, if added to your site-options.conf file, must be removed while upgrading to TeamForge 16.7 and later.
  • The DEDICATED_INSTALL token is no longer supported. CollabNet recommends removing this token from the site-options.conf file. However, this token is ignored (has no effect whatsoever) if you continue to have it in your site-options.conf file post upgrade to TeamForge 16.7 and later.
  • Debug settings can be done via the JAVA_OPTS tokens (such as JBOSS_JAVA_OPTS and ETL_JAVA_OPTS). Hence, the following tokens are no longer supported:
    • JBOSS_DEBUG
    • PHOENIX_DEBUG
    • ETL_DEBUG
    • INTEGRATION_DEBUG
    • ETL_DEBUG_PORT
    • JBOSS_DEBUG_PORT
    • INTEGRATION_DEBUG_PORT
    • PHOENIX_DEBUG_PORT
  • The SITE_DIR and DATA_DIR tokens are no longer supported. Starting from TeamForge 16.7 (and later) SITE_DIR and DATA_DIR are unconditionally set to /opt/collabnet/teamforge and /opt/collabnet/teamforge/var respectively during runtime creation.
  • The MODPAGESPEED_ENABLED token is no longer supported.
  • SSL certificates are validated by default. Hence, VALIDATE_SSL_CERTS token is no longer supported. If in use, remove this token from the site-options.conf file post upgrade to TeamForge 16.7 and later.
  • While the SSL_CA_CERT_FILE token is still supported, it has been removed from the site-options-default.conf file as it is only needed for add-ons. References to this token have been removed from TeamForge documentation as well.
Newly added tokens

TeamForge 8.2

Obsolete tokens
  • PERFORCE_CLIENT_DIR
  • PERFORCE_GROUP
  • PERFORCE_LICENSE_FILE
  • PERFORCE_LOG_DIR
  • PERFORCE_PORT
  • PERFORCE_REPOSITORY_BASE
  • PERFORCE_SERVICE_CMD
  • PERFORCE_USER
  • HELP_AVAILABILITY
  • REMOTE_HELP_URL
  • EXTERNAL_TOMCAT_INSTALL_DIR
  • INTEGRATION_BUILTIN_TOMCAT
  • ETL_BUILTIN_TOMCAT
  • CEE_COMPATIBLE
Newly added tokens

TeamForge 8.0

Newly added tokens
Parent topic: site-options.conf
Related reference
TeamForge installation requirements
Related information
Set up a TeamForge Stage Server