# How To Install Teamscale as a Linux Service

You might want to install Teamscale as a Linux service to allow for more consistent management with other services on the same machine and to ensure that Teamscale is automatically started after a reboot. Additionally, this allows Teamscale to automatically restart in case of a crash.

Note

Before installing Teamscale as a service, ensure that the basic configuration was completed and that Teamscale can be started manually.

The required files are located in the folder linux in the Teamscale installation directory. You can choose between a systemd-based installation or an init.d-based one.

# systemd

To see if your system supports systemd, check for the existence of the directory /lib/systemd. (This procedure was tested on Ubuntu 17.04.)

# Installing Teamscale as a systemd Service

  1. Modify the teamscale.service file according to the TODO comments inside.

  2. Copy the file to /etc/systemd/system.

  3. Enable the service to start at boot time by running the following command:

    sudo systemctl enable teamscale.service
    

To start the service manually use the following command:

sudo systemctl start teamscale.service

# Uninstalling the Teamscale systemd Service

  1. To uninstall the systemd service, run the following commands:

    sudo systemctl stop teamscale.service
    sudo systemctl disable teamscale.service
    
  2. remove the file you copied to /etc/systemd/system/teamscale.service

# init.d

The following guide is based on init.d , which is supported on most Linux distributions. (This procedure was tested with Ubuntu 12.04.)

# Installing Teamscale as a init.d Service

  1. Edit the file teamscale.init:

    1. Enter or edit the correct path to the Teamscale root directory. For example: TEAMSCALE_HOME=/opt/teamscale

    2. Enter or edit the correct path to the Java installation directory. For example:

      export JAVA_HOME=/opt/jdk
      
    3. Optionally uncomment and fill the EXTRA_START_ARGS line to run the services as a different user.

  2. Install the service by running from the command line:

    sudo ./install-service.sh teamscale
    
  3. Start the service by running the following command:

    sudo service teamscale start
    

# Uninstalling the Teamscale init.d Service

If you later have to uninstall the init.d service run the following command:

sudo ./uninstall-service.sh teamscale