Merge pull request #5 from vfalies/release-2.2

Release 2.2

Author: vfalies

.env.dist

@@ -1,6 +1,7 @@
 MAILDEV_PORT=1080
 DBADMIN_PORT=9090
 WEB_PORT=80
+WEBSSL_PORT=443
 PHP_VERSION=7.2-fpm-alpine
 DB=mysql
 WEB_SERVER=nginx

.gitignore

@@ -4,6 +4,10 @@ conf/apache/vhosts/*
 conf/nginx/vhosts/*
 !conf/nginx/vhosts/default.conf
 !conf/nginx/vhosts/envdev_home.conf
+conf/ssl/*
+!conf/ssl/envdev.crt
+!conf/ssl/envdev.key
+!conf/ssl/envdev.csr
 projects/*
 !projects/index.php
 !projects/phpinfo.php

CHANGELOG.md

@@ -5,6 +5,19 @@ 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.2] - 2018-05-18
+
+### Added
+
+- Add SSL support
+- Add script to create and renew self-signed certificate
+- Add EnvDev version on homepage
+
+### Changed
+
+- Update Makefile actions and add help
+- Fix CSS homepage
+
 ## [2.1.1] - 2018-05-01
 
 ### Added

Makefile

@@ -3,14 +3,35 @@ export GROUP_ID=$(shell id -g)
 
 include .env
 
-servers:
-	docker-compose up -d --build --remove-orphans
+help: ## Show this help
+	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
 
-stop:
-	docker-compose down
+servers: ## Start all containers
+	@echo '******** Starting all containers... ********'
+	@docker-compose up -d --build --remove-orphans
 
-install:
-	docker-compose build --force-rm --no-cache && docker run --rm -v $(shell pwd):/var/www/html -u "$(USER_ID):$(GROUP_ID)" vfac/envdevphpbase:$(PHP_VERSION) sh -c "cd /var/www/html/home/envdev; composer update --lock"
+start: ## Start all containers
+start: servers
 
-homepage:
-	x-www-browser envdev.localhost
+stop: ## Stop all containers
+	@echo '******** Stopping all containers... ********'
+	@docker-compose down
+
+restart: ## Restart all containers
+restart: stop servers
+
+certificate: ## Generate a SSL certificate
+	@echo '******** Generate a SSL certificate ********'
+	@docker run -ti --rm -v $(shell pwd)/conf/ssl:/app/ssl vfac/certificates /app/certificate.sh
+
+renewal: ## Renewal a knowed SSL certificate
+	@echo '******** Renew a SSL certificate ********'
+	@docker run -ti --rm -v $(shell pwd)/conf/ssl:/app/ssl vfac/certificates /app/regenerate_certificate.sh
+
+install: ## Install EnvDev container environment
+	@echo '******** Install EnvDev container environment ********'
+	@docker-compose build --force-rm --no-cache && docker run --rm -v $(shell pwd):/var/www/html -u "$(USER_ID):$(GROUP_ID)" vfac/envdevphpbase:$(PHP_VERSION) sh -c "cd /var/www/html/home/envdev; composer update --lock"
+
+homepage: ## Launch EnvDev homepage in default browser
+	@echo '******** Launch Homepage in browser ********'
+	@x-www-browser envdev.localhost

README.md

@@ -10,7 +10,6 @@ This environment provies the following tools to develop in PHP :
 
 Available version :
 
-    - `5.6`
     - `7.0`
     - `7.1`
     - `7.2`
@@ -64,6 +63,36 @@ All of them are in Alpine version
 
 - [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
+```
+
 ### Optional tools
 
 Optional tools are available to use in EnvDev. They are not included by default but can be added easily.
@@ -106,6 +135,12 @@ To start the environment, type the following command:
 make servers
 ```
 
+or
+
+```shell
+make start
+```
+
 Several containers are created from `.env` configuration:
 
 | Description | Container's name |
@@ -185,6 +220,56 @@ In `conf/apache/vhosts` directory, all your `yourhost.conf` file. A default host
 </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.
@@ -194,11 +279,12 @@ The following versions, paths and ports can be configured :
 
 | Description | Variable name | Possible values | Default |
 |:-------------|:---------------:|:-----------------:|:---------:|
-| PHP Version | PHP_VERSION | `5.6`, `7.0`, `7.1`, `7.2` | `7.2` |
+| PHP Version | PHP_VERSION | `7.0`, `7.1`, `7.2` | `7.2` |
 | 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` |

conf/apache/httpd.conf

@@ -50,7 +50,7 @@ ServerRoot "/usr/local/apache2"
 #
 #Listen 12.34.56.78:80
 Listen 80
-
+Listen 443
 #
 # Dynamic Shared Object (DSO) Support
 #

conf/apache/vhosts/envdev_home.conf

@@ -1,7 +1,11 @@
-<VirtualHost *:80>
+<VirtualHost *:80 *:443>
     ServerName envdev.localhost
     ServerAlias envdev
 
+    SSLEngine on
+    SSLCertificateFile /usr/local/apache2/conf/custom/envdev.crt
+    SSLCertificateKeyFile /usr/local/apache2/conf/custom/envdev.key
+
     DocumentRoot /var/www/html/envdev_home/envdev/public
 
     <Directory "/var/www/html/envdev_home/envdev/public">

conf/nginx/vhosts/envdev_home.conf

@@ -1,6 +1,12 @@
 server {
 
     listen 80;
+
+    listen 443 ssl;
+
+    ssl_certificate /etc/nginx/ssl/envdev.crt;
+    ssl_certificate_key /etc/nginx/ssl/envdev.key;
+
     server_name envdev.localhost envdev;
     root /var/www/html/envdev_home/envdev/public;
     index index.php index.html index.htm;

conf/ssl/envdev.crt

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICDzCCAXgCCQDcva593INAITANBgkqhkiG9w0BAQsFADBMMQswCQYDVQQGEwJG
+UjETMBEGA1UECAwKU29tZS1TdGF0ZTENMAsGA1UECgwEVkZBQzEZMBcGA1UEAwwQ
+ZW52ZGV2LmxvY2FsaG9zdDAeFw0xODA1MTgxMzU1NDZaFw0xOTA1MTgxMzU1NDZa
+MEwxCzAJBgNVBAYTAkZSMRMwEQYDVQQIDApTb21lLVN0YXRlMQ0wCwYDVQQKDARW
+RkFDMRkwFwYDVQQDDBBlbnZkZXYubG9jYWxob3N0MIGfMA0GCSqGSIb3DQEBAQUA
+A4GNADCBiQKBgQCugJaBsmHXRMNayI1ZDfeSjMoK8taLKEjmz2Godc4LAzRzyRD7
+0MPYbX3LYBfTxgXh9jTUeczKWzWmcxaWUCZf/u3n7E528BNo2h3vHq8iLW6Rs6lv
+qTsmbvToAB09XvX0ZbroQZc3GtSP2x20mzPdvX1D6sUrkT+TVe4UhRET+wIDAQAB
+MA0GCSqGSIb3DQEBCwUAA4GBAKtmIYK73FyPWhs8GFlOwLyqZrIHTEiXOzuDoAZd
+EBTGTs0uD2hRtZg+QYGa0t7ZtMng7WigkgeluSs3Oa52hN3ul4kTzPnGbMH7jC6v
+Qp8FKkKA4J9KyVUitnhCjCOgxJozpUoMBTwns5eWWnuWcgYSfhRGNN8kOLT4VjW5
+C8c4
+-----END CERTIFICATE-----

conf/ssl/envdev.csr

@@ -0,0 +1,11 @@
+-----BEGIN CERTIFICATE REQUEST-----
+MIIBizCB9QIBADBMMQswCQYDVQQGEwJGUjETMBEGA1UECAwKU29tZS1TdGF0ZTEN
+MAsGA1UECgwEVkZBQzEZMBcGA1UEAwwQZW52ZGV2LmxvY2FsaG9zdDCBnzANBgkq
+hkiG9w0BAQEFAAOBjQAwgYkCgYEAroCWgbJh10TDWsiNWQ33kozKCvLWiyhI5s9h
+qHXOCwM0c8kQ+9DD2G19y2AX08YF4fY01HnMyls1pnMWllAmX/7t5+xOdvATaNod
+7x6vIi1ukbOpb6k7Jm706AAdPV719GW66EGXNxrUj9sdtJsz3b19Q+rFK5E/k1Xu
+FIURE/sCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4GBAJnnODAo01hkOPfxmWPMSSM0
+dj9q7uw96FK06zOgX7rCSWFAdhHeYJR7T3BTDE8s7AFboUf64a0DvUjzstOxcEfN
+tX3IJ6I5+ZKH2YqiErWsex/vXoNYAxvsK+O/zZBpqZPefDmDwJF8Igyvm9BxL21L
+rv1G3OCMSXkEiCRSCYm7
+-----END CERTIFICATE REQUEST-----