Installing codeBeamer

If upgrading from an older version please refer to Upgrading from older versions.

Before starting installation, please check carefully the General System Requirements.

codeBeamer is shipped with a web container (tomcat), database server (Derby) and on Windows with Subversion, Git and Mercurial (hg). On Linux, Unix, MAC-OS systems the required SCM(s) must be installed via package manager. The installation typically takes 10-15 minutes.

The pre-configured Derby database is for evaluation purposes only, and should not be used for production purposes.

For addition information Please see:

• General System Requirements
• Post-installation Configuration
• Customizing Notification Emails
• Deployment options for Git, Mercurial and SVN

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 (e.g. 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:

E.g. on Red Hat Enterprise:

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

./MED-61402-CD-340_2-2-0-2_Linux.bin --help

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

cd /home/codebeamer/ ln -s CB-3.0 CB

Installation on Docker

Please refer to How to work with Docker how to install and use codeBeamer with Docker.

Database

codeBeamer is shipped with a Derby database that should be used only for evaluation purposes. It is strongly recommended configuring codeBeamer to use with PostgreSQL, MySQL 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.

• Preparing PostgreSQL Database
  
• Installing MySQL Database on Red Hat or CentOS
• Preparing MySQL Database for Installation
• Preparing Oracle Database for Installation

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, MAC-OS

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

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

After this the codeBeamer service is set up, and can be started/stopped using the service commands:

service codebeamer start
service codebeamer stop

See next:

• Important Files and Directories
• Post-installation Configuration