sorry-cypress
  • Documentation
  • Guide
    • Get Started
    • Dashboard and API
    • Cloud Setup
  • Cloud
    • AWS
      • Basic AWS Setup
      • Advanced AWS Setup
      • AWS Networking
      • AWS S3 Manual Setup
    • Google Cloud
      • Google Cloud & MinIO - Deprecated
    • Microsoft Azure
    • Heroku
    • Kubernetes
    • Docker Images
  • Integrating Cypress
    • Integration options
    • cy2 - Deprecated
    • Agent Configuration - Deprecated
    • CLI One Liners - Deprecated
  • Configuration
    • Basic Setup
    • Full Setup
    • Director Service
      • AWS Role Assumption via Service Account
      • AWS S3 Configuration
      • Minio Configuration
      • Azure Blob Storage Configuration
    • API Service
    • Web Dashboard
      • Configuration
    • MongoDB Configuration
    • Troubleshooting
  • Integrations
    • Events
    • Webhooks
    • Slack Integration
    • GitHub Integration
    • BitBucket Integration
    • MS Teams Integration
  • Concepts
    • Parallelization Explained
    • Flaky Tests
    • Test Details
    • Test Status
  • CI
    • GitHub Actions
    • Travis
    • Jenkins
    • AWS Codebuild
  • Development
    • Changelog
    • Development Guide
  • Community Content
  • ❤️ Contributions
  • Support
  • Legal
  • FAQ
Powered by GitBook
On this page
  • Common Configuration
  • Persistence Configuration
  • MongoDB Configuration
  • Remote Storage Configuration
  • AWS S3 Remote Storage Configuration
  • Minio Configuration
  • Azure Blob Storage Configuration
  • Probe logs
Edit on GitHub
  1. Configuration

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:

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

AWS S3 Remote Storage Configuration

Minio Configuration

Azure Blob Storage Configuration

Probe logs

PROBE_LOGGER=false

Enable or disable Director healthchecks logs.

PreviousFull SetupNextAWS Role Assumption via Service Account

Last updated 2 years ago

../execution/in-memory - Director will keep all the data in-memory. See .

../execution/mongo/driver - use MongoDB as a persistence. See .

Used when mogo persistence configuration is selected. Refer to .

../screenshots/s3.driver - use AWS S3. See for details.

../screenshots/minio.driver- use Minio. See for details.

../screenshots/azure-blob-storage.driver- use Minio. See for details.

Refer to

Read for Director

Refer to

Basic Setup
MongoDB Configuration
AWS S3 Configuration.
Minio Configuration
Azure Blob Storage Configuration
Full Setup
Full Setup
Full Setup
Full Setup