LATEST VERSION: 4.0 - RELEASE NOTES
Pivotal tc Server v4.0
Download Ask for Help Knowledge Base

Quick Start

This section provides quick-start instructions for installing Pivotal tc Server Standard Edition, creating a tc Runtime instance, and starting the tc Runtime instance.

If you are upgrading an existing tc Server installation, see the upgrade documentation. If you are installing tc Server Developer Edition, see Install tc Server Developer Edition.

Install tc Server - Unix (Linux, OSX, etc. non-RPM)

These steps will install and setup tc Server similar to how the RPM packages install tc Server. The directory locations are recommended but not required.

  1. Download and install a JDK or JRE on the computer on which you are installing tc Server. See Supported Configurations and System Requirements. A JDK is preferred as there are additional debug tools such as jstack which makes it easier to obtain thread dumps.

  2. Determine the user that is going to create and run the tc Runtime instances, and create it if necessary. Consider creating a user dedicated to tc Server tasks and disabling its interactive login for security purposes. On Unix, never run tc Runtime instances as the root user. See Setting Up Unix Users for tc Server.

  3. Log in to the computer on which you are installing tc Server as the appropriate user. On Unix, if you have disabled interactive login, login as a user with sudo privileges and use su -s /bin/sh tcserver to become the user. It is not recommended that the tcserver user have sudo privileges. On Windows, this should be a user with Administrator privileges.

  4. Create a directory to contain the tc Runtime component (such as /opt/pivotal/tcserver) if it doesn’t already exist. The user should be able to run sudo as part of the install. The user should be be able to run sudo (Unix) or have Administrative privileges (Windows). This does not need to be the tcserver user mentioned above as permissions will be set up later for that user.

    Unix example:

    sudo mkdir -p /opt/pivotal/tcserver

    Windows example:

    mkdir \opt\pivotal\tcserver\standard

  5. See Obtaining tc Server for instructions on how to download tc Server Standard Edition. For UNIX based platforms the .tar.gz file is recommended and .zip is recommended for Windows.

    This is all that is required to install tc Runtime.

    For example, in Unix, if you specified a directory called /opt/pivotal/tcserver in the preceding step and downloaded the Standard Edition file to your home directory:

    Unix (tar.gz) example:

    cd /opt/pivotal/tcserver
sudo tar xzf ~/pivotal-tc-server-standard-4.0.2.RELEASE.tar.gz

    Windows (zip):

    In Windows Explorer, double-click the ZIP file you downloaded to launch the Windows Extraction Wizard and extract the file into the directory you created in the preceding step. After you unzip the ZIP file you will have a directory called \opt\pivotal\tcserver\standard/pivotal-tc-server-standard-4.0.2.RELEASE. This directory contains all the tc Runtime files and directories.

  6. Add tcserver to your PATH variable. This procedure varies based on your operating system and your own internal policies. The following are the recommended methods

    Unix: Create a file named /etc/profile.d/tcserver.sh and add the following

    export PATH=$/opt/pivotal/tcserver/standard-4.0.2.RELEASE:$PATH

    Change 4.0.2.RELEASE to the version you downloaded if different.

    You’ll need to log out and back in our source that file. Example

    . /etc/profile.d/tcserver.sh

    Windows:

    1. Open Control Panel
    2. Open System
    3. Select Advanced tab
    4. Under System Variables select Path then click Edit
    5. Add \opt\pivotal\tcserver\standard\standard-4.0.2.RELEASE
    6. Click Ok
    7. Restart command prompt if open

Create and start a tc Runtime instance

  1. From your terminal window or Command Prompt, change to the tc Runtime directory and execute the tcserver command to create a basic tc Runtime instance (called myserver in the examples).

    Unix example:

    tcserver create  myserver

    The example commands used in this documentation assume that the PATH environment variable has been updated to point to the directory containing the tcserver script. If not you will need to call the script directly from the directory, however, it is recommended to set up the PATH variable.

  2. Execute the tcserver command to start the new tc Runtime instance; use the -i option to specify the directory in which the instance is located.

    Unix example:

    tcserver start myserver

    Windows example:

    tcserver install myserver
tcserver start myserver

Windows Note: Due to tc Runtime instances running as Windows Services it is necessary to install the instance as a service prior to starting the instance.

To confirm that the tc Runtime instance is running, invoke its welcome page in a browser. Use the URL http://host:8080, where host is the name or IP address of the computer on which the tc Runtime instance is running (localhost if local).

What to do next