Director Service
PORT=1234
Director will listen on that port
DASHBOARD_URL="http://localhost:8080"
"Run URL" shown by Cypress agent when running tests
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.
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_URI="mongodb://mongo:27017"
MongoDB connection URL, required if using "mongo" execution driver.
MONGODB_DATABASE="sorry-cypress"
MongoDB database name, required if using "mongo" execution driver.
MONGODB_AUTH_MECHANISM
MongoDB authentication mechanism. See MongoDB Authentication.
MONGODB_AUTH_USER
MongoDB authentication user, when authentication mechanism is DEFAULT.
MONGODB_AUTH_PASSWORD
MongoDB authentication password, when authentication mechanism is DEFAULT.
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.
AWS_ACCESS_KEY_ID=null
AWS Access Key
AWS_SECRET_ACCESS_KEY=null
AWS Secret
S3_BUCKET="sorry-cypress"
AWS S3 Bucket name
S3_REGION="us-east-1"
AWS S3 Region
S3_ACL="public-read"
AWS S3 ACL for putObject operation
S3_READ_URL_PREFIX=null
Custom prefix for generating "read" URL for generated artifacts. By default, the read ${S3_BUCKET}.s3.amazonaws.com/${objectKey}, if S3_READ_URL_PREFIXis set, then it becomes ${S3_READ_URL_PREFIX}/${objectKey}
S3_IMAGE_KEY_PREFIX=null
Custom prefix for stored images, if set the prefix will be applied e.g.: ${S3_BUCKET}.s3.amazonaws.com/${S3_IMAGE_KEY_PREFIX}${objectKey}
S3_VIDEO_KEY_PREFIX=null
Custom prefix for stored videos, if set the prefix will be applied e.g.: ${S3_BUCKET}.s3.amazonaws.com/${S3_VIDEO_KEY_PREFIX}${objectKey}
Treat your Minio keys and secrets AWS credentials and hide them.
Refer todocker-compose.minio.ymlfor Minio setup example.
MINIO_ACCESS_KEY="defaultAccessKey"
Minio Access Key
MINIO_SECRET_KEY="defaultSecret"
Minio Secret
MINIO_BUCKET="sorry-cypress"
Bucket name for storing generated artifacts. Please make sure that the bucket is created and configured properly before using it.
MINIO_URL="https://storage.yourdomain.com"
The public URL used for public read access to the stored screenshots and videos. This URL should be available from your browser and it will be used to fetch generated screenshots and videos.
MINIO_PORT=9000
Port that director and cypress agents will use to communicate with Minio.
MINIO_ENDPOINT="storage.yourdomain.com"
Hostname or IP address that both director and cypress agents will use to communicate with minio service.
Please make sure that your network configuration allows access to Minio resource for cypress agents and for Director service
To run on the local machine, edit your
/etc/hostsfile to allow cypress agents discover the local instance of Minio127.0.0.1 localhost
MINIO_READ_URL_PREFIX=null
You can override the whole read URL, including the bucket name using this variable. Most chances you won't need it, if you do, see the source code.
MINIO_USESSL="false"
Whether director should use SSL for communicating with minio.
REDIS_URI=redis://redis:6379
Setting REDIS_URI allows director to use redis queue for running delayed tasks. Delayed tasks are being used to implement Inactivity Timeout for runs. When set, director will try to set up delayed tasks using the provided redis connection, instead of in-memory timeouts.
