govt.nz CWP docker images

This repo contains several images for running Silverstripe via Docker in dev or testing module. These machines are not suitable for production as is. These extend the work done on the brett89/silverstripe-web repo, adding additional features that are commonly used such as wkhtmltopdf within the image rather than seperate services.

• govtnz/silverstripe-web-circleci (7.1, 7.3). Designed for CircleCI
• govtnz/silverstripe-web (5.6, 7.1, 7.3). Designed for local Development.
• govtnz/silverstripe-localsolr. Designed for running Solr locally.

How to use this image locally

This image - together with a docker-compose.yml and a behat-docker.yml file provides you with the complete infrastructure to run a Silverstripe CWP website. It contains the webserver, database server as well as the following;

• solr server, to provide a fulltext-search option
• selenium server, for running the behat tests
• mailcatcher, to display all mail send by the application

Getting started

1. clone a Silverstripe project
2. add the example docker-compose.yml and the behat-docker.yml to your project (see examples directory)
3. run docker-compose up
4. browse to localhost:8000 and finish the setup (note: you can always go back to localhost:8000/_setup to reset the database)

Running behat tests

1. open a VNC session to localhost:5900 (password: secret)
2. start docker-compose exec web behat @mysite

Running PHPUnit tests

1. start docker-compose exec web vendor/bin/phpunit to run all tests

• or -

1. start docker-compose exec web vendor/bin/phpunit <directory to tests> to run specific tests only

Environment Info

This image comes pre-packaged with the default php extensions and configurations found on Silverstripe Platform. It also includes some tooling pre-installed for ease-of-use.

Build Tools

• xdebug
• sspak
• composer
• npm
• wkhtmltopdf
• gosu
• behat
• sake
• chrome

Loading database content

The setup interface allows you to load an sspak-file during startup, but if this file is too large then you need to load the file using the sspak application provided in the web-container.

For example:

• docker-compose exec web sspak load <path to file>

Running with Docker-Compose

Add the example docker-compose.yml file to your project and run docker-compose up. Then open a browser session at localhost:8000, and you will be guided through the initial setup.

The following scripts are available in this image;

• behat (docker-compose exec web behat @mysite). Open a VNC-session at :5900 (password: secret) to look at the browser executing the tests.
• sspak (docker-compose exec web sspak load <filename>)
• sake (docker-compose exec web sake dev/build)
• shell (docker-compose exec web shell)
• mysql (docker-compose exec db mysql -u root -p)

NOTE: A default _ss_environment.php file has been provided that expects a database server with the specific hostname db. CMS Admin username and password is set to root/root. All emails sent out by the application are caught by mailctacher. Browse to localhost:1080 to see those emails.

Testing Changes

If you make changes to an image run the following commands to build and test

cd silverstripe-web-circleci/7.3
docker build .
docker run -p {hash}

Tagging a new release

• Make the changes to the Dockerfile
• Build the docker image docker build path/to/folder
• Tag the release docker tag <hash> govtnz/name
• Push the release docker push govtnz/name

To make this easier, See the script ./build.sh which builds the docker image and optionally publishes the updated tag ./build.sh --publish. Specific a folder to build if required e.g

./build.sh silverstripe-web-container/7.3 --publish

License

View license information for the software contained in this image.

Issues

If you have any problems or questions about this image, please contact us through a GitHub issue.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process hem as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Credits

Based on the work of brettt89