Installing Codebeamer
Download the latest installer for Codebeamer from the PTC Software Download - Codebeamer
 |
• If upgrading from an older version please refer to Upgrading from older versions.
• Before starting installation, please check carefully the System Requirements and Platform Updates and General Hardware Requirements topics.
|
Codebeamer is shipped with a web container (Tomcat) and on Windows with Subversion, Git and Mercurial (hg). On Linux, Unix, systems the required SCM(s) must be installed via package manager. The installation typically takes 10-15 minutes.
For addition information Please see:
| | The Codebeamer server must always be started by the same operating system user to avoid file and database access problems. The server requires read and write file permissions for its own working and temporary files, and for the databases. The Codebeamer server inherits access permissions from the user who started the server. To avoid permission problems on Linux/Unix systems, it is good practice to create a new operating system user (for example, codebeamer) with very restricted access to the file system, and to use this system account to start Codebeamer. In this case, even when there is no restriction specified in the Codebeamer configuration file, a restricted access to the file system is guaranteed on the operating system level. |
Installation on a Single Server
This section describes installation on a single server.
Client computers do not require Codebeamer installation; their only requirements are that the browser's Cookies and JavaScript should be enabled.
To install Codebeamer on your server, first download and execute a single self extract file for your platform.
Installation on Windows
After downloading the self extract file, you can start the installation by double-clicking on the self extract file.
It is strongly recommended installing Codebeamer as Service to ensure that Codebeamer will be running also after the user logged out.
Installation on Linux
On Linux systems, PTC recommends installing and running Codebeamer under a special user account such as codebeamer.
 | Do not install or run Codebeamer as root. |
If you want to put an Apache Web server in front of Codebeamer (for example, to access Codebeamer via the standard HTTP(S) ports 80 (443) or to access managed Subversion repositories via HTTP protocol), you should install the Apache server for your platform first (see Configuring Tomcat for Codebeamer, Configuring Apache for Subversion) and then create the codebeamer user in the same group where Apache is:
Platform | Group |
|---|---|
RedHat | apache |
SuSE | www |
Ubuntu | www-data |
For example, on Red Hat Enterprise, execute the following command:
sudo adduser codebeamer --ingroup apache
Before installing Codebeamer, ensure that the JDK is installed and included in the PATH environment variable of your server. To learn which JDK version is compatible with your Codebeamer version, refer to the PTC Release Advisor page relevant to your Codebeamer release.
To install Codebeamer, follow these steps:
1. Sign in as the codebeamer user:
sudo su - codebeamer
2. Navigate to the home directory of the codebeamer user:
cd /home/codebeamer/
3. Make the installation file executable:
chmod +x MED-61402-CD-340_2-2-0-2_Linux.bin
4. Run the installation file:
./MED-61402-CD-340_2-2-0-2_Linux.bin
 | To list the installation options, you can run the installer with the --help parameter, as in the following example: ./MED-61402-CD-340_2-2-0-2_Linux.bin --help The command outputs the following information: Makeself version 2.4.2 1) Getting help or info about ./MED-61402-CD-340_2-2-0-2_Linux.bin : ./MED-61402-CD-340_2-2-0-2_Linux.bin --help Print this message ./MED-61402-CD-340_2-2-0-2_Linux.bin --info Print embedded info : title, default target directory, embedded script ... ./MED-61402-CD-340_2-2-0-2_Linux.bin --lsm Print embedded lsm entry (or no LSM) ./MED-61402-CD-340_2-2-0-2_Linux.bin --list Print the list of files in the archive ./MED-61402-CD-340_2-2-0-2_Linux.bin --check Checks integrity of the archive 2) Running ./MED-61402-CD-340_2-2-0-2_Linux.bin : ./MED-61402-CD-340_2-2-0-2_Linux.bin [options] [--] [additional arguments to embedded script] with following options (in that order) --confirm Ask before running embedded script --quiet Do not print anything except error messages --accept Accept the license --noexec Do not run embedded script (implies --noexec-cleanup) --noexec-cleanup Do not run embedded cleanup script --keep Do not erase target directory after running the embedded script --noprogress Do not show the progress during the decompression --nox11 Do not spawn an xterm --nochown Do not give the target folder to the current user --chown Give the target folder to the current user recursively --nodiskspace Do not check for available disk space --target dir Extract directly to a target directory (absolute or relative) This directory may undergo recursive chown (see --nochown). --tar arg1 [arg2 ...] Access the contents of the archive through the tar command --ssl-pass-src src Use the given src as the source of password to decrypt the data using OpenSSL. See "PASS PHRASE ARGUMENTS" in man openssl. Default is to prompt the user to enter decryption password on the current terminal. --cleanup-args args Arguments to the cleanup script. Wrap in quotes to provide multiple arguments. -- Following arguments will be passed to the embedded script |
 | To make upgrading to newer Codebeamer versions easier, PTC recommends creating a symbolic link called CB in the Codebeamer home directory. This symbolic link must point to the current or active version (for example, CB-2.2): cd /home/codebeamer/ ln -s CB-2.2 CB If you later install a new Codebeamer version, the installer creates a new directory, such as CB-3.0 next to the existing CB-2.2. In this scenario, you can redirect the CB symbolic link to CB-3.0. As a result, all scripts based on the CB symbolic link can continue to operate consistently on the new CB-3.0 version. |
Installation on Docker
Please refer to how to install and use Codebeamer with Docker.
Database
| | It is strongly recommended configuring Codebeamer to use with PostgreSQL or Oracle. |
Please refer to the appropriate documentation provided with each Codebeamer version to find out which database versions are supported and how to setup them.
Starting/Stopping Codebeamer
Windows
The Codebeamer server must be started before you can access Codebeamer.
If you select to install Codebeamer as a Windows Service (during the Installation), Codebeamer will be automatically started and stopped with the system. To manaully start/stop/restart the service, use the Windows Services Control panel.
Only if you did not choose to install Codebeamer as a service, you can start and stop it manually! From the Window's Start menu select
Programs -> codebeamer x.x -> Start codebeamer Server
To stop the server, use:
Programs -> codebeamer x.x -> Stop codebeamer Server
When the server has started, start your browser on the server's URL with:
Programs -> codebeamer x.x -> Browse codebeamer
Linux, Unix
From shell the commands as below can be used:
$ /installdir/bin/startup
To stop Codebeamer, type:
$ /installdir/bin/stop
Starting during System Boot (Linux, Unix)
Typically when Linux starts, the Codebeamer service should also start automatically. For that create a new file in /etc/init.d/codebeamer with this content:
#!/bin/bash
#
# Run-level Startup script for codebeamer
#
# chkconfig: 345 91 19
# description: Startup/Shutdown codebeamer
CB_HOME="/home/codebeamer/CB"
CB_OWNR="codebeamer"
case "$1" in
start)
# startup
echo -n "Starting codebeamer: "
su - $CB_OWNR -c "cd $CB_HOME/bin && $CB_HOME/bin/startup"
echo "OK"
;;
stop)
# shutdown
echo -n "Shutdown codebeamer: "
su - $CB_OWNR -c "cd $CB_HOME/bin && $CB_HOME/bin/stop"
echo "OK"
;;
reload|restart)
$0 stop
$0 start
;;
*)
echo "Usage: $0 start|stop|restart|reload"
exit 1
esac
exit 0
#
# Run-level Startup script for codebeamer
#
# chkconfig: 345 91 19
# description: Startup/Shutdown codebeamer
CB_HOME="/home/codebeamer/CB"
CB_OWNR="codebeamer"
case "$1" in
start)
# startup
echo -n "Starting codebeamer: "
su - $CB_OWNR -c "cd $CB_HOME/bin && $CB_HOME/bin/startup"
echo "OK"
;;
stop)
# shutdown
echo -n "Shutdown codebeamer: "
su - $CB_OWNR -c "cd $CB_HOME/bin && $CB_HOME/bin/stop"
echo "OK"
;;
reload|restart)
$0 stop
$0 start
;;
*)
echo "Usage: $0 start|stop|restart|reload"
exit 1
esac
exit 0
If necessary, modify the CB_HOME and CB_OWNR variables at the start of the script. Save it.
Now to activate the service, execute these commands as root (These commands are for Ubuntu and may be different on other platforms):
sudo chmod +x /etc/init.d/codebeamer
sudo update-rc.d codebeamer defaults
sudo update-rc.d codebeamer defaults
After this the Codebeamer service is set up, and can be started/stopped using the service commands:
service codebeamer start
service codebeamer stop
service codebeamer stop
See next: