Skip to content

Administer TestGen

After installing TestGen, use the topics in this section to manage, configure, and maintain your deployment. These tasks are typically performed by the person who installed TestGen or manages the infrastructure it runs on.

Manage the application

TestGen runs as a Docker Compose application. Use the docker compose CLI to operate the application. All commands must be run in the directory that contains the docker-compose.yaml file generated by the installation.

Stop the application

docker compose down

Restart the application

docker compose up -d --wait

View application logs

To view real-time logs from the TestGen containers, use the following command. Press Ctrl+C to stop following.

docker compose logs -f

Configure your deployment

TestGen is configured through environment variables. After making changes, restart the application for them to take effect.

  • Set Environment Variables — apply environment variable settings and restart the application, in both Docker and pip install modes.
  • Configure HTTPS — serve the TestGen UI and API over TLS with an SSL certificate.
  • Configure Email Server — connect an SMTP email server to enable email notifications for profiling runs, test runs, monitor anomalies, and quality scorecards.
  • Configure SSO Authentication — integrate with an OpenID Connect identity provider for single sign-on. Enterprise
  • Set Custom Logo — replace the default logo on the navigation menu with your company branding. Enterprise

Maintain your deployment

  • Upgrade TestGen — update to the latest version of TestGen to receive new features and fixes.
  • Uninstall TestGen — remove TestGen and its data from your machine.