redgate/tdm repository overview

⁠Test Data Manager Docker Image

A Docker image version of the TDM GUI is available in preview alongside the existing Windows MSI installer⁠.

⁠Disclaimer

Please view Redgate’s Master Subscription EULA⁠ for the Redgate Test Data Manager software contained in this image.

As with all container images, this image will also contain third party software, which are subject to their own license. It is your responsibility to ensure that your use of this container image is in compliance with the relevant license terms. Redgate shall not be liable for your access and use of such third party software. Please refer to the Software Bill of Materials for this image to view the relevant third party license files for the software contained within.

⁠Docker compose file

It is recommended that you use the following docker-compose file as a starting point to configure the Docker image to your needs.

services:
  tdm:
    image: redgate/tdm:latest
    ports:
      - "5000:80" # First port is the host port, second is the container port.
      - "5001:443"
#    environment:
#      - TDM__TdmDatabaseEngine= # e.g. Sqlite or SqlServer
#      - TDM__ConnectionString= # e.g. Data Source=/data/TDM.sqlite or Server=sqlserver;Database=TDM;User Id=sa;Password=your_password;
#      - Kestrel__Certificates__Default__Path="/https/cert.pfx"
#      - Kestrel__Certificates__Default__Password="certpass"
    volumes:
      # /data: Location for configuration, sqlite database, encryption keys and other persisted data
      - tdm_data:/data # use named volume defined below

volumes:
  tdm_data: # named volume persists data in docker

Some commonly modified but optional sections have been left commented out. Even without those sections set, you should be able to get a working build of TDM Hub running without any further changes.

⁠Configuration

Note that unlike the MSI installer, the Docker image cannot be configured with a config.yml file. Environment variables must be used instead, as can be seen in the above docker-compose file.

All the configuration parameters normally available in the config.yml⁠ are instead set here using a TDM__ prefix.

For example, in the TDM config.yml file you'd set variables like this:

TDM:
  ConnectionString: Server=sqlserver;Database=TDM;User Id=sa;Password=your_password;
  AuthAuthority: https://login.microsoftonline.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx/v2.0/

For this Docker image, you'd instead configure it in the docker-compose file like this:

    environment:
      - TDM__ConnectionString=Server=sqlserver;Database=TDM;User Id=sa;Password=your_password;
      - TDM__AuthAuthority=https://login.microsoftonline.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx/v2.0/

⁠Bypassing the setup wizard

To bypass the setup wizard shown when first starting the container, set the environment variables mentioned here⁠ in your docker-compose file.