Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 3.45 KB

docker.md

File metadata and controls

51 lines (36 loc) · 3.45 KB
Raw

Docker

Docker is an open platform for developers and sysadmins to build, ship, and run distributed applications. In this project, it is software that lives on your local machine that allows you to run preconfigured development environments without extensive configuration. Specifically, this project uses Docker Compose to define and run the local development environment.

Note: The Docker configuration that comes with this project is not suitable for production hosting. It is intended for use in local or development environments only.

Installing

You must have docker and docker-compose installed on your local machine before using the Docker environments.

Mac | Windows

Configuration

All Docker configuration for this project lives in the docker-compose.yml file in the repository root. You may customize this file if you would like, or you may use the following files to customize your environment further:

  • docker/drupal.env - This file contains environment variables that are injected into the drupal container. It should be committed to the repository, so do not put anything sensitive in here.
  • .env - This file can contain environment variables that get referenced in docker-compose.yml. See .env.example for documentation on variables may be used.

For port configuration, changing the "exposed" port does not change the port inside of the container. Eg: If you change the MANNEQUIN_PORT variable to 8007, you should still run Mannequin inside of the container on 8081, but you will access it from your browser at localhost:8007.

Running

Use the docker-compose command on your host to interact with Docker.

  • Start all containers: docker-compose up -d
  • List running containers: docker-compose ps
  • Stop all containers: docker-compose stop
  • Download updates to all containers: docker-compose pull
  • Output the logs of the drupal container: docker-compose logs drupal
  • Remove all containers to reset your environment: docker-compose down

Note that MySQL data will not be removed, even when you remove the mysql container. To fully delete this data, use docker-compose down -v.

Accessing the Containers

When the containers are running, they are accessible on the following ports:

  • 8080: Direct connection to Drupal running on Apache.
  • 33306: Direct connection to MySQL. Useful for connecting to the database from the host machine. A direct mysql connection can be made from the outside via: mysql -h 127.0.0.1 --port 33306 -u drupal -pdrupal drupal

Optional containers (must be enabled before you can use them):

  • 8085: Varnish, connected to Drupal. If you want to use Varnish, uncomment it in docker-compose.yml
  • 8983: Solr direct connection. Useful for debugging via Apache Solr web interface.

Important: Should you choose to run this setup in production, you should always remove the debug ports (noted in docker-compose.yml) for security.

Troubleshooting

  • If you see an error message bringing up the containers that has something like "port is already allocated", it means that another application is already using one of the ports. You can set alternate ports in .env (see Confguration).