docker-compose.yml

# Docker Compose configuration file.
#
# - Using a single file to work in local, CI and production environments.
# - Local overrides are possible using docker-compose.override.yml file.
# - Environment variables are read from .env file.
# - Containers will be named after the project directory.
# - Use inline comments containing '###' to have the line removed in CI.
# - Use inline comments starting with '##' to have the line being automatically
#   uncommented in CI.
#; - Comments starting with '#;', '#;<' or '#;>' (like the ones used for the
#;   current paragraph) are explaining Vortex inner workings and can be
#;   safely removed for your project. They are automatically removed when
#;   installing or updating Vortex.
#;
# See more about Docker at https://www.vortextemplate.com/docs/docker/
# For YAML support of anchors and references, see http://blog.daemonl.com/2016/02/yaml.html

# ------------------------------------------------------------------------------
# Variable aliases.
# ------------------------------------------------------------------------------

# Environment variables set in all containers during build and runtime.
#;< HOSTING_LAGOON
# Note that these variables are not read from here in Lagoon environment.
#;> HOSTING_LAGOON
x-environment: &default-environment
  TZ: ${TZ:-UTC}
  # Pass-through 'CI' variable used to identify the CI environment.
  CI: ${CI:-}
  ##SSMTP_MAILHUB: "127.0.0.1:1" # Closed port so that no message leaves an automated test run. Automatically uncommented in CI.
  # Pass-through 'ENVIRONMENT_TYPE' to override the auto-detected environment type.
  ENVIRONMENT_TYPE: ${ENVIRONMENT_TYPE:-}
  # Pass-through 'XDEBUG_ENABLE' to enable XDebug with "ahoy debug" or "XDEBUG_ENABLE=true docker compose up -d".
  XDEBUG_ENABLE: ${XDEBUG_ENABLE:-}
  # Local development URL.
  LOCALDEV_URL: &default-url ${COMPOSE_PROJECT_NAME:-example-site}.docker.amazee.io
  # Local development route used in Lagoon images and Pygmy to route requests.
  LAGOON_ROUTE: *default-url
  # Local database host (variable is not used in hosting environment).
  DATABASE_HOST: database
  # Local database name (variable is not used in hosting environment).
  DATABASE_NAME: drupal
  # Local database user (variable is not used in hosting environment).
  DATABASE_USERNAME: drupal
  # Local database password (variable is not used in hosting environment).
  DATABASE_PASSWORD: drupal
  # Local database port (variable is not used in hosting environment).
  DATABASE_PORT: 3306
  # Local database charset (variable is not used in hosting environment).
  DATABASE_CHARSET: utf8mb4
  # Local database collation (variable is not used in hosting environment).
  DATABASE_COLLATION: utf8mb4_general_ci
  # Trusted host patterns.
  DRUPAL_TRUSTED_HOSTS: ${DRUPAL_TRUSTED_HOSTS:-}
  # Drupal theme name.
  DRUPAL_THEME: ${DRUPAL_THEME:-olivero}
  # Drupal file paths.
  DRUPAL_PUBLIC_FILES: ${DRUPAL_PUBLIC_FILES:-sites/default/files}
  DRUPAL_PRIVATE_FILES: ${DRUPAL_PRIVATE_FILES:-sites/default/files/private}
  DRUPAL_TEMPORARY_FILES: ${DRUPAL_TEMPORARY_FILES:-/tmp}
  # Path to configuration files.
  DRUPAL_CONFIG_PATH: ${DRUPAL_CONFIG_PATH:-../config/default}
  #;< MODULE_SHIELD
  # Drupal Shield credentials.
  DRUPAL_SHIELD_USER: ${DRUPAL_SHIELD_USER:-}
  DRUPAL_SHIELD_PASS: ${DRUPAL_SHIELD_PASS:-}
  #;> MODULE_SHIELD
  #;< SERVICE_REDIS
  # Redis integration flag.
  DRUPAL_REDIS_ENABLED: ${DRUPAL_REDIS_ENABLED:-}
  #;> SERVICE_REDIS
  #;< MIGRATION
  # Local migration database host (not used in production).
  DATABASE2_HOST: database2
  # Local migration database name (not used in production).
  DATABASE2_NAME: drupal
  # Local migration database user (not used in production).
  DATABASE2_USERNAME: drupal
  # Local migration database password (not used in production).
  DATABASE2_PASSWORD: drupal
  # Local migration database port (not used in production).
  DATABASE2_PORT: 3306
  #;> MIGRATION

# The default user under which the containers should run.
x-user: &default-user
  # Change this if you are on linux and run with another user than id `1000`
  user: '1000'

# Volumes available in each container to share application data.
# See more about Docker host volume mounting at https://www.vortextemplate.com/docs/docker#host-volume-mounting-in-docker-based-projects
x-volumes: &default-volumes
  volumes:
    # All application files mounted into container.
    - .:/app:${VOLUME_FLAGS:-delegated} ### Local overrides to mount host filesystem. Automatically removed in CI and PROD.
    # Override mount for files to allow different type of syncing for optimised performance.
    - ./web/sites/default/files:/app/web/sites/default/files:${VOLUME_FLAGS:-delegated} ### Local overrides to mount host filesystem. Automatically removed in CI and PROD.
    # Use the same volumes in environments without host mounts support.
    ##- app:/app # Override for environment without host mounts. Automatically uncommented in CI.
    ##- files:/app/web/sites/default/files # Override for environment without host mounts. Automatically uncommented in CI.

# ------------------------------------------------------------------------------
# Services.
# ------------------------------------------------------------------------------

services:
  # CLI container, used for executing CLI commands such as Composer, Drush etc. Not used to handle web requests.
  cli:
    build:
      context: .
      dockerfile: .docker/cli.dockerfile
      args:
        WEBROOT: "${WEBROOT:-web}"
        PACKAGE_TOKEN: "${PACKAGE_TOKEN:-}"
        DRUPAL_PUBLIC_FILES: ${DRUPAL_PUBLIC_FILES:-sites/default/files}
        DRUPAL_PRIVATE_FILES: ${DRUPAL_PRIVATE_FILES:-sites/default/files/private}
        DRUPAL_TEMPORARY_FILES: ${DRUPAL_TEMPORARY_FILES:-/tmp}
        DRUPAL_THEME: ${DRUPAL_THEME:-}
        VORTEX_FRONTEND_BUILD_SKIP: ${VORTEX_FRONTEND_BUILD_SKIP:-}
      secrets:
        - package_token
    image: &cli-image ${COMPOSE_PROJECT_NAME:-example-site}
    environment:
      <<: *default-environment
    <<: *default-volumes
    # Mount volumes from the ssh-agent running in Pygmy to inject host SSH key into container. See https://pygmy.readthedocs.io/en/master/ssh_agent/
    volumes_from: ### Local overrides to mount host SSH keys. Automatically removed in CI.
      - container:amazeeio-ssh-agent ### Local overrides to mount host SSH keys. Automatically removed in CI.
    depends_on:
      wait-for-dependencies:
        condition: service_completed_successfully
    #;< STORYBOOK
    ports:
      - '${VORTEX_STORYBOOK_PORT:-6006}' # Storybook development server port in a container. Find port on host with `ahoy info` or `docker compose port cli 6006`.
    #;> STORYBOOK
    user: root
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: cli-persistent # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
      lagoon.persistent.name: &lagoon-nginx-name nginx-php # Mount the persistent storage of nginx-php pod into this container.
      lagoon.persistent: &lagoon-persistent-files /app/web/sites/default/files/  # Location where the persistent storage should be mounted.
      #;< STORYBOOK
      lagoon.volumes.storybook.path: &lagoon-storybook-path /app/web/themes/custom/your_site_theme/storybook-static/
      #;> STORYBOOK
    #;> HOSTING_LAGOON

  nginx:
    build:
      context: .
      dockerfile: .docker/nginx-drupal.dockerfile
      args:
        CLI_IMAGE: *cli-image
        WEBROOT: "${WEBROOT:-web}"
      additional_contexts:
        cli: "service:cli"
    environment:
      <<: *default-environment
    <<: [ *default-volumes, *default-user ]
    depends_on:
      - cli
      - php
    networks:
      - default # This is a standard network and is used for all other environments, where requests routing is not required and/or not supported.
      - amazeeio-network ### This network is supported by Pygmy and used to route all requests to host machine locally. Removed in CI.
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: nginx-php-persistent # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
      lagoon.name: *lagoon-nginx-name
      lagoon.persistent: *lagoon-persistent-files
      lagoon.persistent.class: slow
      #;< STORYBOOK
      lagoon.volumes.storybook.path: *lagoon-storybook-path
      #;> STORYBOOK
    #;> HOSTING_LAGOON

  # PHP FPM container. All web requests are going through this container.
  php:
    build:
      context: .
      dockerfile: .docker/php.dockerfile
      args:
        CLI_IMAGE: *cli-image
      additional_contexts:
        cli: "service:cli"
    environment:
      <<: *default-environment
    <<: [ *default-volumes, *default-user ]
    depends_on:
      - cli
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: nginx-php-persistent # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
      lagoon.name: *lagoon-nginx-name
      lagoon.persistent: *lagoon-persistent-files
      lagoon.persistent.class: slow
    #;> HOSTING_LAGOON

  database:
    build:
      context: .
      dockerfile: .docker/database.dockerfile
      args:
        IMAGE: "${VORTEX_DB_IMAGE:-uselagoon/mysql-8.4:26.9.0}" # Use custom database image (if defined) or fallback to standard database image.
    environment:
      <<: *default-environment
    <<: *default-user
    ports:
      - '3306' # Database port in a container. Find port on host with `ahoy info` or `docker compose port database 3306`.
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: mariadb # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
    #;> HOSTING_LAGOON

  #;< MIGRATION
  database2:
    image: "${VORTEX_DB2_IMAGE:-uselagoon/mysql-8.4:26.9.0}" # Use custom database image (if defined) or fallback to standard database image.
    environment:
      <<: *default-environment
      MYSQL_DATABASE: drupal
      MYSQL_USER: drupal
      MYSQL_PASSWORD: drupal
    <<: *default-user
    ports:
      - '3306' # Database port in a container. Find port on host with `ahoy info` or `docker compose port database2 3306`.
    labels:
      lagoon.type: mariadb # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
  #;> MIGRATION

  #;< SERVICE_REDIS
  redis:
    image: uselagoon/valkey-8:26.9.0
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: redis # Change to 'none' if dedicated Redis service is used. See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
    #;> HOSTING_LAGOON
  #;> SERVICE_REDIS

  #;< SERVICE_SOLR
  solr:
    build:
      context: .
      dockerfile: .docker/solr.dockerfile
    environment:
      <<: *default-environment
    volumes:
      - solr:/var/solr
    ports:
      - '8983' # Solr port in a container. Find port on host with `ahoy info` or `docker compose port solr 8983`.
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: solr # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
    #;> HOSTING_LAGOON
  #;> SERVICE_SOLR

  #;< SERVICE_CLAMAV
  clamav:
    build:
      context: .
      dockerfile: .docker/clamav.dockerfile
    environment:
      <<: *default-environment
    ports:
      - '3310' # Find port on host with `docker compose port clamav 3310`.
    networks:
      - default
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: basic
      lagoon.service.port: 3310 # See https://docs.lagoon.sh/using-lagoon-advanced/service-types/
      lagoon.autogeneratedroute: false
    #;> HOSTING_LAGOON
  #;> SERVICE_CLAMAV

  # Chrome container, used for browser testing.
  chrome:
    image: selenium/standalone-chromium:152.0
    environment:
      <<: *default-environment
    <<: *default-volumes
    depends_on:
      - cli
    ports:
      - '7900' # Find port on host with `docker compose port chrome 7900`.
    shm_size: '1gb' # Increase '/dev/shm' partition size to avoid browser crashing.
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: none # Do not deploy in Lagoon.
    #;> HOSTING_LAGOON

  # Helper container to wait for services to become available.
  wait-for-dependencies:
    image: drevops/docker-wait-for-dependencies:26.10.0
    depends_on:
      #;< SERVICE_CLAMAV
      - clamav
      #;> SERVICE_CLAMAV
      - database
      #;< MIGRATION
      - database2
      #;> MIGRATION
      #;< SERVICE_REDIS
      - redis
      #;> SERVICE_REDIS
      #;< SERVICE_SOLR
      - solr
      #;> SERVICE_SOLR
    command:
      #;< SERVICE_CLAMAV
      - clamav:3310
      #;> SERVICE_CLAMAV
      - database:3306
      #;< MIGRATION
      - database2:3306
      #;> MIGRATION
      #;< SERVICE_REDIS
      - redis:6379
      #;> SERVICE_REDIS
      #;< SERVICE_SOLR
      - solr:8983
      - curl -s "http://solr:8983/solr/drupal/select?q=*:*&rows=0&wt=json" | grep response
      #;> SERVICE_SOLR
    #;< HOSTING_LAGOON
    labels:
      lagoon.type: none # Do not deploy in Lagoon.
    #;> HOSTING_LAGOON

networks:           ### Use external networks locally. Automatically removed in CI.
  amazeeio-network: ### Automatically removed in CI.
    external: true  ### Automatically removed in CI.

volumes:
  app: {}
  files: {}
  #;< STORYBOOK
  #;< HOSTING_LAGOON
  storybook:
    labels:
      lagoon.type: persistent # The CLI and web containers run in separate pods, so the build needs shared storage.
  #;> HOSTING_LAGOON
  #;> STORYBOOK
  #;< SERVICE_SOLR
  solr: {}
  #;> SERVICE_SOLR

secrets:
  package_token:
    environment: PACKAGE_TOKEN