improve docker setup

fixes #13

Author: cebe

Makefile

@@ -1,12 +1,30 @@
+# set user to "root" to run commands as root in docker
+USER=$$(whoami)
+# The docker command to execute commands directly in docker
+DOCKER=docker-compose exec --user=$(USER) backend-php
+# The PHP binary to use, you may add arguments to PHP here
+PHP=php
 
+
+# default target lists general usage information
 default:
 	@echo "The following commands are available:"
 	@echo ""
-	@echo "  make start        start PHP built-in webserver"
-	@echo "  make stop         stop PHP built-in webserver"
+	@echo "  make start          start PHP built-in webserver"
+	@echo "  make stop           stop PHP built-in webserver"
+	@echo "  make start-docker   start docker environment"
+	@echo "  make stop-docker    stop docker environment"
+	@echo "  make cli            run bash in docker environment"
+	@echo "  make bash           alias for 'make cli'"
+
+
+.PHONY: start stop start-docker stop-docker clean test bash cli
+
+
+## PHP runtime ##
 
 # start PHP built-in webserver
-start:
+start: config/components-dev.local.php config/components-test.local.php backend/config/cookie-validation.key env.php
 	@echo "Starting server for api"
 	cd api && $(MAKE) start
 	@echo "Starting server for backend"
@@ -17,27 +35,30 @@ stop:
 	cd api && $(MAKE) stop
 	cd backend && $(MAKE) stop
 
-test:
-	cd api && $(MAKE) test
 
-clean: stop
+## Docker Runtime ##
 
-.PHONY: start stop clean test
+# run bash inside docker container
+bash: cli
+cli:
+	$(DOCKER) bash
 
-docker-up: config/components-dev.local.php config/components-test.local.php env.php stop
+start-docker: config/components-dev.local.php config/components-test.local.php backend/config/cookie-validation.key env.php
 	docker-compose up -d
-	docker-compose exec backend-php sh -c 'cd /app && composer install'
+	$(DOCKER) sh -c 'cd /app && composer install'
 	@echo ""
 	@echo "API:      http://localhost:8337/"
 #	@echo "API docs: http://localhost:8337/docs/index.html" # not yet :)
 	@echo "Backend:  http://localhost:8338/"
 	@echo ""
 
-cli:
-	docker-compose exec backend-php bash
+stop-docker:
+	docker-compose down
 
 # copy config files if they do not exist
 config/components-%.local.php: config/components-ENV.local.php
 	test -f $@ || cp $< $@
 env.php: env.php.dist
 	test -f $@ || cp $< $@
+backend/config/cookie-validation.key:
+	test -s $@ || php -r 'echo bin2hex(random_bytes(20));' > $@

README.md

@@ -55,14 +55,16 @@ You need to adjust `config/components-dev.local.php` to configure your database
 
 After that, run `make start` and `make stop` to control the PHP webservers for API and backend.
 
+You may use `XDEBUGW=1` to enable xdebug for the webserver, e.g. `make XDEBUGW=1 start`.
+
 You can now continue with [generating code](#generate-code).
 
 ### Using Docker
 
 You need [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed.
 For the easiest way you need GNU make, then run:
 
-    make docker-up
+    make start-docker
 
 This uses `docker-compose` to start docker containers for the API and the backend including a database.
 
@@ -76,8 +78,6 @@ You can now continue with [generating code](#generate-code).
 
 ## Generate Code <span id="generate-code"></span>
 
-Note: If OpenAPI spec file is present locally on the file system, then for UNIX bases OS, `openApiPath` must start with `/` and should provide aboslute path instead of relative path from the current directory. Example: `/home/user/documents/MyProjectOpenAPISpec.yml`
-
 ### Console
 
 > Tip: If you use Docker, run `make cli` before running any of these commands.
@@ -87,6 +87,9 @@ spec file. The following example will generate API code for the [OpenAPI petstor
 
     ./yii gii/api --openApiPath=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.0.2/examples/v3.0/petstore-expanded.yaml
 
+> Note: If the OpenAPI spec file is present locally on the file system, then `openApiPath` must be specified as an absolute path, relative paths will not work correctly.
+> On UNIX based OS it must start with `/`. Example: `/home/user/documents/MyProjectOpenAPISpec.yml`
+
 Run `./yii gii/api --help` for a list of configuration options. You may also adjust the configuration in `config/gii-generators.php`.
 
 Then set up the database:

api/Makefile

@@ -8,10 +8,10 @@ XDEBUGW=0
 WEBPORT=8337
 
 ifeq ($(XDEBUG),1)
-  XDEBUGARGS=-dzend_extension=xdebug.so -dxdebug.remote_enable=1
+  XDEBUGARGS=-dzend_extension=xdebug.so -dxdebug.mode=debug,develop -dxdebug.start_with_request=yes -dxdebug.discover_client_host=yes -dxdebug.remote_enable=1 -dxdebug.remote_autostart=1
 endif
 ifeq ($(XDEBUGW),1)
-  XDEBUGARGSW=-dzend_extension=xdebug.so -dxdebug.remote_enable=1
+  XDEBUGARGSW=-dzend_extension=xdebug.so -dxdebug.mode=debug,develop -dxdebug.start_with_request=yes -dxdebug.discover_client_host=yes -dxdebug.remote_enable=1 -dxdebug.remote_autostart=1
 endif
 
 
@@ -20,11 +20,11 @@ current_dir=$(shell pwd)
 default:
 
 start: stop
-	@echo "Starting PHP webserver at http://localhost:$(WEBPORT), see php.log for access log."
+	@echo "Starting PHP webserver at http://localhost:$(WEBPORT), see logs/php-api.log for access log."
 	@echo ""
 	@echo "Run  make stop  to stop it."
 	@echo ""
-	YII_ENV=dev php $(PHPARGS) $(XDEBUGARGSW) -S localhost:$(WEBPORT) -t web $(current_dir)/router.php >php.log 2>&1 & echo "$$!" > php.pid
+	YII_ENV=dev php $(PHPARGS) $(XDEBUGARGSW) -S localhost:$(WEBPORT) -t web $(current_dir)/router.php >../logs/php-api.log 2>&1 & echo "$$!" > php.pid
 
 stop:
 	@echo "Stopping PHP webserver..."

backend/Makefile

@@ -8,10 +8,10 @@ XDEBUGW=0
 WEBPORT=8338
 
 ifeq ($(XDEBUG),1)
-  XDEBUGARGS=-dzend_extension=xdebug.so -dxdebug.remote_enable=1
+  XDEBUGARGS=-dzend_extension=xdebug.so -dxdebug.mode=debug,develop -dxdebug.start_with_request=yes -dxdebug.discover_client_host=yes -dxdebug.remote_enable=1 -dxdebug.remote_autostart=1
 endif
 ifeq ($(XDEBUGW),1)
-  XDEBUGARGSW=-dzend_extension=xdebug.so -dxdebug.remote_enable=1
+  XDEBUGARGSW=-dzend_extension=xdebug.so -dxdebug.mode=debug,develop -dxdebug.start_with_request=yes -dxdebug.discover_client_host=yes -dxdebug.remote_enable=1 -dxdebug.remote_autostart=1
 endif
 
 
@@ -20,11 +20,11 @@ current_dir=$(shell pwd)
 default:
 
 start: stop
-	@echo "Starting PHP webserver at http://localhost:$(WEBPORT), see php.log for access log."
+	@echo "Starting PHP webserver at http://localhost:$(WEBPORT), see logs/php-backend.log for access log."
 	@echo ""
 	@echo "Run  make stop  to stop it."
 	@echo ""
-	YII_ENV=dev php $(PHPARGS) $(XDEBUGARGSW) -S localhost:$(WEBPORT) -t web $(current_dir)/router.php >php.log 2>&1 & echo "$$!" > php.pid
+	YII_ENV=dev php $(PHPARGS) $(XDEBUGARGSW) -S localhost:$(WEBPORT) -t web $(current_dir)/router.php >../logs/php-backend.log 2>&1 & echo "$$!" > php.pid
 
 stop:
 	@echo "Stopping PHP webserver..."

backend/config/.gitignore

@@ -0,0 +1 @@
+/cookie-validation.key

backend/config/components.php

@@ -6,7 +6,7 @@
 
 return [
     'request' => [
-        'cookieValidationKey' => 'api1337', // TODO this should be dynamic
+        'cookieValidationKey' => file_get_contents(__DIR__ . '/cookie-validation.key'),
     ],
 
     'urlManager' => [