Symfony Docker

Complete Docker stack for Symfony with NGINX, PHP, MySQL, LocalStack, MailHog, Redis, RabbitMQ, Elasticsearch and Keycloak using docker-compose tool.

+-------+---------+-------+------------+---------+-------+----------+---------------+----------+ 
|       |         |       |            |         |       |          |               |          |
| NGINX | PHP-FPM | MySQL | LocakStack | MailHog | Redis | RabbitMQ | Elasticsearch | Keycloak |
|       |         |       |            |         |       |          |               |          |
+-------+---------+-------+------------+---------+-------+----------+---------------+----------+ 
|                                                                                              |
|                                         Docker Engine                                        |
|                                                                                              |
+----------------------------------------------------------------------------------------------+
|                                                                                              |
|                                            Host OS                                           |
|                                                                                              |
+----------------------------------------------------------------------------------------------+

Table of Contents

1. Requirements
2. Features
3. Configuration
   1. Configuration reference
   2. Ports
4. Installation
5. Usage
   1. Start
   2. Stop
   3. Get into container
   4. Docker scripts
6. To do

Requirements

Docker Engine 19.03.0 or newer.

Features

• NGINX - web server
• PHP-FPM - PHP FastCGI Proces Manager
• Xdebug - PHP extension for debugging and coverage
• MySQL - relational database
• LocalStack - complete, localized AWS environment
• MailHog - web and API based SMTP testing tool
• Redis - in-memory data structure storage
• RabbitMQ - open source message broker
• Elasticsearch - search and analytics engine
• Keycloak - open source identity and access management solution

Configuration

Configuration reference

You can create .env file located in root folder and override default values.

PHP_CONTAINER_NAME=php                      # PHP-FPM container name
NGINX_CONTAINER_NAME=nginx                  # NGINX container name
DATABASE_CONTAINER_NAME=database            # Database container name
S3_CONTAINER_NAME=minio                     # MinIO container name
STORAGE_LOGIN=storage_login                 # MinIO key/login
STORAGE_PASSWORD=storage_password           # MinIO secret/password
MAILHOG_CONTAINER_NAME=mailhog              # MailHog container name
DOCKER_HOST_UID=1000                        # Your system user ID (UID)
DOCKER_HOST_GID=1000                        # Your system group ID (GID)
RABBIT_MQ_CONTAINER_NAME=rabbit_mq          # RabbitMQ container name
ELASTICSEARCH_CONTAINER_NAME=elasticsearch  # Elasticsearch container name
KEYCLOAK_CONTAINER_NAME=keycloak            # Keycloak container name

Check your user ID:

$ id -u
# or
$ id -u <username>

Check your group ID:

$ id -g
# or
$ id -g <username>

Ports

• NGINX works on port 8000, http://127.0.0.1:8000
• MySQL works on port 3306 inside docker network, and on port 13306 outside docker network.
• LocalStack gateway works on port 4566
• MailHog web works on port 8025, http://127.0.0.1:8025. SMTP works on port 1025, smtp://[mailhog_container_name]:1025
• Redis works on port 6379 inside docker network, and on port 16379 outside docker network.
• RabbitMQ works on port 5672, and RabbitMQ GUI work on port 15672 with guest login and password.
• Elasticsearch works on port 9200 and requires default credentials, login: elastic and password: password.
• Xdebug works on port 9001, idkey is PHPSTORM
• Keycloak works on port 8080

NAME                COMMAND                  SERVICE             STATUS              PORTS
database            "docker-entrypoint.s…"   database            running             33060/tcp, 0.0.0.0:13306->3306/tcp, :::13306->3306/tcp
elasticsearch       "/bin/tini -- /usr/l…"   elasticsearch       running             0.0.0.0:9200->9200/tcp, :::9200->9200/tcp, 9300/tcp
keycloak            "/opt/keycloak/bin/k…"   keycloak            running             8443/tcp, 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp, 9000/tcp
localstack          "docker-entrypoint.sh"   localstack          running (healthy)   0.0.0.0:4510-4559->4510-4559/tcp, :::4510-4559->4510-4559/tcp, 0.0.0.0:4566->4566/tcp, :::4566->4566/tcp, 5678/tcp
mailhog             "MailHog"                mailhog             running             0.0.0.0:1025->1025/tcp, :::1025->1025/tcp, 0.0.0.0:8025->8025/tcp, :::8025->8025/tcp
nginx               "/docker-entrypoint.…"   nginx               running             0.0.0.0:8000->80/tcp, :::8000->80/tcp, 0.0.0.0:1443->443/tcp, :::1443->443/tcp
php                 "docker-php-entrypoi…"   php                 running             9000/tcp
rabbit_mq           "docker-entrypoint.s…"   rabbit_mq           running             4369/tcp, 5671/tcp, 0.0.0.0:5672->5672/tcp, :::5672->5672/tcp, 15671/tcp, 15691-15692/tcp, 25672/tcp, 0.0.0.0:15672->15672/tcp, :::15672->15672/tcp
redis               "docker-entrypoint.s…"   redis               running             0.0.0.0:16379->6379/tcp, :::16379->6379/tcp

Installation

To install Symfony Docker, clone this repository, then build containers:

$ make build

and run:

$ make up

When containers are up and running create bucket and add policy using MinIO web interface: http://127.0.0.1:9090. To log in use STORAGE_LOGIN and STORAGE_PASSWORD values.

Put your Symfony project into /app folder. To set up database connection in Symfony just add in .env file:

DATABASE_URL=mysql://dbuser:password@database:3306/symfony?serverVersion=8.4

If you want to connect to MySQL from outside e.g. in PHPSTROM or any other SQL Client use credentials:

MYSQL_DATABASE: symfony
MYSQL_USER: dbuser
MYSQL_PASSWORD: password
MYSQL_HOST: ${DATABASE_CONTAINER_NAME:-database}
MYSQL_PORT: 13306

Usage

Type make help to check Makefile commands.

Start

To start docker containers in the background:

$ make up

Stop

Stop docker containers and remove docker network run:

$ make down

Get into container

Usually you don't need to do anything inside container except in the php one. To get into any container run:

$ make sh

To do

• improve documentation