egobude/docker-neos-template

Docker based Neos CMS development setup

v0.3 2017-04-17 21:39 UTC

Requires

• neos/neos: ~3.0.0
• neos/nodetypes: ~3.0.0
• neos/redirecthandler-databasestorage: ~2.0
• neos/redirecthandler-neosadapter: ~2.0
• neos/seo: ~2.0
• neos/setup: ~4.0
• neos/site-kickstarter: ~3.0.0

Requires (Dev)

• mikey179/vfsstream: ~1.6
• neos/behat: dev-master
• neos/buildessentials: ~4.0.0
• phpunit/phpunit: ~5.4.0
• symfony/css-selector: ~2.0

Suggests

• ext-pdo_sqlite: For running functional tests out-of-the-box this is required

Replaces

• typo3/neos-base-distribution: 3.0.2

GPL-3.0+

README

Template for a docker based development setup.

Requirements/Links

• docker (https://docs.docker.com/engine/installation)
• docker-compose (https://docs.docker.com/compose)
• composer (https://getcomposer.org)

Development stack

Image	Version	OS
Nginx	1.11	Alpine
PHP-FPM	7.1	Alpine
Redis	3.2	Alpine
MariaDB	10.1	Debian Jessie

Usage

Clone the repository

$ git clone https://github.com/egobude/docker-project-template.git
$ cd docker-project-template

Create a .env file

Create a .env file from .env.dist and edit it with your own config

$ cp .env.dist .env

Build the containers

$ docker-compose build

Install your project

Install a Neos base distribution

$ composer create-project neos/neos-base-distribution Data 

Install a Flow base distribution

$ composer create-project neos/flow-base-distribution Data

Start your development stack

$ docker-compose up -d   

You can reach your project under http://<YOUR_IP_ADRESS:1234

Stop and remove the containers

$ docker-compose down

If changes have been made to the setup, rebuild the containers

$ docker-compose up -d --build --force-recreate

Tips

Whenever you make changes to the files located under /Docker you have to rebuild the images. Otherwise the changes have no effect!

How to execute a custom shell script on start up?

To execute a custom shell script on start up place one or more *.sh files into the /docker-entrypoints folder. This feature is available for the php-fpm and nginx image. The files are loaded alphabetically.

How to change the port?

If you want a different port than 1234 you can edit the environment variable NGINX_PORT in the .env file.

How to change the document root?

To change the document root just edit the environment variable NGINX_DOCUMENT_ROOT in the .env file.