Docker - Codebeamer X
Codebeamer 4.2 Docker Image
Docker Hub
Supported docker variables
Wait service
Docker image contains 3rd party tool for waiting service like database. See: https://github.com/ufoscout/docker-compose-wait
Required parameters
• CB_database_JDBC_Username.
• CB_database_JDBC_Password.
• CB_database_JDBC_Driver.
• CB_database_JDBC_ConnectionURL.
License
• CB_MAC_ADDRESS
Your MAC address, e.g. 00:00:00:00:00:00.
• CB_LICENSE
Your license in XML format, please note is must be one line.
Email
• 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.
Java
• 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.
Initial database script during startup
CB_INIT_SQL_FILES=/path/to/your/sqlfile1,/path/to/your/sqlfile2
The given sql files (comma or semicolon separated list) are executed during startup.
Please note that you need to attach the sql files as a volume.
The right side needs to match with the path that you defined in the environment variable.
With compose:
volumes:
- /path/to/folder/of/your/sql/files/on/host:/path/to/folder/of/your/sql/files/in/docker
- /path/to/folder/of/your/sql/files/on/host:/path/to/folder/of/your/sql/files/in/docker
Without compose:
docker run -v /path/to/folder/of/your/sql/files/on/host:/path/to/folder/of/your/sql/files/in/docker ...
Initial configuration
CB_initial_config can be used for starting the application with initial configuration:
CB_initial_config={ "search" : { "delay" : 90, "fuzzy-similarity-factor" : 0.6 } }
Time zone
TZ can be used to set timezone of the container. Please use the name of the time zones from here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
TZ=Europe/Berlin
Debug
Remote java debug can be turned on, it uses the 7896 port inside the container:
DEBUG=TRUE
Volumes
How to add (or override) files to the docker images
Bind your directory to the docker images:
codebeamer-x-app:
image: intland/codebeamer-x:4.2
env_file:
- ./config/mail.env
.....
environment:
- DEBUG=false
......
volumes:
- ~/update:/home/appuser/codebeamer/update
- codebeamer-x-app-repository-docs:/home/appuser/codebeamer/repository/docs
- codebeamer-x-app-repository-search:/home/appuser/codebeamer/repository/search
- codebeamer-x-app-logs:/home/appuser/codebeamer/logs
links:
- codebeamer-x-db:container-mysql
image: intland/codebeamer-x:4.2
env_file:
- ./config/mail.env
.....
environment:
- DEBUG=false
......
volumes:
- ~/update:/home/appuser/codebeamer/update
- codebeamer-x-app-repository-docs:/home/appuser/codebeamer/repository/docs
- codebeamer-x-app-repository-search:/home/appuser/codebeamer/repository/search
- codebeamer-x-app-logs:/home/appuser/codebeamer/logs
links:
- codebeamer-x-db:container-mysql
"~/update" will be bound to the container and will be available under "/home/appuser/Codebeamer/update".
 | On Windows docker hosts, the folder separator for update directory should be backslash - e.g. |
- .\update:/home/appuser/Codebeamer/update.
Please also note that upon first startup docker guest will mount this folder as a windows share from host machine.
Update directory could contain the following files / directory.
• root.zip:
Content of root.zip will be extracted to the tomcat/webapps/ROOT directory, it can be used to override images, jsp files or add jars to the libs directory.
• root:
Content of root directory will be copied to the tomcat/webapps/ROOT directory, it can be used to override images, jsp files or add jars to the libs directory (Only from 9.4 version).
• config.zip:
Content of config.zip will be extracted to the /Codebeamer/config directory.
• config:
Content of config directory will be copied to the /Codebeamer/config directory (Only from 9.4 version).
• repository.zip:
Content of repository.zip will be extracted to /Codebeamer/repository directory, it can be used for uploading logos.
• repository:
Content of repository directory will be copied to /Codebeamer/repository directory, it can be used for uploading logos (Only from 9.4 version).
MySql docker image
Image extends the https://github.com/sclorg/mysql-container/tree/master/5.7 image.
image.