This is an extended version of Drupal Composer template, with some changes/addons to get started faster and preferring some conventions.
Default will be using:
A profile based on Minimal that enables and configures defaults to use Redis and Solr. (This is work in progress)
docker-compose
.env.development
to .env
and /.salt.example
to /app/.salt
docker/drupal/entrypoint.sh:19
docker-compose up
composer install
and installing Drupal)CTRL-C
and wait for the services to terminate (it's important!)To use Drupal's Drush or Console in another terminal run docker-composer exec drupal /bin/bash
and it will allow you to interact with Drupal from the shell as expected.
Website will be available on http://localhost:8080 and secure https://localhost:8443 Admin password is autogenerated and will be seen in last few lines on initial run! To view mail sent http://localhost:8025
You should use a 3rd party system like Sendgrid or Mailgun. Both have modules for Drupal and are fully supported and also have generous free packages.
Alternative, you could add a smtp docker container to your project and use that if you are so brave enough to fight against different spam control configuration the most important Mail services use. To take note, this way will fail in most times to deliver to Gmail, Outlook or Yahoo, but using the above suggestion, corectly configured, delivery will be guatanteed 100% in the INBOX and not the Spam folder.
to_be_integrated
directory than the website will be installed automatically.This project template should provide a kickstart for managing your site dependencies with Composer.
If you want to know how to use it as replacement for Drush Make visit the Documentation on drupal.org.
First you need to install composer.
Note: The instructions below refer to the global composer installation. You might need to replace
composer
withphp composer.phar
(or similar) for your setup.
After that you can create the project:
composer create-project drupal-composer/drupal-project:8.x-dev some-dir --stability dev --no-interaction
With composer require ...
you can download new dependencies to your
installation.
cd some-dir
composer require drupal/devel:~1.0
The composer create-project
command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file.
When installing the given composer.json
some tasks are taken care of:
web
-directory.vendor/autoload.php
,
instead of the one provided by Drupal (web/vendor/autoload.php
).drupal-module
) will be placed in web/modules/contrib/
drupal-theme
) will be placed in web/themes/contrib/
drupal-profile
) will be placed in web/profiles/contrib/
settings.php
and services.yml
.web/sites/default/files
-directory.vendor/bin/drush
.vendor/bin/drupal
.This project will attempt to keep all of your Drupal Core files up-to-date; the project drupal-composer/drupal-scaffold is used to ensure that your scaffold files are updated every time drupal/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modified files are updated in a new release of Drupal core.
Follow the steps below to update your core files.
composer update drupal/core --with-dependencies
to update Drupal Core and its dependencies.git diff
to determine if any of the scaffolding files have changed.
Review the files for any changes and restore any customizations to
.htaccess
or robots.txt
.web
will remain in
sync with the core
when checking out branches or running git bisect
.git merge
to combine the
updated core files with your customized files. This facilitates the use
of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple;
keeping all of your modifications at the beginning or end of the file is a
good strategy to keep merges easy.With using the "Composer Generate" drush extension
you can now generate a basic composer.json
file from an existing project. Note
that the generated composer.json
might differ from this project's file.
Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.
The drupal-scaffold plugin can download the scaffold files (like
index.php, update.php, …) to the web/ directory of your project. If you have not customized those files you could choose
to not check them into your version control system (e.g. git). If that is the case for your project it might be
convenient to automatically run the drupal-scaffold plugin after every install or update of your project. You can
achieve that by registering @drupal-scaffold
as post-install and post-update command in your composer.json:
"scripts": {
"drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
"post-install-cmd": [
"@drupal-scaffold",
"..."
],
"post-update-cmd": [
"@drupal-scaffold",
"..."
]
},
If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the composer-patches plugin.
To add a patch to drupal module foobar insert the patches section in the extra section of composer.json:
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL to patch"
}
}
}
Follow the instructions in the documentation on drupal.org.