Drupal 7 environment for Decompose intended to help developers quickly start a Drupal 7 website. Because this project uses Docker instead of a virtual machine, the website is suitable for production as well as development and testing!
decompose --init https://github.com/dmp1ce/decompose-drupal-7.git
decompose build && decompose upThen visit http://localhost/install.php to install Drupal. Username, password and host information for the database is already entered into the settings.php so all you'll need to do is setup admin user.
Modify the containers/source/source/drupal/make.yml file to add the modules, themes and libraries you want. After modifying make.yml, run decompose build && decompose up again.
Decompose uses skeleton files in the .decompose/environment/skel to create a starting point for working on Drupal 7. Decompose will also initialize a git repository, so git status will show all of the files which have been created for you. Some of the files created are .mo files which are template files and contain elements (variables) like {{PROJECT_NAME}}. These elements are defined throughout the project but primarily in elements and .decompose/elements. Many tasks can be done with a decompose process such as decompose build or decompose up.
After decompose --init https://github.com/dmp1ce/decompose-drupal-7.git is run, the following directory structure will be created.
├── containers
│ ├── backup
│ ├── backup_data
│ ├── data
│ ├── nginx
│ ├── nginx_proxy
│ ├── php
│ └── source
├── docker-compose.yml.mo
├── elements
└── processes
The containers directory is the configuration for all containers used by Drupal 7. The backup and backup_data containers are used for backing up Drupal 7 files and database settings using Duply. The data container stores Drupal uploaded files. The nginx container containers the nginx configuration for Drupal. The nginx_proxy directory is a special directory for configuration the nginx_proxy container which can host multiple websites from the same host! See jwilder/nginx-proxy. The php directory has the php-fpm and php configuration. Finally, the source directory is a special directory for sharing the Drupal source between nginx and php containers.
The docker-compose.yml.mo is a template file for creating the docker-compose.yml file. This file configures how each container interacts with each other. It also configures various settings such as environment variables, labels and restart settings.
The elements file contains non-private elements. Private elements such as passwords or API keys go in .decompose/elements and are not checked in. See elements section for details.
The processes file contains non-private processes. Private processes such as development only processes go in .decompose/processes and are not checked in. See processes section for details.
TODO: Go into more detail about each container which is used.
Elements are essentually variables which can be used to change files generated from template files. Template files are any file with the extension .mo. Although, you can exclude .mo files from being processed using the PROJECT_IGNORE_BUILD element.
You can create your own elmeents by adding them to the .decompose/elements file if they are private and show not be checked in. If they are OK to be checked in and show to the public then you can add them to elements as long as elements is referenced by .decompose/elments.
PROJECT_ENVIRONMENT: The current environment. Onlydevelopmentorproductionis supported.PROJECT_NGINX_VIRTUAL_HOST: The primary hostname used by nginx. This is what all other hosts will redirect to.PROJECT_NGINX_VIRTUAL_HOST_ALTS: All alternative hostnames. These are valid hostnames but they will be redirected to the$PROJECT_NGINX_VIRTUAL_HOSThostname. Multiple hostnames should be seperated by a space character. For example:PROJECT_NGINX_VIRTUAL_HOST="example.com www.example.com"PROJECT_NGINX_DEFAULT_HOST: Tells nginx_proxy where to go if it cannot find a matching domain. Be careful with this setting as it can override other projects which share the same nginx_proxy container.PROJECT_SOURCE_PATH: The relative location of the Drupal source from the sourceDockerfilePROJECT_SOURCE_HOST_PATH: The relative location of the Drupal source from thedocker-compose.ymlfilePROJECT_VERSION_FILE: The location and name of the version file to create on buildPROJECT_PHP_TIMEZONE: The timezone of the server. Used to configures the PHP timezone.PROJECT_DEBUG_NGINX: Turn nginx debugging onPROJECT_HTTP_SECURITY: Turn on HTTP security. TODO: Is generating a htpasswd file necessary?PROJECT_NGINX_PROXY_IMAGE: Specify the nginx-proxy image to use. jwilder/nginx-proxy is the default image.
PROJECT_SMTP_HOST: SMTP host for sending emailPROJECT_SMTP_USER: SMTP server user for seding emailPROJECT_SMTP_PASSWORD: SMTP server password for sending emailPROJECT_SENDMAIL_PATH: Setting PHP uses to send email
PROJECT_DB_USER: Drupal database userPROJECT_DB_DATABASE: Drupal database namePROJECT_DB_PASSWORD: Drupal database user passwordPROJECT_DB_ROOT_PASSWORD: Drupal root user password
PROJECT_BACKUP_GPG_KEY: GPG key to use for encrypting backupPROJECT_BACKUP_GPG_PW: GPG password needed to use the keyPROJECT_BACKUP_TARGET: Target location to send backup according to Duply documenationPROJECT_BACKUP_CONFIG_TARGET: Target location to send configuration backup. UnlikePROJECT_BACKUP_TARGETthis uses scp scheme and not the Duply scheme.
PROJECT_PRODUCTION_SERVER_IP: IP of production serverPROJECT_PRODUCTION_SERVER_USER: User of production server which you connect to with SSHPROJECT_PRODUCTION_SERVER_BASE_PATH: Relative path from home which the project is located on production
PROJECT_WEBSITE_TO_EXPOSE_IP: IP of machine which you want to expose from the reverse proxy server.localhostor the IP of a virtual machine most likely.PROJECT_WEBSITE_TO_EXPOSE_PORT: The port of the machine to expose from the reverse proxy server.PROJECT_REVERSE_PROXY_USER: The user used to SSH into the reverse proxyPROJECT_REVERSE_PROXY_IP: IP of the reverse proxyPROJECT_REVERSE_PROXY_PORT: The port of the reverse proxy which will map to thePROJECT_WEBSITE_TO_EXPOSE_PORT
TODO: grep for more, possibly hidden, elements
Processes are typically common tasks that are needed when working on the project. Custom processes can be added to the .decompose/processes file. If you want to check in your processes then add them to processes and reference the file in .decompose/processes. See the .decompose/processes file for a simple example.
decompose --help for list of processes
build: Process template files and build Docker containersup: Start or restart Docker containersimport_db $db_file: Import a Drupal database.sql.gzfile.explore_db: Open a command prompt to MariaDB Drupal databasetail-dev-email: Print to the screen the latest emails from a development environmentdrush $command: Run a drush commandbackup-db: Runs backup script. Also does backup on Drupal uploaded files, dispite the poor nameexplore-php-container: Opens a command prompt to the PHP containerenv: Shows if the current configuration is in production or development mode and shows URL host settings
TODO: Instead of listing all of the processes provided by libraries, instead link to the library documentation when it is completed.
start_nginx_proxy: Starts the nginx proxy container if it isn't already runningrestart_nginx_proxy: Restarts the nginx proxy container. If it isn't running then it will be started.recreate_nginx_proxy: Like restart but makes sure to create a new container instead of reusing an old onestart-reverse-proxy: Starts a reverse proxy connection for exposing local environment to Internet. See element settings forPROJECT_WEBSITE_TO_EXPOSE_IP,PROJECT_WEBSITE_TO_EXPOSE_PORTand│PROJECT_REVERSE_PROXY_*. Also requires a properly configured SSH server to already be running.update-production-server-to-latest: Script for deploying currently checked in code to production server. See elementsPROJECT_PRODUCTION_SERVER_*.increment-tag: Increments the last version tag by 1. For example v1.1 would be incremented to v1.2ssh_production: SSH into production server. Uses the same elmeents asupdate-production-server-to-latest.generate_nginx_proxy_configs: Generates the nginx proxy configuration files. See nginx_proxy container for details.project-root: Print project root directorybackup_config: Backup all files which are not checked in. Important if for some reason the server is deleted and the configuration is needed to restore the site backup. See backup lib.generate_gpg_backup_keys: Generate GPG keys for backing up database and uploaded files.generate_backup_server_ssh_access_key: Generate SSH keys for accessing backup server to store backupslist-backups: List all currently known backups. Useful for finding a backup to restore to.restore-db: Restore database from a backupremove-untagged-docker-images: Remove all untagged docker images. Useful for keeping Docker from using up all hard drive space.
For developing modules or hacking on Drupal core, you'll probably want to be able to edit files and see the results right away on the website without needing to rebuild the project with decompose build && decompose up. To avoid needing to rebuild the project, create host volumes for the directory you are working in. The source container in the docker-compose.yml.mo file has a commented out section which is an example of how to create these volumes for Drupal core, custom modules, custom themes and/or libraries. If you also want to use the overrides in production, you'll probably want them copied to the source container at build time. See the containers/source/Dockerfile.mo for a commented section example.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent