Update README

This commit is contained in:
Vincent Letourneau
2017-07-28 13:19:54 +02:00
parent 18cf2e57cd
commit 170993c731

View File

@@ -4,8 +4,6 @@ Docker running Nginx, PHP-FPM, Composer, MySQL and PHPMyAdmin.
## Overview ## Overview
---
1. [Install prerequisites](#install-prerequisites) 1. [Install prerequisites](#install-prerequisites)
Before installing project make sure the following prerequisites have been met. Before installing project make sure the following prerequisites have been met.
@@ -77,6 +75,8 @@ This project use the following ports :
| Nginx | 8000 | | Nginx | 8000 |
| Nginx SSL | 3000 | | Nginx SSL | 3000 |
---
## Clone the project ## Clone the project
To install [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), download it and install following the instructions : To install [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), download it and install following the instructions :
@@ -123,12 +123,14 @@ cd docker-nginx-php-mysql
└── index.php └── index.php
``` ```
---
## Configure Nginx With SSL Certificates ## Configure Nginx With SSL Certificates
1. Generate SSL certificates 1. Generate SSL certificates
```sh ```sh
docker run --rm -v $(PWD)/etc/ssl:/certificates -e "SERVER=localhost" jacoelho/generate-certificate sudo docker run --rm -v $(pwd)/etc/ssl:/certificates -e "SERVER=localhost" jacoelho/generate-certificate
``` ```
2. Configure Nginx 2. Configure Nginx
@@ -144,6 +146,8 @@ cd docker-nginx-php-mysql
# } # }
``` ```
---
## Run the application ## Run the application
1. Copying the composer configuration file : 1. Copying the composer configuration file :
@@ -172,9 +176,11 @@ cd docker-nginx-php-mysql
sudo docker-compose stop && sudo docker-compose kill && sudo docker-compose rm -f sudo docker-compose stop && sudo docker-compose kill && sudo docker-compose rm -f
``` ```
---
## Use Makefile ## Use Makefile
When developing, you can use the [Makefile](https://en.wikipedia.org/wiki/Make_(software)) for doing the following operations : When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(software)) for doing the following operations :
| Name | Description | | Name | Description |
|---------------|-----------------------------------------| |---------------|-----------------------------------------|
@@ -203,6 +209,8 @@ Show help :
sudo make help sudo make help
``` ```
---
## Use Docker commands ## Use Docker commands
### Updating PHP dependencies with composer ### Updating PHP dependencies with composer
@@ -262,10 +270,10 @@ source .env && sudo docker exec -i mysql mysqldump test -u"$MYSQL_ROOT_USER" -p"
?> ?>
``` ```
## Help us !
--- ---
## Help us !
Any thought, feedback or (hopefully not!) Any thought, feedback or (hopefully not!)
Developed by [@letvinz](https://twitter.com/letvinz) Developed by [@letvinz](https://twitter.com/letvinz)