PHPackages woprrr/drupal8-composer-template - 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. [Utility & Helpers](/categories/utility) 4. / 5. woprrr/drupal8-composer-template ActiveProject[Utility & Helpers](/categories/utility) woprrr/drupal8-composer-template ================================ Woprrr contributor skeleton 8.3.0(8y ago)27342GPL-2.0+PHPPHP >=5.6 Since Jan 5Pushed 6y ago7 watchersCompare [ Source](https://github.com/woprrr/drupal8-composer-template)[ Packagist](https://packagist.org/packages/woprrr/drupal8-composer-template)[ RSS](/packages/woprrr-drupal8-composer-template/feed)WikiDiscussions 8.3.x Synced today READMEChangelogDependencies (7)Versions (4)Used By (0) Drupal 8 Composer Skeleton ========================== [](#drupal-8-composer-skeleton) Drupal 8 skeleton dockerized in sperate containers (Nginx, PHP-FPM, MySQL and PHPMyAdmin). Overview -------- [](#overview) 1. [Install prerequisites](#install-prerequisites) Before installing project make sure the following prerequisites have been met. 2. [Clone the project](#clone-the-project) We’ll download the code from its repository on GitHub. 3. [Configure Xdebug](#configure-xdebug) \[`Optional`\] We'll configure Xdebug for IDE (PHPStorm or Netbeans). 4. [Run the application](#run-the-application) By this point we’ll have all the project pieces in place. 5. [Use Makefile](#use-makefile) \[`Optional` but strongly encouraged for beginner\] When developing, you can use `Makefile` for doing recurrent operations. 6. [Use Docker Commands](#use-docker-commands) When running, you can use docker commands for doing recurrent operations. --- Install prerequisites --------------------- [](#install-prerequisites) For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows. All requisites should be available for your distribution. The most important are : - [Git](https://git-scm.com/downloads) - [Docker](https://docs.docker.com/engine/installation/) - [Docker Compose](https://docs.docker.com/compose/install/) Check if `docker-compose` is already installed by entering the following command : ``` which docker-compose ``` Check Docker Compose compatibility : - [Compose file version 3 reference](https://docs.docker.com/compose/compose-file/) The following is optional but makes life better : ``` which make ``` ### Images to use [](#images-to-use) - [Nginx](https://hub.docker.com/_/nginx/) - [MySQL](https://hub.docker.com/_/mysql/) - [PHP-FPM](https://hub.docker.com/r/woprrr/php-fpm/) - [PHPMyAdmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/) - [Generate Certificate](https://hub.docker.com/r/jacoelho/generate-certificate/) You should be careful when installing third party web servers such as MySQL or Nginx. This project use the following ports : ServerPortMySQL8989PHPMyAdmin8080Nginx8000Nginx SSL3000--- Clone the project ----------------- [](#clone-the-project) To install [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), download it and install following the instructions : ``` git clone -b drupal8-skeleton-docker git@github.com:woprrr/drupal8-composer-template.git ``` Go to the project directory : ``` cd drupal8-composer-template ``` ### Project tree [](#project-tree) ``` . ├── LICENSE ├── Makefile ├── README.md ├── app │   └── Drupal │   └── parameters.yml.dist ├── composer.json.dist ├── composer.require.json ├── composer.required.json.dist ├── composer.suggested.json.dist ├── config ├── data │   └── db │   ├── dumps │   └── mysql ├── doc ├── docker-compose.yml ├── etc │   ├── nginx │   │   ├── default.conf │   │   └── default.template.conf │   ├── php │   │   └── php.ini │   └── ssl ├── scripts │   └── Composer │   ├── DrupalExportConf.php │   ├── DrupalHandlerBase.php │   ├── DrupalInstall.php │   └── DrupalUpdate.php └── settings ├── development.services.yml.dist ├── phpunit.xml.dist ├── services.yml ├── settings.local.php.dist └── settings.php ``` --- Configure Xdebug ---------------- [](#configure-xdebug) If you use another IDE than [PHPStorm](https://www.jetbrains.com/phpstorm/) or [Netbeans](https://netbeans.org/), go to the [remote debugging](https://xdebug.org/docs/remote) section of Xdebug documentation. For a better integration of Docker to PHPStorm, use the [documentation](https://github.com/nanoninja/docker-nginx-php-mysql/blob/master/doc/phpstorm-macosx.md). 1. Get your own local IP address : ``` sudo ifconfig ``` 2. Edit php file `etc/php/php.ini` and comment or uncomment the configuration as needed. 3. Set the `remote_host` parameter with your IP : ``` xdebug.remote_host=192.168.0.1 # your IP ``` --- Run the application ------------------- [](#run-the-application) 1. Setup project environment variables : Setup your project by editing the `.env` file and customize all environement variables. Specifically all `Drupal_*` variable are criticaly important to next steps and to customize your drupal instances. 2. Initialize/Install project dependencies : ``` make docker-start ``` **Please wait this might take a several minutes...** ``` sudo docker-compose logs -f # Follow log output ``` 3. Install Drupal instance : ``` make drupal-si ``` **Or specify name of configuration instance** ``` make drupal-si my_configuration_name ``` All of configuration available are defined in your `settings/settings.local.php` file from ``` # Config directories $config_directories = array( my_configuration_name => '/absolute/path/to/config' ); ``` Example of typical workflow with configuration ``` # Config directories $config_directories = array( dev => getcwd() . '/../config/dev', preprod => getcwd() . '/../config/preprod', prod => getcwd() . '/../config/prod', stage => getcwd() . '/../config/stage', ); ``` 4. Open your favorite browser : - [http://localhost:8000](http://localhost:8000/) (Web Front). - [https://localhost:3000](https://localhost:3000/) (Web Front HTTPS). - [http://localhost:8080](http://localhost:8080/) PHPMyAdmin (username: dev, password: dev) 5. Stop and clear services : ``` sudo docker-compose down -v ``` 6. Stop and delete all traces of changes from skeleton : ``` sudo make docker-stop ``` That delete all files to reset skeleton at his initial state. ### Play with Drupal Configuration workflow [](#play-with-drupal-configuration-workflow) 1. Export your current configuration instance ``` make drupal-config-export ``` **Or with Docker Compose** ``` docker-compose exec -T php composer export-conf ``` 2. After your first install of Drupal instance edit the `.env` file and change the following variable `DRUPAL_INSTALL_PROFILE=standard` to `DRUPAL_INSTALL_PROFILE=config_installer`. That take ability to re-install / update your drupal instance with ./config/\* exported configuration states. 3. Re-install or update your instance from exported configuration **Re-install:**With Drop of current drupal database and complete re-import of ./config `sh make drupal-si ` **Update:**With following drupal commands (up-db / ent-up ). > Every action processed by scripts switch your Drupal instance on `maintenance` mode and switch Online after every action automatically. ``` make drupal-update ``` 4. In more advanced usage you can also specified a drupal configuration name ``` make drupal-si preprod || make drupal-update preprod ``` **Or with Docker Compose** ``` docker-compose exec -T php composer site-install preprod || docker-compose exec -T php composer site-update preprod ``` ### Examples of life cycle [](#examples-of-life-cycle) 1. Start the Project containers : ``` sudo make docker-start ``` 2. Edit .env file. 3. Install drupal 8 instance : ``` sudo make docker-si ``` 4. Exporting Drupal configuration files : ``` ```sh make drupal-config-export ``` **Or with a specific destination** ```sh make drupal-config-export my_configuration_name ``` ``` 5. Enable Re-install from configuration mode : Edit `.env` file by changing `DRUPAL_INSTALL_PROFILE=standard` to `DRUPAL_INSTALL_PROFILE=config_installer`. 6. Re-installation of project from exported configuration : `sh make drupal-si ` 7. Update of current instance : Edit one of configuration yml in your `/config` folder eg: system.site.site\_name. and process to updating your drupal instance from configuration by using ``` ```sh make drupal-update ``` ``` Your Site Name will change that you specified in system.site.site\_name yml file. 8. Another tips ? Call Help ;) : Show help : ``` make help ``` --- Use Makefile ------------ [](#use-makefile) When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(software)) for doing the following operations : NameDescriptioncode-sniffCheck the API with PHP Code Sniffer (Drupal Standards).cleanClean directories for reset.c-installInstall PHP/Drupal dependencies with composer.c-updateUpdate PHP/Drupal dependencies with composer.clean-drupal-configDelete exported configuration from project.docker-startCreate and start containers.docker-stopStop and clear all services.gen-certsGenerate SSL certificates.logsFollow log outputmysql-dumpCreate backup of all databasesmysql-restoreRestore backup of all databasestestTest all application (custom and contribution modules).test-contribTest application with phpunittest-custom-modulesTest Drupal custom modules.drupal-siInstall new Drupal instance and drop database.drupal-updateUpdate your current Drupal instance and (re)import your `/config` exported configuration.drupal-config-exportExport your current Drupal instance from `/config` by default. That can be in sub-folder depend your custom changes.--- Use Docker commands ------------------- [](#use-docker-commands) ### Installing package with composer [](#installing-package-with-composer) ``` docker-compose exec -T php composer install ``` ### Requiring package with composer [](#requiring-package-with-composer) ``` docker-compose exec -T php composer require drupal/core ``` ### Updating PHP dependencies with composer [](#updating-php-dependencies-with-composer) ``` docker-compose exec -T php composer update ``` ### Testing PHP application with PHPUnit [](#testing-php-application-with-phpunit) ``` docker-compose exec -T php bin/phpunit -c ./web/core ./web ``` ### Fixing standard code with [CODER](https://www.drupal.org/project/coder) [](#fixing-standard-code-with-coder) ``` docker-compose exec -T php composer phpcs ./web/modules/ or specify more specific path. ``` ### Checking the standard code with [CODER](https://www.drupal.org/project/coder) [](#checking-the-standard-code-with-coder) ``` sudo docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src ``` ### Checking installed PHP extensions [](#checking-installed-php-extensions) ``` sudo docker-compose exec php php -m ``` ### Handling database [](#handling-database) #### MySQL shell access [](#mysql-shell-access) ``` sudo docker exec -it mysql bash ``` and ``` mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" ``` #### Creating a backup of all databases [](#creating-a-backup-of-all-databases) ``` mkdir -p data/db/dumps ``` ``` source .env && sudo docker exec $(sudo docker-compose ps -q mysqldb) mysqldump --all-databases -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" > "data/db/dumps/db.sql" ``` #### Restoring a backup of all databases [](#restoring-a-backup-of-all-databases) ``` source .env && sudo docker exec -i $(sudo docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" "data/db/dumps/YOUR_DB_NAME_dump.sql" ``` #### Restoring a backup of single database [](#restoring-a-backup-of-single-database) ``` source .env && sudo docker exec -i $(sudo docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD"