From 3d2701615b661871d013410e3cb4dec58b794c7d Mon Sep 17 00:00:00 2001 From: alext Date: Mon, 16 Jan 2017 23:46:59 +0100 Subject: [PATCH] Added Docker documentation. --- doc/docker.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 doc/docker.md diff --git a/doc/docker.md b/doc/docker.md new file mode 100644 index 00000000..d81396f6 --- /dev/null +++ b/doc/docker.md @@ -0,0 +1,40 @@ +# Docker + +Run the development containers of Easy!Appointments with Docker and Docker Compose utility. Docker allows you to compose your application from microservices, without worrying about inconsistencies between development and production environments and without locking into any platform or language. + +Make sure that you have Docker and Docker compose installed and configured in your system and execute the following command through your terminal while being in the Git clone directory: + +`docker-compose up` + +Then modify the root `config.php` so that it matches the following example: + +```php +class Config { + // ------------------------------------------------------------------------ + // GENERAL SETTINGS + // ------------------------------------------------------------------------ + + const BASE_URL = 'http://{DOCKER-SERVER-IP}'; // e.g. 192.168.99.100 + const LANGUAGE = 'english'; + const DEBUG_MODE = TRUE; + + // ------------------------------------------------------------------------ + // DATABASE SETTINGS + // ------------------------------------------------------------------------ + + const DB_HOST = 'database'; + const DB_NAME = 'easyappointments'; + const DB_USERNAME = 'root'; + const DB_PASSWORD = 'root'; + + // ------------------------------------------------------------------------ + // GOOGLE CALENDAR SYNC + // ------------------------------------------------------------------------ + + const GOOGLE_SYNC_FEATURE = FALSE; + const GOOGLE_PRODUCT_NAME = ''; + const GOOGLE_CLIENT_ID = ''; + const GOOGLE_CLIENT_SECRET = ''; + const GOOGLE_API_KEY = ''; +} +```