README.md

Docker Neos

This is a docker setup for local development with php, mariadb, node and nginx for Neos CMS (https://www.neos.io)

The goal is to get an instant setup, with maximum expandability and simplicity in the configuration, without the shell script hell.

After installation, a normal Neos will run immediately. Customizations can be easily created using .env, docker-compose.orverride.yml, or custom configs that override or extend the default values.

A makefile already includes the basic commands that are executed directly on the containers. e.g. composer, yarn, ssh, flow commands

Documentation

Basics

• Getting Started
• CLI Commands
• Caching

Configuration

• Configuration
  • PHP
  • Nginx
  • SSH
    • SSH config
    • SSH rsa_id
    • SSH agent
  • MariaDB
  • Overrides
• Override configuration files
• Override and extend Makefile commands
• Override or extend docker-compose.yml
• Override or extend Dockerfiles

Getting Started

1. Init

$ mkdir myprojectfolder
$ cd myprojectfolder
$ git clone [email protected]:freesh/docker-neos.git .
$ make setup

2. Settings

open .env file and change default versions and paths for your needs.

3. Start docker

$ make up

4. Setup project

Copy your project files to ./App, or ssh in to the php container and init your project with composer. For database credentials take a look in the generated .env file. Don't forget to configure your project for usage with the configured http port.

$ make ssh
> composer ...

5. Enjoy

http://localhost:8080/

Configurations

You can change default configurations on two ways:

The first way is to manipulate the default files and versioning these with your project. This is recommended if the changes are project relevant.

The seccond way is to use local override files, wich are not versioned. This ist recommended for changes there just relevant on your own host stystem.

.env file

To configure versions (php, node), ports, file path and some other stuff, you can make changes through the generated .env file.

For more informations about possible versions, please take a look at the configuration section in the documentation.

Override docker-compose settings

To override the default docker-compose.yml you can use the docker-compose.override.yml

Appending and extending make commands

Appending own commands to the make file or extending the existing commands ist also possible with an own configuration file. See: Override and extend Makefile commands

TBD

• Documentation: Best practice