PHPackages bradjonesllc/docker-drupal - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. bradjonesllc/docker-drupal AbandonedArchivedProject[DevOps & Deployment](/categories/devops) bradjonesllc/docker-drupal ========================== Project template for Drupal 8 with Composer and Docker v2.2(7y ago)393558[11 issues](https://github.com/BradJonesLLC/docker-drupal/issues)GPL-2.0+PHP Since May 2Pushed 5y ago1 watchersCompare [ Source](https://github.com/BradJonesLLC/docker-drupal)[ Packagist](https://packagist.org/packages/bradjonesllc/docker-drupal)[ RSS](/packages/bradjonesllc-docker-drupal/feed)WikiDiscussions master Synced 4w ago READMEChangelog (4)Dependencies (10)Versions (6)Used By (0) ARCHIVED! Don't use this. ------------------------- [](#archived-dont-use-this) It was nice while it lasted but Composer and Docker have come a long way, and this repository is a vestige of a bygone era. Things are simpler now - use `drupal/recommended-project` et. al. Docker Scaffolding for Drupal 8 =============================== [](#docker-scaffolding-for-drupal-8) [![Docker Automated buil](https://camo.githubusercontent.com/f89d6b9f056af60d324e88c478abdb56d8e83222a138a796bbaf8adee1cabfde/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f6175746f6d617465642f627261646a6f6e65736c6c632f646f636b65722d64727570616c2e7376673f6d61784167653d32353932303030)](https://hub.docker.com/r/bradjonesllc/docker-drupal)[![Packagist](https://camo.githubusercontent.com/24dae6edbe0c617f021714f302d910231a4fd5f9ff231cfc50ed0280c39c8d67/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f627261646a6f6e65736c6c632f646f636b65722d64727570616c2e7376673f6d61784167653d32353932303030)](https://packagist.org/packages/bradjonesllc/docker-drupal) Purpose ------- [](#purpose) This repository provides two artifacts: 1. A Composer package intended for one-time, initial scaffolding of a new [Drupal 8](http://drupal.org) project, which would then be self-contained. It uses a `composer.json` file derived from [drupal-project](https://github.com/drupal-composer/drupal-project)to pull in Drupal core, and provides additional helpful Docker-focused functionality. The drupal-project `composer.json` file and helper scripts can then be used to manage core updates, contrib modules and more. Drupal 8, with its robust exportable configuration file management and Composer integration, is uniquely suited for containerized development. 2. A Docker image tailored for use with the enclosed project scaffolding. Its behavior is largely dictated by the files in `config/docker/web/base`, however they may be overridden on a project-specific basis by copying over the files at the appropriate destination. **Use this image at your own risk, understanding that backwards-compatibility in your particular case may not be guaranteed. For safest results, build your own base images.** Usage/Quick-Start ----------------- [](#usagequick-start) ``` composer create-project --stability dev --no-interaction --ignore-platform-reqs bradjonesllc/docker-drupal:^2 PROJECT-DIR ``` ...Will install into a new directory named `PROJECT-DIR`. ### Default addresses and command examples [](#default-addresses-and-command-examples) - Start for first time; create data container, install Drupal: `docker-compose up` - Web: `http://localhost:8082` - Get a login for uid 1, after install: `docker-compose exec web drush uli` (See below for shortcut options) Features -------- [](#features) Your new Drupal 8 site comes with a number of helper scripts and config files that speed development in a containerized environment and production deployment. - A `Dockerfile` that includes all required PHP extensions for Drupal 8 - A quick-start [Docker Compose](https://docs.docker.com/compose/) file, which provides an Apache/PHP web container, mysql container and data volume. - Site installation with: - Optional force-set of an existing site UUID and import of configuration files, if present. - Sensible default `settings.php`, `settings.local.php` and `development.services.yml` files. - Scripts respond to environment variables, with defaults in the docker-compose.yml file: - In development mode, enables Xdebug for Apache, and toggles inclusion of `settings.local.php` and `development.services.yml` - Wrapper scripts: - `ddrush`, for executing [drush](https://github.com/drush-ops/drush) inside the web container, with a starter global `/etc/drush/drushrc.php` file. - `dbash`, a shortcut for getting a bash shell inside the web container (as *www-data*) - An `.envrc` file, for use with [direnv](http://direnv.net/), that: - Tells wrapper scripts the correct container to execute against (by pattern). - Includes the wrapper script and the `vendor/bin` directory into the PATH. - Xdebug for development, and all invocations of the `ddrush` helper script - `.dockerignore` excludes VCS and uploaded files. Docker runs `composer install`inside the container on build, though if your development environment includes many of those files, having them copied into the container saves some time on build. See *Development Workflow*, below. - All processes in the web container log to `STDOUT`; this is useful if you wish to aggregate your Docker container logs or integrate with an external log service. - Default configuration files for [PhpStorm](https://www.jetbrains.com/phpstorm/), including a server configuration and path mapping for Xdebug and setting max debug connections == 10 for [compatibility with](https://github.com/drush-ops/drush/issues/1534)Drush's subrequests. - A default cron implementation via crontab, which runs only when not in development mode. - Support for site-wide HTTP Basic authentication when the `HTPASSWD_USER`and `HTPASSWD_PASSWORD` environment variables are set, e.g., for a staging site. (Or mount in your own `/etc/.htpasswd` file to use.) ### Why ship with Xdebug? Won't it waste resources in production? [](#why-ship-with-xdebug-wont-it-waste-resources-in-production) Xdebug is not loaded/started when in development mode (see below), so while you are shipping a slightly-larger container, this setup avoids the need for a "Development-only" Dockerfile. Development Workflow -------------------- [](#development-workflow) **TL;DR:** Leverage composer as much as possible for managing your project. The drupal-project README is very helpful on this point (see above.) While a wrapper is provided for running drush inside the container, avoid using commands like `drush dl`. When using the default `docker-compose.yml` file, we inject the entire file structure on the host into the container, so your local file changes are reflected in real time. Asking drush to make filesystem changes outside the `sites/*/files` directory (`drush cache-rebuild` should be OK) may result in permissions errors and other weirdness. ### Development Mode [](#development-mode) Enable development mode (on by default) by setting the `ENVIRONMENT` environment variable == `DEV`. ### Version control notes [](#version-control-notes) **The proper way to include projects and other dependencies**, when using composer, is to add them as requirements in `composer.json` and then running `composer update`. As noted above, the contents of those dependencies are excluded by default in `.gitignore`, so you should only be versioning code custom to your site. ### `ddrush` helper script [](#ddrush-helper-script) Paired with the environment variable/PATH set with direnv (see above), you may execute most Drush commands inside the web container by typing `ddrush your-command` inside the project. (You may need to run `direnv allow`) in your shell, before starting work. More complex commands involving quoting are not passed through verbatim; run `dbash`first, then your `drush` command directly inside the container. ### Xdebug Usage on same host as Docker container [](#xdebug-usage-on-same-host-as-docker-container) [Toggle Xdebug](http://xdebug.org/docs/remote#starting) in your browser or HTTP request, and initiate a corresponding listening session in your IDE on port 9000. The provided PhpStorm configuration means you can just click the phone icon and go! ### Updating Drupal core [](#updating-drupal-core) drupal-project's post-install command will ensure your Drupal core "scaffolding" files are kept in sync with upstream. See drupal-project's README. ### What about Drupal 8 configuration? [](#what-about-drupal-8-configuration) To ship/version a copy of your site with exported configuration, dump the config to disk - `ddrush config-export` - and your config will be dumped to `config/drupal/sync`. That directory is set as writable by the Apache user in development mode, for ease of export. In a production environment, import your configuration with drush or the web UI. ### Patching [](#patching) Check out [composer-patches](https://github.com/cweagans/composer-patches) for an easy solution. #### Configuration management in development mode [](#configuration-management-in-development-mode) When the web container starts in with the environment variable `DRUPAL_INSTALL = TRUE`, the bootstrap script attempts to determine the presence of an installed Drupal database. If not found, the script will attempt to install Drupal, set the site UUID, and import any existing configuration. Thus you can re-use (or, not) a development database even across web container rebuilds. #### Database management in development mode [](#database-management-in-development-mode) As noted above, the bootstrap script contains some safeguards against installing over an existing database. Should you wish to (re-)start from scratch (or a fresh import of your exported configuration files), remove the `db` database container, then the `drupal_data` container. SSL Support ----------- [](#ssl-support) SSL termination is no longer bundled. In the spirit of Docker containers doing one task well, consider using [a proxy container](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion)in conjunction with a free [Let's Encrypt](https://letsencrypt.org/) certificate. Production Deployment --------------------- [](#production-deployment) ### Data Permanence [](#data-permanence) With development mode off, Drupal will expect to find an installed database at the `db` alias. Also, it's strongly suggested you mount host directories into the container at the locations in [`web-writeable.txt`](https://github.com/BradJonesLLC/docker-drupal/blob/master/config/docker/web/web-writeable.txt)so user and system-generated files are preserved. Requirements ------------ [](#requirements) - [Docker](https://docker.com) - [Docker Compose](https://docs.docker.com/compose/), for running containers locally. - Linux or similar virtualized environment with bash shell. Perhaps [Docker Toolbox](https://docs.docker.com/toolbox/overview/) will help if you're on Windows or Mac? - A local installation of [composer](http://getcomposer.org/) ### Highly Recommended [](#highly-recommended) - [direnv](http://direnv.net/) for zero-config use of `ddrush` drush wrapper and scripts in `vendor/bin`. Contributing ------------ [](#contributing) Issues and pull requests welcome; Both Drupal 8 and Docker are relatively new and fast-moving projects. There doesn't appear to be many other comprehensive starterkits for Docker and Drupal, so this is my effort at helping others avoid my steep learning curve on this front. ### Known Issues [](#known-issues) See the [confirmed bugs in the issue queue](https://github.com/BradJonesLLC/docker-drupal/labels/bug). See Also -------- [](#see-also) ### Other Projects [](#other-projects) There are a few other Drupal/Docker projects, though most appear focused on Drupal 7: - [dropdock](https://github.com/twinbit/dropdock) - [drude](https://github.com/blinkreaction/drude) - [bowline](https://github.com/davenuman/bowline) ### Groups and Resources [](#groups-and-resources) - [Docker group on groups.drupal.org](https://groups.drupal.org/docker) Copyright and License --------------------- [](#copyright-and-license) © 2016-2018, Brad Jones LLC. Licensed under GPL 2. ### Health Score 33 — LowBetter than 72% of packages Maintenance14 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community10 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~266 days Total 4 Last Release 2910d ago Major Versions v1.0 → v2.02016-09-07 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/981966?v=4)[Brad Jones](/maintainers/bradjones1)[@bradjones1](https://github.com/bradjones1) --- Top Contributors [![bradjones1](https://avatars.githubusercontent.com/u/981966?v=4)](https://github.com/bradjones1 "bradjones1 (111 commits)") --- Tags composerdockerdrupaldrupal-8 ### Embed Badge ![Health badge](/badges/bradjonesllc-docker-drupal/health.svg) ``` [![Health](https://phpackages.com/badges/bradjonesllc-docker-drupal/health.svg)](https://phpackages.com/packages/bradjonesllc-docker-drupal) ``` ### Alternatives [farmos/farmos A web-based farm record keeping application. 1.3k7.0k1](/packages/farmos-farmos)[helsingborg-stad/municipio A bootstrap theme for creating municipality sites. 4028.3k10](/packages/helsingborg-stad-municipio)[fourkitchens/sous-drupal-project Starter project for Sous a Drupal distribution featuring a theme based on Emulsify Design System. 141.1k](/packages/fourkitchens-sous-drupal-project) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)