Fully functional

2018-07-06 17:48:13 -04:00
parent 813a1f8110
commit d221a31eaa
25 changed files with 94 additions and 446 deletions
--- a/README.md
+++ b/README.md
@@ -1,42 +1,16 @@
-# Nginx PHP MySQL [![Build Status](https://travis-ci.org/nanoninja/docker-nginx-php-mysql.svg?branch=master)](https://travis-ci.org/nanoninja/docker-nginx-php-mysql) [![GitHub version](https://badge.fury.io/gh/nanoninja%2Fdocker-nginx-php-mysql.svg)](https://badge.fury.io/gh/nanoninja%2Fdocker-nginx-php-mysql)
-
-Docker running Nginx, PHP-FPM, Composer, MySQL and PHPMyAdmin.
-
 ## Overview

 1. [Install prerequisites](#install-prerequisites)

-    Before installing project make sure the following prerequisites have been met.
-
 2. [Clone the project](#clone-the-project)

-    We’ll download the code from its repository on GitHub.
-
-3. [Configure Nginx With SSL Certificates](#configure-nginx-with-ssl-certificates) [`Optional`]
-
-    We'll generate and configure SSL certificate for nginx before running server.
-
-4. [Configure Xdebug](#configure-xdebug) [`Optional`]
-
-    We'll configure Xdebug for IDE (PHPStorm or Netbeans).
-
-5. [Run the application](#run-the-application)
-
-    By this point we’ll have all the project pieces in place.
-
-6. [Use Makefile](#use-makefile) [`Optional`]
-
-    When developing, you can use `Makefile` for doing recurrent operations.
-
-7. [Use Docker Commands](#use-docker-commands)
-
-    When running, you can use docker commands for doing recurrent operations.
+3. [Run the application](#run-the-application)

 ___

 ## Install prerequisites

-For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows.
+This project has been created for `(Linux/MacOS)`.

 All requisites should be available for your distribution. The most important are :

@@ -44,47 +18,25 @@ All requisites should be available for your distribution. The most important are
 * [Docker](https://docs.docker.com/engine/installation/)
 * [Docker Compose](https://docs.docker.com/compose/install/)

-Check if `docker-compose` is already installed by entering the following command : 
+Check if `docker-compose` is already installed by entering the following command :

 ```sh
 which docker-compose
 ```

-Check Docker Compose compatibility :
-
-* [Compose file version 3 reference](https://docs.docker.com/compose/compose-file/)
-
-The following is optional but makes life more enjoyable :
-
-```sh
-which make
-```
-
 On Ubuntu and Debian these are available in the meta-package build-essential. On other distributions, you may need to install the GNU C++ compiler separately.

 ```sh
 sudo apt install build-essential
 ```

-### Images to use
-
-* [Nginx](https://hub.docker.com/_/nginx/)
-* [MySQL](https://hub.docker.com/_/mysql/)
-* [PHP-FPM](https://hub.docker.com/r/nanoninja/php-fpm/)
-* [Composer](https://hub.docker.com/_/composer/)
-* [PHPMyAdmin](https://hub.docker.com/r/phpmyadmin/phpmyadmin/)
-* [Generate Certificate](https://hub.docker.com/r/jacoelho/generate-certificate/)
-
-You should be careful when installing third party web servers such as MySQL or Nginx.
-
 This project use the following ports :

 | Server     | Port |
 |------------|------|
-| MySQL      | 8989 |
+| MySQL      | 3306 |
 | PHPMyAdmin | 8080 |
-| Nginx      | 8000 |
-| Nginx SSL  | 3000 |
+| Nginx      | 80   |

 ___

@@ -102,37 +54,6 @@ Go to the project directory :
 cd docker-nginx-php-mysql
 ```

-### Project tree
-
-```sh
-.
-├── Makefile
-├── README.md
-├── data
-│   └── db
-│       ├── dumps
-│       └── mysql
-├── doc
-├── docker-compose.yml
-├── etc
-│   ├── nginx
-│   │   ├── default.conf
-│   │   └── default.template.conf
-│   ├── php
-│   │   └── php.ini
-│   └── ssl
-└── web
-    ├── app
-    │   ├── composer.json.dist
-    │   ├── phpunit.xml.dist
-    │   ├── src
-    │   │   └── Foo.php
-    │   └── test
-    │       ├── FooTest.php
-    │       └── bootstrap.php
-    └── public
-        └── index.php
-```

 ___

@@ -142,17 +63,11 @@ You can change the host name by editing the `.env` file.

 If you modify the host name, do not forget to add it to the `/etc/hosts` file.

-1. Generate SSL certificates
+1. Configure Nginx

-    ```sh
-    source .env && sudo docker run --rm -v $(pwd)/etc/ssl:/certificates -e "SERVER=$NGINX_HOST" jacoelho/generate-certificate
-    ```
+    Do not modify the `Website/etc/nginx/default.conf` file, it is overwritten by  `Website/etc/nginx/default.template.conf`

-2. Configure Nginx
-
-    Do not modify the `etc/nginx/default.conf` file, it is overwritten by  `etc/nginx/default.template.conf`
-
-    Edit nginx file `etc/nginx/default.template.conf` and uncomment the SSL server section :
+    Edit nginx file `Website/etc/nginx/default.template.conf` and uncomment the SSL server section :

    ```sh
    # server {
@@ -166,206 +81,74 @@ If you modify the host name, do not forget to add it to the `/etc/hosts` file.

 ___

-## Configure Xdebug
-
-If you use another IDE than [PHPStorm](https://www.jetbrains.com/phpstorm/) or [Netbeans](https://netbeans.org/), go to the [remote debugging](https://xdebug.org/docs/remote) section of Xdebug documentation.
-
-For a better integration of Docker to PHPStorm, use the [documentation](https://github.com/nanoninja/docker-nginx-php-mysql/blob/master/doc/phpstorm-macosx.md).
-
-1. Get your own local IP address :
-
-    ```sh
-    sudo ifconfig
-    ```
-
-2. Edit php file `etc/php/php.ini` and comment or uncomment the configuration as needed.
-
-3. Set the `remote_host` parameter with your IP :
-
-    ```sh
-    xdebug.remote_host=192.168.0.1 # your IP
-    ```
-___
-
 ## Run the application

-1. Copying the composer configuration file : 
+1. Start the Docker application :

    ```sh
-    cp web/app/composer.json.dist web/app/composer.json
-    ```
-
-2. Start the application :
-
-    ```sh
-    sudo docker-compose up -d
+    sudo make start
    ```

    **Please wait this might take a several minutes...**

    ```sh
-    sudo docker-compose logs -f # Follow log output
+    sudo make logs # Follow log output
    ```

-3. Open your favorite browser :
-
-    * [http://localhost:8000](http://localhost:8000/)
-    * [https://localhost:3000](https://localhost:3000/) ([HTTPS](#configure-nginx-with-ssl-certificates) not configured by default)
-    * [http://localhost:8080](http://localhost:8080/) PHPMyAdmin (username: dev, password: dev)
-
-4. Stop and clear services
+2. Clone the required git repositories:

    ```sh
-    sudo docker-compose down -v
+    sudo make clone
+    ```
+
+3. Import the required databases:
+
+    ```sh
+    sudo make import
+    ```
+
+4. Open your favorite browser :
+
+    * [http://localhost](http://localhost/)
+    * [http://localhost:8080](http://localhost:8080/) PHPMyAdmin (username: root, password: root)
+
+5. Backup your databases:
+
+    ```sh
+    sudo make backup
+    ```
+
+6. Restore your databases:
+
+    ```sh
+    sudo make restore
+    ```
+
+7. Get help:
+
+    ```sh
+    sudo make help
+    ```
+
+8. Stop the application:
+
+    ```sh
+    sudo make stop
    ```

 ___

-## Use Makefile
-
-When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(software)) for doing the following operations :
+## Additional commands

 | Name          | Description                                  |
 |---------------|----------------------------------------------|
-| apidoc        | Generate documentation of API                |
-| clean         | Clean directories for reset                  |
-| code-sniff    | Check the API with PHP Code Sniffer (`PSR2`) |
-| composer-up   | Update PHP dependencies with composer        |
-| docker-start  | Create and start containers                  |
-| docker-stop   | Stop and clear all services                  |
-| gen-certs     | Generate SSL certificates for `nginx`        |
-| logs          | Follow log output                            |
-| mysql-dump    | Create backup of all databases               |
-| mysql-restore | Restore backup of all databases              |
-| phpmd         | Analyse the API with PHP Mess Detector       |
-| test          | Test application with phpunit                |
-
-### Examples
-
-Start the application :
-
-```sh
-sudo make docker-start
-```
-
-Show help :
-
-```sh
-make help
-```
-
-___
-
-## Use Docker commands
-
-### Installing package with composer
-
-```sh
-sudo docker run --rm -v $(pwd)/web/app:/app composer require symfony/yaml
-```
-
-### Updating PHP dependencies with composer
-
-```sh
-sudo docker run --rm -v $(pwd)/web/app:/app composer update
-```
-
-### Generating PHP API documentation
-
-```sh
-sudo docker-compose exec -T php php -d memory_limit=256M -d xdebug.profiler_enable=0 ./app/vendor/bin/apigen generate app/src --destination ./app/doc
-```
-
-### Testing PHP application with PHPUnit
-
-```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpunit --colors=always --configuration ./app
-```
-
-### Fixing standard code with [PSR2](http://www.php-fig.org/psr/psr-2/)
-
-```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpcbf -v --standard=PSR2 ./app/src
-```
-
-### Checking the standard code with [PSR2](http://www.php-fig.org/psr/psr-2/)
-
-```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpcs -v --standard=PSR2 ./app/src
-```
-
-### Analyzing source code with [PHP Mess Detector](https://phpmd.org/)
-
-```sh
-sudo docker-compose exec -T php ./app/vendor/bin/phpmd ./app/src text cleancode,codesize,controversial,design,naming,unusedcode
-```
-
-### Checking installed PHP extensions
-
-```sh
-sudo docker-compose exec php php -m
-```
-
-### Handling database
-
-#### MySQL shell access
-
-```sh
-sudo docker exec -it mysql bash
-```
-
-and
-
-```sh
-mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD"
-```
-
-#### Creating a backup of all databases
-
-```sh
-mkdir -p data/db/dumps
-```
-
-```sh
-source .env && sudo docker exec $(sudo docker-compose ps -q mysqldb) mysqldump --all-databases -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" > "data/db/dumps/db.sql"
-```
-
-#### Restoring a backup of all databases
-
-```sh
-source .env && sudo docker exec -i $(sudo docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/db.sql"
-```
-
-#### Creating a backup of single database
-
-**`Notice:`** Replace "YOUR_DB_NAME" by your custom name.
-
-```sh
-source .env && sudo docker exec $(sudo docker-compose ps -q mysqldb) mysqldump -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" --databases YOUR_DB_NAME > "data/db/dumps/YOUR_DB_NAME_dump.sql"
-```
-
-#### Restoring a backup of single database
-
-```sh
-source .env && sudo docker exec -i $(sudo docker-compose ps -q mysqldb) mysql -u"$MYSQL_ROOT_USER" -p"$MYSQL_ROOT_PASSWORD" < "data/db/dumps/YOUR_DB_NAME_dump.sql"
-```
-
-
-#### Connecting MySQL from [PDO](http://php.net/manual/en/book.pdo.php)
-
-```php
-<?php
-    try {
-        $dsn = 'mysql:host=mysql;dbname=test;charset=utf8;port=3306';
-        $pdo = new PDO($dsn, 'dev', 'dev');
-    } catch (PDOException $e) {
-        echo $e->getMessage();
-    }
-?>
-```
-
-___
-
-## Help us
-
-Any thought, feedback or (hopefully not!)
+| clone         | Clone the git repository folders             |
+| pull          | Get the latest git repository updates        |
+| start         | Create and start containers                  |
+| stop          | Stop all containers                          |
+| restart       | Restart all containers                       |
+| logs          | Display log output                           |
+| import        | Import all databases from git repositories   |
+| backup        | Create backup of all local databases         |
+| restore       | Restore backup of all local databases        |
+| flush         | Delete local git repository folders          |