From 7f2abb5acd555a0c70a8a5c77c04814be2e3af41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=CC=81=20R?= Date: Fri, 18 Aug 2017 15:14:27 +0200 Subject: [PATCH] [Doc] Update documentation in regards to Docker setup --- INSTALL.md | 3 +-- README.md | 4 ++-- doc/docker-compose/README.md | 22 ++++++++++++---------- 3 files changed, 15 insertions(+), 14 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 129c822d4..2d4955ad1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,7 +1,6 @@ # Installation instructions -NOTE: *For simplified installation, see our Docker Tools Beta instructions in [doc/docker-compose/README.md](https://github.com/ezsystems/ezplatform/blob/master/doc/docker-compose/README.md). -By using those instructions you won't have to setup mysql, php, and nginx yourself, and almost all of the steps described below are done for you.* +NOTE: *For simplified installation, consider using [eZ Launchpad](https://ezsystems.github.io/launchpad/) which takes care about the whole setup for you.* These installation instructions are kept current in the online docs here: https://doc.ez.no/display/DEVELOPER/Step+1%3A+Installation diff --git a/README.md b/README.md index a1c9010f5..9568772e2 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ eZ Platform is 100% open source and is the foundation for the commercial *eZ Ent ## Install For manual installation instructions, see [INSTALL.md](https://github.com/ezsystems/ezplatform/blob/master/INSTALL.md). -For simplified installation, see our Docker Tools Beta instructions in [doc/docker-compose/README.md](https://github.com/ezsystems/ezplatform/blob/master/doc/docker-compose/README.md). +For simplified installation, rather consider using [eZ Launchpad](https://ezsystems.github.io/launchpad/) which takes care about the whole setup for you. ### eZ Platform Demo @@ -52,7 +52,7 @@ This repository lets you create a clean, empty installation of eZ Platform. This ## Requirements Full requirements can be found on the [Requirements](https://doc.ez.no/display/TECHDOC/Requirements) page. -*TL;DR: supported PHP versions are 5.5, 5.6 and 7.0 (for dev use), using mod_php or php-fpm, and either MySQL 5.5/5.6 or MariaDB 5.5/10.0.* +*TL;DR: supported PHP versions are 5.6, 7.0 and 7.1 (for dev use), using mod_php or php-fpm, and either MySQL 5.5/5.6 or MariaDB 10.0/10.1.* ## Issue tracker Submitting bugs, improvements and stories is possible on https://jira.ez.no/browse/EZP. diff --git a/doc/docker-compose/README.md b/doc/docker-compose/README.md index 477148b5a..0ada991fb 100644 --- a/doc/docker-compose/README.md +++ b/doc/docker-compose/README.md @@ -1,12 +1,16 @@ -# Using Docker Tools for your project +# Docker blueprints -> **Beta**: Instructions and Tools *(Docker images, Dockerfile, docker-compose files, scripts, ..)* described on this page - is currently in Beta for community testing & contribution, and might change without notice. - See [online Docker Tools documentation](https://doc.ez.no/display/DEVELOPER/Docker+Tools) for known issues and further information. +**NOTE**: If you are just looking to get easily up and running and developing with eZ Platform, rather look towards +[eZ Launchpad](https://ezsystems.github.io/launchpad/) which is tailored for Project Development use cases. _If not be +aware of the following limitations:_ +> **WARNING, made mainly for automation:** The tools within this directory are meant for use for test automation, QA, +Support and demo use cases. And with time as a blueprint for how to best configure your own setup. You are free to use +and adopt this for your needs, and we more the welcome contributions to improve it. -**"Project"**: *This page describes usage for your custom project code, for just launching a stock eZ Platform demo see [online Docker Tools documentation](https://doc.ez.no/display/DEVELOPER/Docker+Tools)*. - +> **WARNING, low performance on MacOS and Windows:** For reasons mentioned above, unlike eZ Launchpad these tools are not +optimized for use as development environment with Mac or Windows and hence are affected by known I/O performance issues caused by Docker for +Mac/Windows use of shared folders. This is a know issue and nothing we intend to add complexity to workaround here. ## Overview @@ -24,16 +28,14 @@ installed on your machine. #### Concept: Docker Compose "Building blocks" for eZ Platform -The current Docker Compose files are made to be mixed and matched togtehr as you'd like. Currently available: +The current Docker Compose files are made to be mixed and matched together for QA/Support use cases. Currently available: - base-prod.yml _(required, always needs to be first, contains: db, web and app container)_ - base-dev.yml _(alternative to `base-prod.yml`, same applies here if used)_ - blackfire.yml _(optional, adds blackfire service and lets you trigger profiling against the setup)_ -- selenium.yml _(optional, always needs to be last, adds selenium service and appends config to app)_ - -In addition the following exists but are work in progress, thus not tested yet and are known to be somewhat broken: - redis.yml _(optional, adds redis service and appends config to app)_ - varnish.yml _(optional, adds varnish service and appends config to app)_ - solr.yml _(optional, add solr service and configure app for it)_ +- selenium.yml _(optional, always needs to be last, adds selenium service and appends config to app)_ These can be used with `-f` argument on docker-compose, like: