Merge pull request #6 from vfalies/2.3-rc

2.3

Author: vfalies

.env.dist

@@ -1,11 +1,17 @@
 MAILDEV_PORT=1080
 DBADMIN_PORT=9090
+DBADMIN_VERSION=4.8
 WEB_PORT=80
 WEBSSL_PORT=443
-PHP_VERSION=7.2-fpm-alpine
+PHP_VERSION=7.2-fpm
 DB=mysql
+DB_VERSION=5.7
 WEB_SERVER=nginx
+WEB_SERVER_VERSION=1.15-alpine
 PROJECTS_PATH=/your/projects/directory/path
+PROJECTS_PATH_DEST=/var/www/html/projects
 MYSQL_ROOT_PASSWORD=root
 CACHE_SERVER=redis
-CACHE_PORT=6380
+CACHE_VERSION=4.0-alpine
+CACHE_PORT=6380
+CONTAINER_DB_NAME=db

CHANGELOG.md

@@ -5,6 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.3] - 2018-07-14
+
+### Changed
+
+- Change default version of PHP in `.env.dist` file from 7.2 FPM alpine to 7.2 FPM
+- Change License date
+- Update README
+- Move PHP FileMatch from Apache VHost configuration to generic Apache configuration
+- Refactoring documentation in multiple files
+
+### Added
+
+- Add JS Tools : NodeJS, Npm, Grunt, Gulp, Yarn
+- Add Bash in alpine versions
+- Add PHP wrapper
+- Add Node wrapper
+- Add Git wrapper
+- Add Composer wrapper
+- Add Grunt wrapper
+- Add Gulp wrapper
+- Add Npm wrapper
+- Add Yarn wrapper
+- Add Typescript wrapper
+- Create a docker `vfac` network
+- Fix image versions from `.env` configuration file (Database, Web server, Cache server, Database admin)
+- Add customization of projects path in container from `.env` file
+
 ## [2.2.1] - 2018-06-19
 
 ### Added

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2017 Vincent Faliès
+Copyright (c) 2016-2018 Vincent Faliès
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -36,10 +36,10 @@ homepage: ## Launch EnvDev homepage in default browser
 	@echo '******** Launch Homepage in browser ********'
 	@x-www-browser envdev.localhost
 
-terminal: ## Create a terminal to php container
+terminal: ## Create a terminal
 	@echo '******** Launch terminal ********'
 	@docker exec -ti php /bin/bash
 
-terminalroot: ## Create a terminal to php container as root
+terminalroot: ## Create a terminal as root
 	@echo '******** Launch terminal as root ********'
 	@docker exec -ti -u 0 php /bin/bash

README.md

@@ -2,110 +2,7 @@
 
 ## Environment composition
 
-This environment provies the following tools to develop in PHP :
-
-### Core
-
-- [PHP](http://php.net)
-
-Available version :
-
-    - `7.0`
-    - `7.1`
-    - `7.2`
-
-The version is configured in `.env` file. Default: `7.2`
-PHP Stack run on Alpine version to keep a small size image.
-
-- Database
-
-Two different database are available :
-
-    - [MySQL](https://www.mysql.com)
-    - [MongoDB](https://www.mongodb.com)
-
-The database wished is configured in `.env` file. Default: `mysql`
-
-- Web server
-
-Two web server are available :
-
-    - [Nginx](https://nginx.org)
-    - [Apache](https://httpd.apache.org/)
-
-All of them are in Alpine version.
-
-- Cache server
-
-Two cache server are available :
-
-    - [Redis](https://redis.io/)
-    - [Memcached](https://memcached.org/)
-
-All of them are in Alpine version
-
-### Tools
-
-#### Database admin
-
-- [MongoExpress](https://github.com/mongo-express/mongo-express) : Manage Mongo database instances
-- [PHPMyAdmin](https://www.phpmyadmin.net/) : Manage Mongo database instances
-
-#### Mail hub
-
-- [MailDev](http://danfarrelly.nyc/MailDev) : SMTP Server + Web Interface for viewing and testing emails during development
-
-#### Composer
-
-- [Composer](https://getcomposer.org) : Dependency Manager for PHP
-
-#### NodeJs
-
-- [NodeJs](https://nodejs.org/en) : JavaScript runtime
-
-#### Makefile
-
-A `Makefile` is available in command line to manage several actions.
-
-Type following command to display help :
-
-```shell
-make
-```
-
-or
-
-```shell
-make help
-```
-
-Output:
-
-```shell
-help:  Show this help
-servers:  Start all containers
-start:  Start all containers
-stop:  Stop all containers
-restart:  Restart all containers
-certificate:  Generate a SSL certificate
-renewal:  Renewal a knowed SSL certificate
-install:  Install EnvDev container environment
-homepage:  Launch EnvDev homepage in default browser
-terminal:  Create a terminal to php container
-terminalroot: Create a terminal to php container as root
-```
-
-### Optional tools
-
-Optional tools are available to use in EnvDev. They are not included by default but can be added easily.
-
-- [APIGen](https://github.com/ApiGen/ApiGen)  : Documentation for your PHP project
-
-Image container : [`vfac/apigen`](https://hub.docker.com/r/vfac/apigen/)
-
-- [Deployer](https://deployer.org) : Deployment tool for PHP
-
-Image container : [`vfac/deployer`](https://hub.docker.com/r/vfac/deployer/)
+This environment provies the following tools to develop in PHP / JS :
 
 ## Requirements
 
@@ -129,200 +26,13 @@ To install environment
 make install
 ```
 
-## Usage
-
-To start the environment, type the following command:
-
-```shell
-make servers
-```
-
-or
-
-```shell
-make start
-```
-
-Several containers are created from `.env` configuration:
-
-| Description | Container's name |
-|-------------|------------------|
-| Maildev hub mail | `maildev` |
-| NodeJs | `nodejs` |
-| Web server ( Apache or Nginx ) | `web` |
-| PHP container | `php` |
-| Cache server | `cache` |
-| Database server | `db` |
-| Database admin tool | `dbadmin` |
-
-`composer` is available through `php` container:
-
-```shell
-docker exec php composer -v
-```
-
-`node`, `npm` are available through `node` container:
-
-```shell
-docker run --rm node node -v
-```
-
-```shell
-docker run --rm node npm -v
-```
-
-To open default home page in browser
-
-```shell
-make homepage
-```
-
-### Hosts
-
-You can add your own hosts file for all your projects.
-
-With NGinx
-
-In `conf/nginx/vhosts` directory, all your `yourhost.conf` file. A default host file is available for example : `/conf/nginx/vhosts/default.conf`.
-
-```conf
-server {
-
-    listen 80;
-    server_name localhost;
-    root /var/www/html;
-    index index.php index.html index.htm;
-
-    location ~* \.PHP$ {
-        fastcgi_index   index.php;
-        fastcgi_pass   php:9000;
-        include         fastcgi_params;
-        fastcgi_param   SCRIPT_FILENAME    $document_root$fastcgi_script_name;
-    }
-
-}
-```
-
-With Apache
-
-In `conf/apache/vhosts` directory, all your `yourhost.conf` file. A default host file is available for example : `/conf/apache/vhosts/default.conf`.
-
-```conf
-<VirtualHost *:80>
-    ServerName localhost
-    DocumentRoot /var/www/html/projects
-
-    <Directory /var/www/html/projects>
-        Require all granted
-    </Directory>
-
-    <FilesMatch \.php$>
-        SetHandler "proxy:fcgi://php:9000"
-    </FilesMatch>
-</VirtualHost>
-```
-
-### SSL support
-
-The SSL support is possible during development. To activate it on one of your vhosts, you must follow steps:
-
-- Create the SSL self-signed certificate
-
-you can use the command:
-
-```shell
-make certificate
-```
-
-- Add the activation of SSL in VHost file
-
-On Nginx:
-
-```
-    listen 443 ssl;
-
-    ssl_certificate /etc/nginx/ssl/envdev.crt;
-    ssl_certificate_key /etc/nginx/ssl/envdev.key;
-```
-
-On Apache:
-
-```
-<VirtualHost *:80 *:443>
-    ...
-
-    SSLEngine on
-    SSLCertificateFile /usr/local/apache2/conf/custom/envdev.crt
-    SSLCertificateKeyFile /usr/local/apache2/conf/custom/envdev.key
-
-    ...
-```
-
-where `envdev` is the name chosen during the step of the certificate creation.
-
-Don't forget to restart `web` container to restart the web server
-
-```shell
-docker restart web
-```
-
-Tips: If you certificate is out of date, you can renew it with the command:
-
-```shell
-make renewal
-```
-
-## Configuration
-
-You can create `.env` file to manage applications and tools.
-An example is available with `.env.dist` file.
-
-The following versions, paths and ports can be configured :
-
-| Description | Variable name | Possible values | Default |
-|:-------------|:---------------:|:-----------------:|:---------:|
-| PHP Version | PHP_VERSION | `7.0-fpm`, `7.1-fpm`, `7.2-fpm`, `7.0-cli`, `7.1-cli`, `7.2-cli`, `7.0-fpm-alpine`, `7.1-fpm-alpine`, `7.2-fpm-alpine`, `7.0-cli-alpine`, `7.1-cli-alpine`, `7.2-cli-alpine` | `7.2-fpm-alpine` |
-| Web Server type | WEB_SERVER | `nginx`, `apache` | `nginx` |
-| Database type | DB | `mariadb`, `mysql`, `mongodb` | `mysql` |
-| Cache server type | CACHE_SERVER | `redis`, `memcached` | `redis` |
-| Projects Path | PROJECTS_PATH | any | `/your/projects/directory/path` |
-| HTTP web port | WEB_PORT | any | `80` |
-| HTTPS web port | WEBSSL_PORT | any | `443` |
-| MailDev port | MAILDEV_PORT | any | `1080` |
-| PHPMyAdmin port | PHPMYADMIN_PORT | any | `9090` |
-| MongoExpress port | MONGOEXPRESS_PORT | any | `8081` |
-| Cache server port | CACHE_PORT | any | `6380` |
-
-If you access to the url `http://envdev.localhost` a page summarizes all projets and propose access link to PHPMyAdmin, MailDev and PHPInfo.
-
-### Nginx configuration
-
-Nginx configuration file is available at `/conf/nginx/nginx.conf` to custom the web server configuration.
-
-### Apache configuration
-
-Apache configuration file is available at `/conf/apache/httpd.conf` to custom the web server configuration.
-
-### PHP configuration
-
-A custom php.ini file is available at `/conf/php/php.ini`. The default PHP configuration is with these options:
-
-```conf
-date.timezone = Europe/Paris
-display_errors=1
-error_reporting=E_ALL
-log_errors = on
-error_log = /var/log/php_errors.log
-memory_limit = 256M
-upload_max_filesize = 200M
-post_max_size = 40M
-```
+## Documentation
 
-### Projects configuration
+All documentation is available in [docs directory](./docs)
 
-To simplify projects source sharing between containers, you can install source projects in the path define in `.env` with variable `PROJECTS_PATH`.
+## Troubleshooting
 
-Naturally, you can change the default path. In this case, the default summary will not be available.
+2.3 version of EnvDev, has add new environment constants in `.env` file. If you use an older version, this file must be update with all constants presents in `.env.dist`.
 
 ## Open source