This project provides scaffolding to build a containerized Drupal webserver.
- .ebextensions/ - Files run when deploying the application to Elastic Beanstalk
- docker/ - Files used to build the docker image which runs the webserver.
- docker/apache2/ - Apache2 config files.
- docker/my_init.d/ - Scripts to run when the container first starts.
- web/ - The webroot in which Drupal is installed.
- docker-compose.yml/ - Config for running development environment locally.
- Dockerrun.aws.json/ - Config for running staging and production environments on Elastic Beanstalk.
- composer.json/ - Dependencies to install via composer.
- composer.lock/ - Dependencies resolved via composer. Commit this to ensure that Composer doesn't automatically upgrade dependencies in staging/production environments. Run
composer updatein local development environment to rebuild.
Run source utils.sh to load utility commands.
- drun - Runs the local development environment. (usually preceded by
image-build) - dps - Lists running docker containers.
- dlog - Shows log output from current running app container.
- dbash - Interactive terminal in running app container.
- build-image - Build the docker image locally.
- push-image - Pushes the docker image to the image repository with the provided tag.
The below environment variables may be configured in docker-compose.yml(for dev environment), Dockerrun.aws.json(for staging and production), and/or via the Elastic Beanstalk environment configuration. Elastic Beanstalk environment variables overwrite those defined in Dockerrun.aws.json, using this you can change variables on a running environment without pushing new code.
| Name | Type | Description |
|---|---|---|
| PRIMARY_DOMAIN | Hostname | The primary domain name for this environment. Ex: 'some.project.com' |
| ALTERNATE_DOMAINS | Hostnames | Additional domain names/CNAMES for which https certificates should be registered (comma-seperated). |
| ADMIN_EMAIL | The email used to register ssl certs. May receive ssl cert expiry notices. | |
| SECRETS_STORE | S3 bucket/prefix | The S3 bucket and prefix in which the secrets for this environment are stored. Ex: 's3://nemac-secrets/staging-some-project-com/') |
| ASSET_STORE | S3 bucket/prefix | The S3 bucket and prefix in which the assets for this environment are stored. Ex: 's3://nemac-assets-us-east-1/some-project-com/') |
| ENABLE_HTTPS | true|false | Enables https and certbot. |
| FORCE_HTTPS | true|false | Enables http redirect (301) to https and turns on HSTS. |
| ENABLE_DEBUGGING | true|false | Enables error printing, xdebug, and more. Do not enable in production. See: debugging. |
| XDEBUG_REMOTE_HOST | IP | IP that XDEBUG should connect to. For dev environment this will be the ip of the docker-machine, for staging it will be 127.0.0.1 and ssh port forwarding should be used. Do not enable in production. |
Add 127.0.0.1 PRIMARY_DOMAIN to your hosts for local development.
Run source utils.sh to load utility commands.
- drun - Runs the local development environment. (usually preceded by
image-build) - dps - Lists running docker containers.
- dlog - Shows log output from current running app container.
- dbash - Interactive terminal in running app container.
- drush - Runs
drushin running app container. - composer - Runs
composerin running app container. - build-image - Build the docker image locally.
- checkout-image - Pulls specified docker image version from the ECR repository and tags it for use in local development environment.
- push-image - Pushes current local development image to AWS ECR repository with the specified version tag.
Setting ENABLE_DEBUGGING in docker-compose.yml (for local), Dockerrun.aws.json (for all remotes), or using CloudFormation (for a specific stack) will turn on XDEBUG (for which you will need a debugging client)
Adding your public key in .ebextensions/keys.config where indicated will allow you to ssh into instances using ssh ec2-user@instancehostname. Once connected, logs can be found in /var/log/, deployed application source is visible at /var/app/current/ and running dbash will get you an interactive terminal in the current running app container. dps gives some stats on how long it has been running. If no container is running dps will show only the "ecs-agent" container, at which point logs from failed containers can be found in /var/log/containers.
- If you encounter errors about files not existing in
/vendor, destroy it, then re-rundrunas this indicates a failed composer install. - Because multiple projects are using the same docker image repository, changes for a single project should be pushed with a prefix for that project (Ex:
cohesivefire-1.04) andDockerrun.aws.jsonshould be updated to use that image.
Drupal w/ Composer project docs Composer Docs Drush commands Workflow for configuration sync between environments using the web interface Workflow for configuration sync between environments using git