How to install Teamscale with Docker and docker-compose
We recommend running Teamscale with Docker and docker-compose. The images are available on Docker Hub. Please note that we do not provide a latest tag.
Prerequisites
To run Teamscale with Docker, you have to install Docker and docker-compose. On Windows, docker-compose is included in the Docker installation.
Minimal Version
Since Teamscale 8.3.0 at least version 20.10.10 of Docker is required. Run docker version to check the installed version.
On Linux, please ensure that both docker and docker-compose are on your PATH and can be run from your command line. You must run all docker and docker-compose commands as root. Either use a root shell or prefix the commands with sudo.
Run docker version and verify that no errors are printed on the command line.
Use WSL 2 under Windows for Better Performance
When using Docker on Windows, running Docker from the Windows CLI has worse performance than running it from within the Windows Subsystem for Linux 2. Within WSL 2, mounting folders from the Windows host's file system, e.g. /mnt/c/, also has worse performance than mounting a WSL 2 path. Thus, we recommend that you run Docker from within your WSL 2 Linux distribution of choice and store all Teamscale-related files inside the WSL Linux.
Docker Compose Setup
We recommend a setup that contains NGINX as reverse proxy and two Teamscale instances. The second instance is used as shadow instance during updates. You can find a complete docker-compose based setup in our reference configuration on Github.