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

Run TestGen CLI commands¶

You can run TestGen CLI commands against the running container using docker compose exec.

docker compose exec engine testgen --help

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 in the docker-compose.yml file, under the x-common-variables section. After making changes, restart the application for them to take effect.

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.