GovCMS8 PaaS Project Scaffolding

Known Issues

• Currently (Nov 2018), all local projects utilise the same LOCALDEV_URL - we are working to fix that.
• This repository is still a Work-in-Progress, and may be subject to slight alterations
• Currently the UI installs the GovCMS profile. If you want a different profile (standard|minimal|custom) - you will have to install using drush si

Requirements and Preliminary Setup

• Docker - Follow documentation at https://docs.amazee.io/local_docker_development/local_docker_development.html to configure local development environment.

• Mac/Linux - Make sure you don't have anything running on port 80 on the host machine (like a web server):

    gem install pygmy
    pygmy up
  

• Windows:

    git clone https://github.com/amazeeio/amazeeio-docker-windows amazeeio-docker-windows; cd amazeeio-docker-windows
    docker-compose up -d; cd ..
  

• Ahoy (optional) - The commands are listed in .ahoy.yml all include their docker-compose versions for use on Windows, or on systems without Ahoy.

Project Setup

1. Checkout project repo and confirm the path is in Docker's file sharing config (https://docs.docker.com/docker-for-mac/#file-sharing):

    Mac/Linux: git clone https://www.github.com/govcms/govcms8-scaffold-paas.git {INSERT_PROJECT_NAME} && cd $_
    Windows:   git clone https://www.github.com/govcms/govcms8-scaffold-paas.git {INSERT_PROJECT_NAME}; cd {INSERT_PROJECT_NAME}
   

2. Build and start the containers:

    Mac/Linux:  ahoy up
    Windows:    docker-compose up -d
   

3. Install Drupal Site using Composer:

    Mac/Linux:  ahoy composer install
    Windows:    docker-compose exec -T test composer install
   

4. Install GovCMS (use docker-compose version for other profiles e.g. standard):

    Mac/Linux:  ahoy install
    Windows:    docker-compose exec -T test drush si -y govcms
   

5. Login to Drupal:

    Mac/Linux:  ahoy login
    Windows:    docker-compose exec -T test drush uli
   

Commands

Additional commands are listed in .ahoy.yml, or available from the command line ahoy -v

Development

• This project installs Drupal in the web folder.
• All modules must be installed using composer - e.g. ahoy composer require 'drupal/webform:^5.0'.
• The web/(modules|profiles|themes)/custom are provided for any custom modules you need, and are committed to git.
• The vendor, web/core and web/(modules|profiles|themes)/contrib folders are created from the composer.json every time, and are not committed to git.
• Tests specific to your site can be committed to the /tests folders
• The files folder is not (currently) committed to GitLab.
• Do not make changes to docker-compose.yml, lagoon.yml, .gitlab-ci.yml or the Dockerfiles under /.docker - these will result in your project being unable to deploy to GovCMS SaaS

Stage File Proxy

Stage File Proxy is already configured for use in both local development and cloud development environments. To enable:

• Add the stage_file_proxy module to your codebase
• Uncomment the relevant lines in .docker/scripts/govcms-deploy

This will ensure SFP is enabled on non-prod environments in Lagoon.

Image inheritance

This project is designed to provision a Drupal 8 project onto GovCMS PaaS, using the GovCMS8 distribution (or defaults), and has been prepared thus.

1. The vanilla GovCMS8 Distribution is available at Github Source and as Public DockerHub images
2. Those GovCMS8 images are then customised for Lagoon and GovCMS, and are available at Github Source and as Public DockerHub images
3. Those GovCMS8lagoon images are then retrieved in this scaffold repository.
4. This scaffold repository removes the /app folder from those images, allowing the project to deploy it's own site.