https://github.com/drupalwxt/docker-scaffold

Docker Scaffold for Drupal WxT
https://github.com/drupalwxt/docker-scaffold

docker drupal

Last synced: 4 days ago
JSON representation

Docker Scaffold for Drupal WxT

• Host: GitHub
• URL: https://github.com/drupalwxt/docker-scaffold
• Owner: drupalwxt
• Created: 2020-01-27T03:33:31.000Z (almost 5 years ago)
• Default Branch: 10.2.x
• Last Pushed: 2024-10-28T17:26:42.000Z (22 days ago)
• Last Synced: 2024-10-28T18:48:24.591Z (22 days ago)
• Topics: docker, drupal
• Language: PHP
• Homepage:
• Size: 202 KB
• Stars: 4
• Watchers: 7
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Docker Scaffold for Drupal

Provides an barebones, fast, and lightweight local / CI docker environment to work with [Drupal][wxt].

## Pre-Requisites

You need to be using Docker Compose V2 and ensure the version >= v2.15.0.

## Setup

Installation is relatively straight forward as long as you are managing your site dependencies with Composer.

All of these commands must be run at the root of the Composer Project where the `composer.json` file exists.

Clone the docker-scaffold repository:

```sh

git clone https://github.com/drupalwxt/docker-scaffold.git docker

```

> **Note**: The `docker` folder should be added to your `.gitignore` file.

Create the necessary symlinks:

```sh

ln -s docker/docker-compose.base.yml docker-compose.base.yml

ln -s docker/docker-compose.ci.yml docker-compose.ci.yml

ln -sf docker/docker-compose.yml docker-compose.yml

```

Create a Makefile and make any necessary adjustments:

```sh

include .env

NAME := $(or $(BASE_IMAGE),$(BASE_IMAGE),drupalwxt/site-wxt)

VERSION := $(or $(VERSION),$(VERSION),'latest')

PLATFORM := $(shell uname -s)

$(eval GIT_USERNAME := $(if $(GIT_USERNAME),$(GIT_USERNAME),github-token))

$(eval GIT_PASSWORD := $(if $(GIT_PASSWORD),$(GIT_PASSWORD),$(CI_JOB_TOKEN)))

DOCKER_REPO := https://github.com/drupalwxt/docker-scaffold.git

GET_DOCKER := $(shell [ -d docker ] || git clone $(DOCKER_REPO) docker)

include docker/Makefile

```

Create a `scripts/ScriptHandler.php` file and make any necessary adjustments:

*  [ScriptHandler.php](scripts/ScriptHandler.php)

Create a `load.environment.php` file and make any necessary adjustments:

*  [load.environment.php](load.environment.php)

Ensure your `composer.json` at the minimum has the following:

```json

"require": {

    "vlucas/phpdotenv": "^5.1",

    "webflo/drupal-finder": "^1.2"

},

"autoload": {

    "classmap": [

        "scripts/ScriptHandler.php"

    ],

    "files": ["load.environment.php"]

},

"scripts": {

    "pre-install-cmd": [

        "DrupalWxT\\WxT\\ScriptHandler::checkComposerVersion"

    ],

    "pre-update-cmd": [

        "DrupalWxT\\WxT\\ScriptHandler::checkComposerVersion"

    ],

    "post-install-cmd": [

        "DrupalWxT\\WxT\\ScriptHandler::createRequiredFiles"

    ],

    "post-update-cmd": [

        "DrupalWxT\\WxT\\ScriptHandler::createRequiredFiles"

    ]

},

```

## Example

You can see the docker-scaffold in use in the `site-wxt` repository:

* https://github.com/drupalwxt/site-wxt

## Documentation

For more information please consult the documentation:

* https://drupalwxt.github.io/docs/environment/containers/

[composer]:                     https://getcomposer.org

[docker-scaffold]:              https://github.com/drupalwxt/docker-scaffold.git

[site-wxt]:                     https://github.com/drupalwxt/site-wxt

[wxt]:                          https://github.com/drupalwxt/wxt