Teamscale Documentation

# Installing the Teamscale Server

Not needed for Teamscale Cloud

If you are using Teamscale's Cloud offering, no server and installation is needed, as we handle all of this for you. You can head over directly to creating your first project.

If you are interested in our Cloud offering, please contact sales@teamscale.com.

This guide will show you how to get started with Teamscale in five simple steps:

Before installing Teamscale, make sure its system requirements are met.

Detailed Guides

This guide only describes the basics needed to get Teamscale up and running. For detailed information on the setup process, please refer to Server Administration.

# Downloading Teamscale

You can download Teamscale's latest version from our website (opens new window).

# Getting Your Evaluation License

To use Teamscale, you will need a valid license file (teamscale.license). If you don't have one yet, you can get a free evaluation license (opens new window).

Free for Academic Users

Academic users, including students and research groups, can get a free permanent license for Teamscale. Please contact sales@teamscale.com for details.

# Running Teamscale

  1. Unzip Teamscale into a directory of your choice.

  2. Place the license file teamscale.license in the config directory.

  3. Run Teamscale

    • On Windows: Run the file teamscale.bat by double clicking it.
    • On Linux & macOS: Run the file teamscale.sh by executing ./teamscale.sh.

  4. Visit http://localhost:8080 (opens new window) in your web browser:

    Teamscale's Login Screen

Production Usage

For production use, we recommend to run Teamscale with Docker or as a system service. Please refer to the installation instructions for Docker, Linux Service or Windows Service for further details.

In order to further configure Teamscale for your host environment, consult the Administration of a Teamscale Installation reference.

Java

A prerequisite for starting Teamscale is that the Java is installed on the system. Either point the environment variable JAVA_HOME to an existing Java installation or put the Java executable on the execution PATH.

# Logging In

Enter the default admin credentials:

  • User: admin
  • Password: admin

Change Default Password

For security reasons, change your password before making your Teamscale instance available to others.

# Creating a Project

Now you are all set to create your first project in Teamscale. This is described in a follow-up article.

← Integrating with IntelliJ →