nathanhealea / windows-drupal-development

Windows Drupal Development (WDD)

An all inclusive solution for Drupal development on windows.

Technologies

⚠️ ---- Archived ---- ⚠️

This project was orginally created to establish a standared way of building drupal environments on Windows using Docker. However I have discoved a technology Lando to be a more compelete project that I have used both professionally and personally. Lando provides many features that I would nevery have time to implement.

Introduction

Getting Drupal set up on windows can be a daunting and a barrier to learning Drupal. WDD aims to simplify the process to get developers up and running quickly.

Pre Installation

Docker Desktop

Follow the installation instruction to setup and install Docker Desktop.

Docker - Install Docker Desktop on Windows

Windows Subsystem Linux (WSL2)

Follow the installation instruction to setup and install WLS.

Windows Subsystem Linux (WSL2) - Install Linux on Window with WSL

Visual Studio Code

Follow the installation instruction to setup and install Visual Studio code

*NOTE: Install VS Code on the windows side, ensuring you click Add to PATH.*

Visual Studio Code - Download for Windows

Visual Studio Code - Developing in WSL

Recommended VS Code Extensions:

• WSL - Microsoft

Windows Terminal (Optional)

You can download Windows Terminal through the Microsoft Store.

Microsoft Store - Windows Terminal

Installation

1) Open a terminal and start WSL

You should be opened up in your user home directory.

/home/{user_name}

2) Clone the repository

3) Check out the branch of the corresponding Drupal stack.

Drupal Version	Branch	Checkout command
v10	drupal-v10	$ git checkout drupal-v10
v9	drupal-v9	$ git checkout drupal-v9
v8	drupal-v8	$ git checkout drupal-v8

4) Update .env file

Before being up your Drupal Docker stack.

1. Copy the default.env to .env
2. Fill out the each configurations.

*see environment variables for addition details.

5) Bring up Docker Stack

Run the following command to bring up your docker stack

$ docker compose up -d

6) Copy the default.settings.php to default.settings.php

$ sudo cp drupal/web/sites/default/default.settings.php drupal/web/sites/default/settings.php

7) Change Drupal Directory Permissions

$ sudo chmod -R 777 drupal

* should only be used for development environment to prevent issues with permissions.

8) Access Applications

• Drupal - http://localhost:8080/
• PHP MyAdmin - http://localhost:8090/
• MySQL - Accessible via localhost:3306

Drupal installation

In step 4 Set up database of the Drupal site configuration, you will need to change the host of the database from localhost to mysql

Folder Structure

Once the Drupal Docker stack is running you will have the following ending directory.

.
├── drupal            # Drupal mounted volume directory containing Drupal core.
├── mysql             # MySQL mounted volume directory containing MySQL database.

Environment Variables

[TBD]

Repo Branches

├── main                              # Minimal project files that can be applied to each drupal stack - not development ready
│   ├── v10       (drupal-v10)        # Drupal 10 development stack - ready for development
│   │   ├── dev   (drupal-v10-dev)    # Drupal 10 stack development
│
│   ├── v9        (drupal-v9)         # Drupal 9 development stack files - ready for development
│
│   ├── v8        (drupal-v8)         # Drupal 8 development stack files - ready for development

windows-drupal-development's Issues

Linux Post-Installation Steps for Unix

Users have been reporting that after installing the WSL and Docker Desktop a permission error that occurs when trying to run the command docker compose up -d.

permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Get "http://%2Fvar%2Frun%2Fdocker.sock/v1.24/containers/json?all=1&filters=%7B%22label%22%3A%7B%22com.docker.compose.config-hash%22%3Atrue%2C%22com.docker.compose.project%3Dwindows-drupal-development%22%3Atrue%7D%7D": dial unix /var/run/docker.sock: connect: permission denied

This issue was resolved by adding the WSL user to the docker group.

sudo usermod -aG docker $user

Documentation Reference:
https://docs.docker.com/engine/install/linux-postinstall/

WSL: v2
Windows: Windows 11 Home 22H2 (build 22621.2428)
Docker: 4.24.1