Tags: Environment Variables

Application configuration via environment variables

After installing or migrating codebeamer to a new server, environment variables have to be configured again!

License

CB_mail_host
Host name of your email server. e.g. smtp.googlemail.com.
CB_mail_user
User that is used for authentication e.g. test@example.com.
CB_mail_password
Password that is used for authentication.
CB_mail_from
Email address of the sender. e.g. noreply@example.com.
CB_mail_ssl
Indicate that SSL is used. e.g. true / false.
CB_mail_smtpPort
Port of your email server. e.g. 465.
CB_mail_serverScheme
Protocol of the URL that will be used in sent emails. e.g. http / https.
CB_mail_localname
Host name of the URL that will be used in sent emails. e.g. example.com.
CB_mail_serverPort
Port of the URL that will be used in sent emails. e.g. 8080.
CB_LOGGING_ERROR_TO
Email address that will be notified when an unexpected error happens.

CB_MAXHEAPSIZE
Xmx value of the JVM, e.g. 2000.
JVM_OPTIONS_OVERRIDE
You can override the default configuration of codebeamer. Default values are logged during start up.
JVM_OPTIONS
You can extend the default configuration of codebeamer. Default values are logged during start up.
RESERVED_CODE_CACHE_SIZE_OVERRIDE
You can override the default configuration of codebeamer. Default values are logged during start up.
RESERVED_CODE_CACHE_SIZE
You can extend the default configuration of codebeamer. Default values are logged during start up.
HEAPSIZE_OVERRIDE
You can override the default configuration of codebeamer. Default values are logged during start up.
HEAPSIZE
You can extend the default configuration of codebeamer. Default values are logged during start up.
GC_OPT_OVERRIDE
You can override the default configuration of codebeamer. Default values are logged during start up.
GC_OPT
You can extend the default configuration of codebeamer. Default values are logged during start up.

CB_CORS_SUPPORT_CREDENTIALS
Default value: false. Sets the value of Access-Control-Allow-Credentials CORS configuration parameter (it is highly recommended not setting this parameter to true as it poses security vulnerabilities).
CB_CORS_ALLOWED_ORIGINS
If set to an URL, only requests originating from this URL will be served. If not set, codebeamer will serve requests from any origin (it is highly recommended setting this parameter, as requests from any origin pose security vulnerabilities).

CB_PAGE_VISIBILITY_ISQL
Default value: true. Sets the accessibility of the interactive SQL console. For more information, see: You must login to see this link. Register now, if you have no user account yet..

These variables are not available from version Felicity! If you intend to use these parameters from Felicity, refer to the next section.

CB_application_database_pool_max_active
Max active connection by application database pool. Default value: 35
CB_application_database_pool_max_idle
Max idle connection by application database pool. Default value: 15
CB_application_database_pool_min_idle
Min idle connection by application database pool. Default value: 10
CB_quartz_database_pool_max_active
Max active connection by quartz database pool. Default value: 35
CB_quartz_database_pool_max_idle
Max idle connection by quartz database pool. Default value: 15
CB_quartzdatabase_pool_min_idle
Min idle connection by quartz database pool. Default value: 10

There is a known typo in "CB_quartzdatabase_pool_min_idle", which will be changed in the next version.

A new type of connection pool (HikariCP) is introduced, thus, it is possible to switch the pool type

All parameters which are supported by connection pool types are supported and can be set via environment variables.

Use CB_pool_ or CB_pool_quartz prefix to set a pool parameter for the application and the quartz pool respectively.

Tomcat CP provides a parameter called 'maxActive'
To set this parameter you can use these environment variables

HikariCP provides a parameter called 'maximumPoolSize'

To set this parameter you can use these environment variables

The connection pool specific parameters can be found here:

CB_WORKFLOW_EXECUTOR_CORE_POOL_SIZE
The number of threads to keep in the core pool, even if threads are idle.

The parameters from version 21.09 can be set as follows:

CB_pool_max_active
Max active connection by application database pool. Default value: 35
CB_pool_max_idle
Max idle connection by application database pool. Default value: 15
CB_pool_quartz_min_idle
Min idle connection by application database pool. Default value: 10
CB_pool_quartz_max_active
Max active connection by quartz database pool. Default value: 35
CB_pool_quartz_max_idle
Max idle connection by quartz database pool. Default value: 15
CB_pool_quartz_min_idle
Min idle connection by quartz database pool. Default value: 10

The following parameters are available from 21.09-SP6:

TOMCAT_EXECUTOR_MAX_THREADS
Max number of active threads in this pool. Default value: 250
TOMCAT_EXECUTOR_PRESTARTMIN_SPARE_THREADS
Determines whether minSpareThreads should be started when starting the Executor or not. Default value: true
TOMCAT_EXECUTOR_MIN_SPARE_THREADS
The minimum number of threads (idle and active) always kept alive. Default value: 40
TOMCAT_EXECUTOR_MAX_IDLE_TIME
The number of milliseconds before an idle thread shuts down, unless the number of active threads is less or equal to minSpareThreads. Default value: 90000 (1.5 minute)
TOMCAT_CONNECTOR_MAX_SWALLOW_SIZE
The maximum number of request body bytes (excluding transfer encoding overhead) swallowed by Tomcat for an aborted upload. Default value: 2,097,152 bytes (2 MB).
- The maximum value of this parameter equals to that of the integer: 2,147,483,647 bytes (2 GB). Anything exceeding this value will revert to the Tomcat default value.
- The size limitation for the file upload is 5.0 GB. When exceeding this limit, codebeamer displays error messages:

TOMCAT_CONNECTOR_ACCEPT_COUNT
The maximum length of the operating system provided queue for incoming connection requests when maxConnections has been reached. Default value: 200