Comment on page

Director Service

Director service configuration options

Common Configuration
PORT=1234
Director will listen on that port
DASHBOARD_URL="http://localhost:8080"
"Run URL" shown by Cypress agent when running tests
INACTIVITY_TIMEOUT_SECONDS=180
Director uses the timeout value to define how long we should wait before checking for a run’s inactivity.
ALLOWED_KEYS=null
List of comma delimited record keys (provided to the Cypress Runner using --key option) which are accepted by the director service.
This can be useful when cypress is running on external CI servers and we need to expose director to the internet.
Empty or not provided variable means that all record keys are allowed.
GITLAB_JOB_RETRIES=false
Enables/disables the ability to retry tests by rerunning CI jobs on GitLab.
This functionality is only supported when using the mongo execution driver.
BASE_PATH="/"
Service's base path, useful for reverse proxies
Persistence Configuration
EXECUTION_DRIVER="../execution/in-memory"
Set the execution driver for Director service. Possible values are:
../execution/in-memory - Director will keep all the data in-memory. See Basic Setup.
../execution/mongo/driver - use MongoDB as a persistence. See Full Setup.
MongoDB Configuration
Used when mogo persistence configuration is selected. Refer to MongoDB Configuration.
Remote Storage Configuration
SCREENSHOTS_DRIVER="../screenshots/dummy.driver"
Set the execution driver for Director service. Possible values are:
../screenshots/dummy.driver - don't store anything, dummy driver
../screenshots/s3.driver - use AWS S3. See Full Setup for details.
../screenshots/minio.driver- use Minio. See Full Setup for details.
../screenshots/azure-blob-storage.driver- use Minio. See Full Setup for details.
​
AWS S3 Remote Storage Configuration
Refer to AWS S3 Configuration.​
Minio Configuration
Read Minio Configuration for Director
Azure Blob Storage Configuration
Refer to Azure Blob Storage Configuration​
Probe logs
PROBE_LOGGER=false
Enable or disable Director healthchecks logs.

Configuration - Previous

Full Setup

AWS Role Assumption via Service Account

Last modified 10mo ago