Application Configuration via Environment Variables
 |
After installing or migrating Codebeamer to a new server, environment variables have to be configured again.
|
License
• CB_MAC_ADDRESS
Your MAC address, for example 00:00:00:00:00:00.
• CB_LICENSE
Your license in XML format which must be in one line.
Email
• CB_mail_host
Host name of your email server. For example: smtp.googlemail.com.
• CB_mail_user
User that is used for authentication. For example: test@example.com.
• CB_mail_password
Password that is used for authentication.
• CB_mail_from
Email address of the sender. For example: noreply@example.com.
• CB_mail_ssl
Indicate that SSL is used. For example: true / false.
• CB_mail_smtpPort
Port of your email server. For example: 465.
• CB_mail_serverScheme
Protocol of the URL that will be used in sent emails. For example: http / https.
• CB_mail_localname
Host name of the URL that will be used in sent emails. For example: example.com.
• CB_mail_serverPort
Port of the URL that will be used in sent emails. For example: 8080.
• CB_LOGGING_ERROR_TO
Email address that will be notified when an unexpected error happens.
Java
• CB_MAXHEAPSIZE
Xmx value of the JVM. For example: 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.
CORS
• 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).
iSQL
• CB_PAGE_VISIBILITY_ISQL
Default value: true. Sets the accessibility of the interactive SQL console. For more information, see: Monitoring, Logging & Profiling
Database
See the Database Connection Pool Parameters wiki page for further information.
Workflow
• CB_WORKFLOW_EXECUTOR_CORE_POOL_SIZE
The number of threads to keep in the core pool, even if threads are idle.
TOMCAT Executor and Connector
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 — he 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:
See also: • 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.