This is an overview of how we develop and maintain the Bradford Abbas Parish website.

The three servers: Live, Staging, Development

  • The Live Server is the public-facing web server. We “rent” ours from SimplyHosting. We use automation to provison the bare server with all the open source server software we require to run our website.

  • The Staging Server is really only used when we have to change servers. Once we can see that we have migrated the code, database, static files and settings from the Live server correctly, the Staging Server becomes the Live Server.

  • The Development Server is where we make changes to modules and settings and test that these can be safely migrated to the Live Server

The Development Server

This runs on an Ubuntu Linux virtual guest machine within the Mac host.

The GitHub repo iainhouston/bradford-abbas.uk is cloned into the project directory ~/bradford-abbas.uk.

When we change to the project directory (~/bradford-abbas.uk) we then do:

composer install && vagrant up

which does two things:

  1. Provisions a virtual development server

    • Its an Ubuntu Linux machine

    • It is allocated an IP Address and URL in /etc/hosts

    • It has the latest PHP code from Drupal and code contributed both by us and by others

    • It has an (as yet empty) MySQL database for the Drupal CMS

  2. Shares our (host) project directory bradford-abbas.uk with the /var/www/drupalvm directory of the (guest) virtual development server.

Shared folders allow us to see exactly the same files from within the guest Linux as from the host Mac. This is so that we can use an IDE / editor like PHPStorm to manage changes to the program code and configuration settings in the host development environment whilst, at the same time, this code and those settings can be served by Apache HTTP Server (“httpd”) as a website from within the virtual development server.

Although we do sometimes ssh into the virtual development machine, it would not be practicable to run an IDE in the Linux virtual environment - it has no GUI installed - and thus we use Mac GUI tools to change manage the code and settings on the Mac.

The (host) project directory is shared with the (virtual guest) web document directory’s parent using NFS (Sun’s Network File System) which is present on both the guest Linux and host MacOS’s BSD Unix systems.

Using the Development Server

As yet - after having just provisioned the Development Server - there is program code but no database or static files. Ignoring the case where we are starting the website from scratch, we need to populate - clone - the Development Server’s database and static files from the Live Server.

We do this as follows:

  1. we run cdbadev which

    • cd’s us to the project directory (~/bradford-abbas.uk)

    • exports shell variables and sets aliases for utilty commands

    cdbadev must be defined in your ~/.zshrc as follows:

    alias cdbadev="cd ${HOME}/bradford-abbas.uk && source SYMBOLS.sh".
    
  2. we run cloneLiveToDev to populate the Development Server’s database and static files from the Live Server.

We can now browse the Development version of the Parish Council website using the dashboard URL shown in the commentary generated from the vagrant up step above. The dashboard page is the launching page for:

  • the development version of the Parish Council website itself

  • adminer: web-based access to the development database

  • pimpmylog: web-based access to the development Apache httpd and other logs

  • mailhog: web-based email client intercepting and receiving all email messages sent out from the development version of the Parish Council website.

The web browser I use is Firefox Developer Edition; its developer tools for inspecting html and css are extremely powerful and usable: grids and flex are well supported. Its Responsive Design Mode makes it very easy to see how web pages look on different (mobile and desktop) devices. It has good javascript debugging tools although I rarely use these. I have kept our use of Javascript to a minimum.

Debugging PHP code

I also use the PHP XDEBUG plugin in Firefox to toggle debugging sessions on and off.

I have tried various combinations of XDEBUG clients but have found PHPStorm to be the most reliable and useable. PHPStorm is probably worth the annual subscription if you’re planning to do any programming and debugging in your own or others’ contributed modules and themes.

Debugging HTML and CSS

  • cdt takes you to the websites theme directory

  • npm install installs a Javascript tool chain including the truly wonderful Browsersync.

  • npx gulp fires up the tool chain

    • Code files are watched for changes.

    • Browsersync injects any changed CSS and publishes refreshed pages to any browsers connected in the network, so you can have several devices connected simultaneously to see how the HTML and CSS looks.

Using the Staging Server

As I said above, the Staging Server is really only used when we have to change servers. Once we can see that we have migrated the code, database, static files and settings from the Live server correctly, the Staging Server becomes the Live Server.

Rent a new server from a hosting company and provision it. Just edit the DNS settings at our account at the domain registrar LCN to point staging.bradford-abbas.uk to the IP Address of the newly provisioned Staging Server. You may find it useful to provision a virtual Staging Server first to practice the provisioning process. When using a virtual Staging Server, vagrant will populate /etc/hosts on the development Mac thus overriding the DNS mapping for staging.bradford-abbas.uk.

Instructions in the staging directory will tell you how to provision a staging server. Note that the hostname and server name in our Ansible Staging provisioning setup will be that of the Live Server, only the DNS (or /etc/hosts) will direct staging.badford-abbas to the newly-provisioned soon-to-be-Live server.

During provisioning, the Apache directives are set up to serve both staging.bradford-abbas.uk and bradford-abbas.uk but the SSL Certificate is only set up for bradford-abbas.uk so your browser will complain when accessing https://staging.bradford-abbas.uk, but you’ll ignore this security alert whilst checking out the Staging Server. Don’t use http://staging.bradford-abbas.uk (i.e. omitting https) otherwise you’ll get redirected to the the live server at https://bradford-abbas.uk

As soon as you’re happy that the Staging Server is behaving properly, with respect to the Live Server, then switch the DNS A records for www.bradford-abbas.uk and bradford-abbas.uk to the IP Address of the Staing Server (and best remove the A record for staging.bradford-abbas.uk). Do this using the Domain Registrar (LCN) website.

Don’t forget to vagrant halt the virtual Staging Server. A side-effect of vagrant halt is the removal of staging.bradford-abbas.uk from the host Mac’s /et/hosts which otherwise would take preference over the global DNS.

Using the Live Server

There are two things we have to do to the Live Server on a regular basis:

  1. Update the code base and configuration settings with any changes we made and tested on the Development Server. Most frequently, it is security updates to Drupal core and contributed modules that cause us to update the code base using composer.

  2. Replace the SSL certificate annually after having encrypted the new key and certificate according to the instructions in vm/certs

both of these are done by running updateLiveCode from the project directory.

There’s a third thing that is done automatically by the Live Server every week:

cron dumps the live database and static files to Amazon S3 buckets.

Further detail

Developing and maintaining a Drupal site with Drupal-VM describes the main files in the GitHub repo iainhouston/bradford-abbas.uk

That page is much more detailed than this post and is currently in need of updates to those details. This post is more likely to remain current.