easyappointments/docs/docker.md

# Docker

Run the development containers of Easy!Appointments with Docker and Docker Compose utility. Docker allows you to compose
your application in microservices, so that you can easily get started with the local development.

Simply clone the project and run `docker compose up` to start the environment.

You will need modify the root `config.php` so that it matches the following example:

```php 
class Config {
    // ------------------------------------------------------------------------
    // GENERAL SETTINGS
    // ------------------------------------------------------------------------
    
    const BASE_URL      = 'http://localhost:8000'; 
    const LANGUAGE      = 'english';
    const DEBUG_MODE    = TRUE;

    // ------------------------------------------------------------------------
    // DATABASE SETTINGS
    // ------------------------------------------------------------------------
    
    const DB_HOST       = 'mysql';
    const DB_NAME       = 'easyappointments';
    const DB_USERNAME   = 'easyappointments';
    const DB_PASSWORD   = 'secret';

    // ------------------------------------------------------------------------
    // GOOGLE CALENDAR SYNC
    // ------------------------------------------------------------------------
    
    const GOOGLE_SYNC_FEATURE   = FALSE; // You can optionally enable the Google Sync feature. 
    const GOOGLE_PRODUCT_NAME   = '';
    const GOOGLE_CLIENT_ID      = '';
    const GOOGLE_CLIENT_SECRET  = '';
    const GOOGLE_API_KEY        = '';
}
```

In the host machine the server is accessible from `http://localhost:8000` and the database from `localhost:8001`.

You can additionally access phpMyAdmin from `http://localhost:8002` and MailHog from `http://localhost:8003`.

**Attention:** This configuration is mend to make development easier. It is not intended to server as a production
environment!

A production image of Easy!Appointments is available at: https://github.com/alextselegidis/easyappointments-docker

*This document applies to Easy!Appointments v1.4.3.*

[Back](readme.md)