Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mogtofu33/docker-compose-drupal

Drupal 8 Docker Compose dev stack.
https://github.com/mogtofu33/docker-compose-drupal

composer docker drupal drupal-8 drupal-project drupal8

Last synced: 6 days ago
JSON representation

Drupal 8 Docker Compose dev stack.

Awesome Lists containing this project

README 

        
# Drupal 8 Docker Compose Development



[![pipeline status](https://gitlab.com/mog33/docker-compose-drupal/badges/master/pipeline.svg)](https://gitlab.com/mog33/docker-compose-drupal/commits/master)



- [Requirements](#requirements)

- [Description](#description)

  - [What's this?](#whats-this)

  - [Services included](#services-included)

    - [Database management](#database-management)

- [Quick demo (Ubuntu)](#quick-demo-ubuntu)

- [Installation and configuration](#installation-and-configuration)

  - [Project installation](#project-installation)

  - [Option 1: existing Drupal 8 project](#option-1-existing-drupal-8-project)

    - [Copy codebase](#copy-codebase)

    - [Import database](#import-database)

    - [Launch the stack](#launch-the-stack)

    - [Access the minimal dashboard](#access-the-minimal-dashboard)

  - [Option 2: setup Vanilla Drupal 8 with Composer](#option-2-setup-vanilla-drupal-8-with-composer)

    - [Code download](#code-download)

    - [Launch the stack](#launch-the-stack-1)

    - [Install Drupal 8](#install-drupal-8)

    - [Access your Drupal 8](#access-your-drupal-8)

- [Daily usage](#daily-usage)

  - [Add some modules](#add-some-modules)

  - [Enable some modules](#enable-some-modules)

  - [Run a command on the server](#run-a-command-on-the-server)

  - [Access the server with bash](#access-the-server-with-bash)

- [Reset the stack](#reset-the-stack)

  - [Destroy containers](#destroy-containers)

  - [Remove your persistent data (and lost everything!)](#remove-your-persistent-data-and-lost-everything)

- [Linux helpers](#linux-helpers)

- [Upgrade](#upgrade)

- [Suggested tools](#suggested-tools)

- [Troubleshooting](#troubleshooting)

  - [General problem](#general-problem)

  - [Port 80](#port-80)

  - [Windows](#windows)



**Full** Linux support. Tested daily on Ubuntu 16+.



**Windows** support is **very, very limited** due to Docker for [Windows permissions problems](https://github.com/docker/for-win/issues/1829) and no privileged support :(



**Mac** support is **very limited** due to the fact that I don't have a Mac!



## Requirements



- [Docker engine 19+](https://docs.docker.com/install)

- [Docker compose 1.26+](https://docs.docker.com/compose/install)



**Recommended**



- [Composer](https://getcomposer.org)



## Description



### What's this?



Based mostly on [Docker official images](https://hub.docker.com/search/?type=image&image_filter=official) and lightweight [Alpine Linux](https://alpinelinux.org/) to ease maintenance and size.



This stack is meant to be used as a single [Drupal 8](https://www.drupal.org/8) project only with quick setup, run and destroy workflow.



The purpose is to give flexibility in management, try to rely as much as possible on official tools to avoid any new custom patterns.



This stack is not a one line command but more for users with a good dev-op level and knowledge on each technology used.



See other great project for a Docker based development



- [Lando](https://docs.devwithlando.io/tutorials/drupal8.html)

- [Docksal](https://docksal.io/)

- [ddev](https://github.com/drud/ddev)

- [docker4drupal](https://github.com/wodby/docker4drupal)



### Services included



_Every service is optional as declared in the yml file._



- Apache

- Nginx

- Php 7.3 / 7.4 fpm with Xdebug

- MariaDB

- PostgreSQL

- [Memcache](https://hub.docker.com/_/memcached)

- [Redis](https://redis.io/)

- [Mailhog](https://github.com/mailhog/MailHog)

- [Solr](http://lucene.apache.org/solr)

- [Dashboard](https://cloud.docker.com/u/mogtofu33/repository/docker/mogtofu33/dashboard): a very minimal docker dashboard for this stack

- [Portainer](https://github.com/portainer/portainer): (Optional) a full Docker dashboard / manager



#### Database management



- [Adminer](https://www.adminer.org)



## Quick demo (Ubuntu)



Get this project



```bash

wget https://gitlab.com/mog33/docker-compose-drupal/-/archive/master/docker-compose-drupal-master.tar.gz

tar -xzf docker-compose-drupal-master.tar.gz

cd docker-compose-drupal-master

```



Install this stack with minimal services, download and install Drupal 8 with

profile [Demo Umami](https://www.drupal.org/project/demo_umami)



```bash

make demo

```



## Installation and configuration



### Project installation



Grab this project



```bash

wget https://gitlab.com/mog33/docker-compose-drupal/-/archive/master/docker-compose-drupal-master.tar.gz

tar -xzf docker-compose-drupal-master.tar.gz

cd docker-compose-drupal-master

```



Create your docker compose file from template



```bash

cp docker-compose.tpl.yml docker-compose.yml

cp default.env .env

```



_Optional:_ Edit configuration



Recommended on Unix add your local uid/gid.



```bash

vi .env

```



_Optional:_ Customize the stack



Choose a database, remove or add services, add your composer cache folder if needed on service `php`.

Do not touch for a default quick stack.



```bash

vi docker-compose.yml

```



Check the yml file and fix if there is an error message



```bash

docker-compose config

```



### Option 1: existing Drupal 8 project



#### Copy codebase



For an existing Drupal 8 project, copy it here in a folder named `drupal`.



So you have your composer.json file in `drupal\composer.json`



Note that based on Composer template web root must be under `drupal/web`

folder. If not you need to adapt Apache vhost config from

`config/apache/vhost.conf`



```bash

cp -r _YOUR_DRUPAL_ drupal

```



#### Import database



For **MySQL**, copy your database dump **uncompressed** in `./database/mysql-init/*.sql`, it

will be automatically imported on the first launch of the stack.



For **PostgresSQL**, copy your database dump **uncompressed** in `./database/pgsql-init/*.pg_dump`, it

will be automatically imported on the first launch of the stack.



If you want to manually import your database with adminer or included helper scripts

with _Linux_you can skip this step.



#### Launch the stack



```bash

docker-compose up --build -d

```



Wait and check the import of your database dump with (change mysql to pgsql if needed)



```bash

docker-compose logs mysql

```



#### Access the minimal dashboard



- [http://localhost:8181](http://localhost:8181)



### Option 2: setup Vanilla Drupal 8 with Composer



#### Code download



Setup a new Drupal 8 based on a Composer project.



Based on [Drupal 8 template](https://github.com/drupal-composer/drupal-project), include [Drush](http://www.drush.org) and [Drupal console](https://drupalconsole.com/), using [Composer](https://getcomposer.org) locally:



```bash

composer create-project drupal-composer/drupal-project:8.x-dev drupal --stability dev --no-interaction

```



#### Launch the stack



```bash

docker-compose up --build -d

```



#### Install Drupal 8



To use **PostGreSQL** change **mysql** to **pgsql**



You can replace **standard** by an other profile as **minimal** or **demo_umami** for [Drupal 8.6+](https://www.drupal.org/project/demo_umami).



```bash

docker exec -it -u apache dcd-php /var/www/localhost/vendor/bin/drush -y site:install standard \

    --root=/var/www/localhost/web \

    --account-name=admin \

    --account-pass=password \

    --db-url=mysql://drupal:drupal@mysql/drupal

    #--db-url=pgsql://drupal:drupal@pgsql/drupal

```



#### Access your Drupal 8



- [http://localhost](http://localhost)



Login with _admin_ / _password_:



- [http://localhost/user/login](http://localhost/user/login)



## Daily usage



### Add some modules



```bash

docker exec -it -u apache dcd-php \

    composer --working-dir=/var/www/localhost require \

    drupal/admin_toolbar drupal/ctools drupal/pathauto drupal/token drupal/panels

```



With _Linux_, you can use included helper script



```bash

scripts/composer require drupal/admin_toolbar drupal/ctools drupal/pathauto drupal/token drupal/panels

```



### Enable some modules



```bash

docker exec -it -u apache dcd-php \

    /var/www/localhost/vendor/bin/drush -y en \

    --root=/var/www/localhost/web \

    admin_toolbar ctools ctools_block ctools_views panels token pathauto

```



With _Linux_, you can use included helper script



```bash

scripts/drush -y en admin_toolbar ctools ctools_block ctools_views panels token pathauto

```



### Run a command on the server



```bash

docker exec -it -u apache dcd-php \

    ls -lah /var/www/localhost/web

```



### Access the server with bash



```bash

docker exec -it -w /var/www/localhost -u apache dcd-php bash

```



## Reset the stack



### Destroy containers 



_Note:_ `./drupal/` is persistent but NOT the database files!



Save your database under _Linux_



```bash

scripts/mysql dump

scripts/pgsql dump

```



Stop and remove containers



```bash

docker-compose down

```



### Remove your persistent data (and lost everything!)



```bash

rm -rf data

```



## Linux helpers



For Ubuntu (16+) or Linux you can find in `./scripts/` multiple helpers to quickly

run some daily commands from root folder, and drush/drupal links at the root.



```bash

# Run drush or drupal within the container

scripts/drush status

scripts/drupal site:status

# Quickly dump/restore/drop your DB

scripts/mysql --help

scripts/pgsql --help

# Run composer as a service without local installation

scripts/composer --help

scripts/composer status

```



Install Drupal 8 variant helpers (This delete and replace existing Drupal in `./drupal` folder)



```bash

scripts/install-drupal.sh

scripts/install-drupal.sh list

scripts/install-drupal.sh install -p drupal-demo

```



## Upgrade



Because this project is mainly focused on a one time usage, there is currently

**no upgrade path** and the best way to upgrade is to dump and copy your project to

a new version of this project.



## Suggested tools



- [Opcache GUI](https://github.com/amnuts/opcache-gui)

- [Phpmemcacheadmin](https://github.com/wp-cloud/phpmemcacheadmin)

- [Xdebug GUI](https://github.com/splitbrain/xdebug-trace-tree)

- [Adminer extended](https://github.com/dg/adminer-custom)

- [Php Redis Admin](https://github.com/ErikDubbelboer/phpRedisAdmin)



You can find a script for Linux in `scripts/get-tools.sh` folder to download or update all tools



```bash

chmod +x scripts/get-tools.sh

./scripts/get-tools.sh install

```



## Troubleshooting



### General problem



In case of any problem, first step is to check the configuration and the logs



```bash

docker-compose config

docker-compose logs

```



### Port 80



If you have already a web server running on port __80__ or __443__ on your machine

you must stop it or change __APACHE_HOST_HTTP_PORT__ in __.env__



### Windows



Windows support very partial, before running docker-compose you must run in Powershell



```powershell

$Env:COMPOSE_CONVERT_WINDOWS_PATHS=1

```



Some permissions and privileged problems



- [This issue](https://github.com/docker/for-win/issues/1829)



----

Want some help implementing this on your project? I provide Drupal 8 expertise as a freelance, just [contact me](https://developpeur-drupal.com/en).