H-O-O-T-S/Open-RSC-Docker-Home
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update make help description

Browse Source
This commit is contained in:
Vincent Letourneau
2017-07-30 15:30:05 +02:00
parent eb62e0466f
commit a8e0c22636
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@@ -13,9 +13,9 @@ help:
@echo " apidoc Generate documentation of API" @echo " apidoc Generate documentation of API"
@echo " code-sniff Check the API with PHP Code Sniffer (PSR2)" @echo " code-sniff Check the API with PHP Code Sniffer (PSR2)"
@echo " clean Clean directories for reset" @echo " clean Clean directories for reset"
@echo " composer-up Update php composer" @echo " composer-up Update PHP dependencies with composer"
@echo " docker-start Create and start containers" @echo " docker-start Create and start containers"
@echo " docker-stop Stop all services" @echo " docker-stop Stop and clear all services"
@echo " gen-certs Generate SSL certificates" @echo " gen-certs Generate SSL certificates"
@echo " logs Follow log output" @echo " logs Follow log output"
@echo " mysql-dump Create backup of whole database" @echo " mysql-dump Create backup of whole database"

12
README.md
View File

@@ -36,6 +36,8 @@ ___
## Install prerequisites ## Install prerequisites
For now, this project has been mainly created for Unix `(Linux/MacOS)`. Perhaps it could work on Windows. Make sure to make compatible the relative paths in the `docker-compose.yml` file configuration like `c:\foo\bar`.
All requisites should be available for your distribution. The most important are : All requisites should be available for your distribution. The most important are :
* [Git](https://git-scm.com/downloads) * [Git](https://git-scm.com/downloads)
@@ -140,7 +142,7 @@ cd docker-nginx-php-mysql
2. Configure Nginx 2. Configure Nginx
Edit nginx file `etc/nginx/default.conf` and uncomment the server section : Edit nginx file `etc/nginx/default.conf` and uncomment the SSL server section :
```sh ```sh
# server { # server {
@@ -155,7 +157,7 @@ cd docker-nginx-php-mysql
## Configure Xdebug ## Configure Xdebug
If you use another IDE than PHPStorm or Netbeans, go to the [`remote debugging`](https://xdebug.org/docs/remote) section of Xdebug documentation. If you use another IDE than PHPStorm or Netbeans, go to the [remote debugging](https://xdebug.org/docs/remote) section of Xdebug documentation.
1. Get your own local IP address : 1. Get your own local IP address :
@@ -171,6 +173,8 @@ If you use another IDE than PHPStorm or Netbeans, go to the [`remote debugging`]
xdebug.remote_host=192.168.0.1 # your IP xdebug.remote_host=192.168.0.1 # your IP
``` ```
---
## Run the application ## Run the application
1. Copying the composer configuration file : 1. Copying the composer configuration file :
@@ -214,9 +218,9 @@ When developing, you can use [Makefile](https://en.wikipedia.org/wiki/Make_(soft
| apidoc | Generate documentation of API | | apidoc | Generate documentation of API |
| clean | Clean directories for reset | | clean | Clean directories for reset |
| code-sniff | Check the API with PHP Code Sniffer (PSR2) | | code-sniff | Check the API with PHP Code Sniffer (PSR2) |
| composer-up | Update php composer | | composer-up | Update PHP dependencies with composer |
| docker-start | Create and start containers | | docker-start | Create and start containers |
| docker-stop | Stop all services | | docker-stop | Stop and clear all services |
| gen-certs | Generate SSL certificates for `nginx` | | gen-certs | Generate SSL certificates for `nginx` |
| logs | Follow log output | | logs | Follow log output |
| mysql-dump | Create backup of whole database | | mysql-dump | Create backup of whole database |