Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/systemsdk/docker-apache-php-symfony

Docker environment required to run Symfony (based on official php and mysql docker hub repositories)
https://github.com/systemsdk/docker-apache-php-symfony

apache apache2 bitbucket-pipelines circleci cron docker github-actions multi-environment mysql mysql8 php php8 rabbitmq ssl supervisord symfony symfony7 ubuntu xdebug

Last synced: about 4 hours ago
JSON representation

Docker environment required to run Symfony (based on official php and mysql docker hub repositories)

Awesome Lists containing this project

README 

        
# PHP symfony environment

Docker environment required to run Symfony (based on official php and mysql docker hub repositories).



[![Actions Status](https://github.com/systemsdk/docker-apache-php-symfony/workflows/Symfony%20App/badge.svg)](https://github.com/systemsdk/docker-apache-php-symfony/actions)

[![CircleCI](https://circleci.com/gh/systemsdk/docker-apache-php-symfony.svg?style=svg)](https://circleci.com/gh/systemsdk/docker-apache-php-symfony)

[![Coverage Status](https://coveralls.io/repos/github/systemsdk/docker-apache-php-symfony/badge.svg)](https://coveralls.io/github/systemsdk/docker-apache-php-symfony)

[![Latest Stable Version](https://poser.pugx.org/systemsdk/docker-apache-php-symfony/v)](https://packagist.org/packages/systemsdk/docker-apache-php-symfony)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)



[Source code](https://github.com/systemsdk/docker-apache-php-symfony.git)



## Requirements

* Docker Engine version 18.06 or later

* Docker Compose version 1.22 or later

* An editor or IDE

* MySQL Workbench



Note: OS recommendation - Linux Ubuntu based.



## Components

1. Apache 2.4

2. PHP 8.3 (Apache handler)

3. MySQL 8

4. Symfony 7

5. RabbitMQ 3

6. Mailpit (only for debug emails on dev environment)



## Setting up Docker Engine with Docker Compose

For installing Docker Engine with docker compose please follow steps mentioned on page [Docker Engine](https://docs.docker.com/engine/install/).



Note 1: Please run next cmd after above step if you are using Linux OS: `sudo usermod -aG docker $USER`



Note 2: If you are using Docker Desktop for MacOS 12.2 or later - please enable [virtiofs](https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/) for performance (enabled by default since Docker Desktop v4.22).



## Setting up DEV environment

1.You can clone this repository from GitHub or install via composer.



If you have installed composer and want to install environment via composer you can use next cmd command:

```bash

composer create-project systemsdk/docker-apache-php-symfony example-app

```



2.Set another APP_SECRET for application in .env.prod and .env.staging files.



Note 1: You can get unique secret key for example [here](http://nux.net/secret).



Note 2: Do not use .env.local.php on dev and test environment (delete it if exist).



Note 3: If you want to change default web port/xdebug configuration you can create .env.local file and set some params (see .env file).



Note 4: Delete var/mysql-data folder if it exists.



3.Add domain to local 'hosts' file:

```bash

127.0.0.1    localhost

```



4.Configure `/docker/dev/xdebug-main.ini` (Linux/Windows) or `/docker/dev/xdebug-osx.ini` (MacOS) (optional):



- In case you need debug only requests with IDE KEY: PHPSTORM from frontend in your browser:

```bash

xdebug.start_with_request = no

```

Install locally in Firefox extension "Xdebug helper" and set in settings IDE KEY: PHPSTORM



- In case you need debug any request to an api (by default):

```bash

xdebug.start_with_request = yes

```



5.Build, start and install the docker images from your terminal:

```bash

make build

make start

make composer-install

```



6.Make sure that you have installed migrations / messenger transports:

```bash

make migrate

make messenger-setup-transports

```



7.In order to use this application, please open in your browser next urls:

- [http://localhost](http://localhost)

- [http://localhost:15672 (RabbitMQ)](http://localhost:15672)

- [http://localhost:8025 (Mailpit)](http://localhost:8025)



## Setting up STAGING environment locally

1.You can clone this repository from GitHub or install via composer.



Note: Delete var/mysql-data folder if it is exist.



If you have installed composer and want to install environment via composer you can use next cmd command:

```bash

composer create-project systemsdk/docker-apache-php-symfony example-app

```



2.Build, start and install the docker images from your terminal:

```bash

make build-staging

make start-staging

```



3.Make sure that you have installed migrations / messenger transports:

```bash

make migrate-no-test

make messenger-setup-transports

```



## Setting up PROD environment locally

1.You can clone this repository from GitHub or install via composer.



If you have installed composer and want to install environment via composer you can use next cmd command:

```bash

composer create-project systemsdk/docker-apache-php-symfony example-app

```



2.Edit compose-prod.yaml and set necessary user/password for MySQL and RabbitMQ.



Note: Delete var/mysql-data folder if it is exist.



3.Edit env.prod and set necessary user/password for MySQL and RabbitMQ.



4.Build, start and install the docker images from your terminal:

```bash

make build-prod

make start-prod

```



5.Make sure that you have installed migrations / messenger transports:

```bash

make migrate-no-test

make messenger-setup-transports

```



## Getting shell to container

After application will start (`make start`) and in order to get shell access inside symfony container you can run following command:

```bash

make ssh

```

Note 1: Please use next make commands in order to enter in other containers: `make ssh-supervisord`, `make ssh-mysql`, `make ssh-rabbitmq`.



Note 2: Please use `exit` command in order to return from container's shell to local shell.



## Building containers

In case you edited Dockerfile or other environment configuration you'll need to build containers again using next commands:

```bash

make down

make build

make start

```

Note: Please use environment-specific commands if you need to build test/staging/prod environment, more details can be found using help `make help`.



## Start and stop environment containers

Please use next make commands in order to start and stop environment:

```bash

make start

make stop

```

Note 1: For staging environment need to be used next make commands: `make start-staging`, `make stop-staging`.



Note 2: For prod environment need to be used next make commands: `make start-prod`, `make stop-prod`.



## Stop and remove environment containers, networks

Please use next make commands in order to stop and remove environment containers, networks:

```bash

make down

```

Note: Please use environment-specific commands if you need to stop and remove test/staging/prod environment, more details can be found using help `make help`.



## Additional main command available

```bash

make build

make build-test

make build-staging

make build-prod



make start

make start-test

make start-staging

make start-prod



make stop

make stop-test

make stop-staging

make stop-prod



make down

make down-test

make down-staging

make down-prod



make restart

make restart-test

make restart-staging

make restart-prod



make env-staging

make env-prod



make ssh

make ssh-root

make fish

make ssh-supervisord

make ssh-mysql

make ssh-rabbitmq



make composer-install-no-dev

make composer-install

make composer-update



make info

make help



make logs

make logs-supervisord

make logs-mysql

make logs-rabbitmq



make drop-migrate

make migrate

make migrate-no-test



make fixtures



make messenger-setup-transports



make phpunit

make report-code-coverage



make phpcs

make ecs

make ecs-fix

make phpmetrics

make phpcpd

make phpmd

make phpstan

make phpinsights



etc....

```

Notes: Please see more commands in Makefile



## Architecture & packages

* [Symfony](https://symfony.com)

* [apache-pack](https://github.com/symfony/recipes-contrib/tree/master/symfony/apache-pack)

* [doctrine-migrations-bundle](https://github.com/doctrine/DoctrineMigrationsBundle)

* [doctrine-fixtures-bundle](https://github.com/doctrine/DoctrineFixturesBundle)

* [command-scheduler-bundle](https://packagist.org/packages/dukecity/command-scheduler-bundle)

* [phpunit](https://github.com/sebastianbergmann/phpunit)

* [phpunit-bridge](https://github.com/symfony/phpunit-bridge)

* [browser-kit](https://github.com/symfony/browser-kit)

* [css-selector](https://github.com/symfony/css-selector)

* [security-checker](https://github.com/fabpot/local-php-security-checker)

* [messenger](https://symfony.com/doc/current/messenger.html)

* [composer-bin-plugin](https://github.com/bamarni/composer-bin-plugin)

* [composer-normalize](https://github.com/ergebnis/composer-normalize)

* [composer-unused](https://packagist.org/packages/icanhazstring/composer-unused)

* [composer-require-checker](https://packagist.org/packages/maglnet/composer-require-checker)

* [requirements-checker](https://github.com/symfony/requirements-checker)

* [security-advisories](https://github.com/Roave/SecurityAdvisories)

* [php-coveralls](https://github.com/php-coveralls/php-coveralls)

* [easy-coding-standard](https://github.com/Symplify/EasyCodingStandard)

* [PhpMetrics](https://github.com/phpmetrics/PhpMetrics)

* [phpcpd](https://github.com/systemsdk/phpcpd)

* [phpmd](https://packagist.org/packages/phpmd/phpmd)

* [phpstan](https://packagist.org/packages/phpstan/phpstan)

* [phpinsights](https://packagist.org/packages/nunomaduro/phpinsights)

* [rector](https://packagist.org/packages/rector/rector)



## Guidelines

* [Commands](docs/commands.md)

* [Development](docs/development.md)

* [Testing](docs/testing.md)

* [IDE PhpStorm configuration](docs/phpstorm.md)

* [Xdebug configuration](docs/xdebug.md)

* [Messenger component](docs/messenger.md)



## Working on your project

1. For new feature development, fork `develop` branch into a new branch with one of the two patterns:

    * `feature/{ticketNo}`

2. Commit often, and write descriptive commit messages, so its easier to follow steps taken when reviewing.

3. Push this branch to the repo and create pull request into `develop` to get feedback, with the format `feature/{ticketNo}` - "Short descriptive title of Jira task".

4. Iterate as needed.

5. Make sure that "All checks have passed" on CircleCI(or another one in case you are not using CircleCI) and status is green.

6. When PR is approved, it will be squashed & merged, into `develop` and later merged into `release/{No}` for deployment.



Note: You can find git flow detail example [here](https://danielkummer.github.io/git-flow-cheatsheet).



## License

[The MIT License (MIT)](LICENSE)