mathieu/start_sf5_project
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

adapt dev local env

Browse Source
This commit is contained in:
Tchama 2021-02-18 13:55:13 +01:00
parent beeeac2ac8
commit a628c110a9
9 changed files with 68 additions and 226 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
app
data

42
README.md
View File

@ -1,14 +1,14 @@
Docker environment for a Symfony4 project Docker environment for a Symfony5 project
================================== ==================================
# Add to your project # Add to your project
Move the `docker-compose.yml` and the folder named `phpdocker` containing nginx and php-fpm config for it to the root of your Symfony4 project. Move the `docker-compose.yml` and the folder named `docker_build` containing nginx and php-fpm config for it to the root of your Symfony project.
Ensure the webserver config on `docker\nginx.conf` is correct for your project. For instance, for Symfony4 it should look for the `public/index.php`, instead of the `web/app.php` from Symfony2 and Symfony3 Ensure the webserver config on `docker\nginx.conf` is correct for your project. For instance, for Symfony 4 or 5 it should look for the `public/index.php`, instead of the `web/app.php` from Symfony2 and Symfony3
Note: you may place the files elsewhere in your project. Make sure you modify the locations for the php-fpm dockerfile, the php.ini overrides and nginx config on `docker-compose.yml` if you do so. Note: you may place the files elsewhere in your project. Make sure you modify the locations for the php-fpm dockerfile, the php.ini overrides and nginx config on `docker-compose.yml` if you do so.
# How to run # How to run
Dependencies: Dependencies:
@ -28,9 +28,9 @@ Once you're done, simply `cd` to your project and run `docker-compose up -d`. Th
* Kill containers: `docker-compose kill` * Kill containers: `docker-compose kill`
* View container logs: `docker-compose logs` * View container logs: `docker-compose logs`
* Execute command inside of container: `docker-compose exec SERVICE_NAME COMMAND` where `COMMAND` is whatever you want to run. Examples: * Execute command inside of container: `docker-compose exec SERVICE_NAME COMMAND` where `COMMAND` is whatever you want to run. Examples:
* Shell into the PHP container, `docker-compose exec php-fpm bash` * Shell into the PHP container, `docker-compose exec php bash`
* Run symfony console, `docker-compose exec php-fpm bin/console` * Run symfony console, `docker-compose exec php bin/console`
* Open a mysql shell, `docker-compose exec mysql mysql -uroot -pCHOSEN_ROOT_PASSWORD` * Open a postgresql shell, `docker-compose exec db psql --user admin postgres`
# Docker general cheatsheet # Docker general cheatsheet
@ -41,6 +41,30 @@ Once you're done, simply `cd` to your project and run `docker-compose up -d`. Th
* To clear volumes: `docker volume rm $(docker volume ls -q)` * To clear volumes: `docker volume rm $(docker volume ls -q)`
* To clear networks: `docker network rm $(docker network ls | tail -n+2 | awk '{if($2 !~ /bridge|none|host/){ print $1 }}')` * To clear networks: `docker network rm $(docker network ls | tail -n+2 | awk '{if($2 !~ /bridge|none|host/){ print $1 }}')`
Disclaimer: This project has been generated on phpdocker.io Disclaimer: This project has been generated on phpdocker.io
# Installation
* `docker-compose up -d`
* in php container `docker-compose exec php bash`
* `composer create-project symfony/skeleton symfony`
* `mv symfony/* .`
* `mv symfony/.* .`
* `rm -Rf symfony`
* `composer require annotations`
* `composer require --dev profiler`
* `composer require twig`
* `composer require orm`
* `composer require form`
* `composer require form validator`
* `composer require maker-bundle`
* `docker-compose down`
* adapt querystring in `./app/.env`:
```
--- DATABASE_URL="postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=13&charset=utf8"
+++ DATABASE_URL="postgresql://admin:secret@db:5432/postgres?serverVersion=12&charset=utf8"
```
* `docker-compose up -d`
* in php container `docker-compose exec php bash`
* `bin/console doctrine:schema:create`

53
docker-compose.yml
View File

@ -1,38 +1,37 @@
############################################################################### version: "3.7"
# Generated on phpdocker.io #
###############################################################################
version: "3.1"
services: services:
mysql: db:
image: mysql:8.0 image: postgres:12
container_name: docker-symfony4-mysql container_name: docker-sf5-postgres
working_dir: /application
volumes: volumes:
- .:/application #- ./data:/var/lib/postgresql/data
- ./docker_build/db/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
environment: environment:
- MYSQL_ROOT_PASSWORD=dbrootpw - "POSTGRES_USER=admin"
- MYSQL_DATABASE=docker_symfony4 - "POSTGRES_PASSWORD=secret"
- MYSQL_USER=dbuser - "POSTGRES_DB=postgres"
- MYSQL_PASSWORD=dbpw
ports: ports:
- "8002:3306" - "5432:5432"
webserver: nginx:
image: nginx:alpine image: nginx:latest
container_name: docker-symfony4-webserver container_name: docker-sf5-nginx
working_dir: /application working_dir: /var/www/app
volumes: volumes:
- .:/application - ./app:/var/www/app
- ./phpdocker/nginx/nginx.conf:/etc/nginx/conf.d/default.conf - ./docker_build/nginx/nginx.conf:/etc/nginx/conf.d/default.conf
ports: ports:
- "8000:80" - "8000:80"
php-fpm: php: &php-fpm
build: phpdocker/php-fpm build:
container_name: docker-symfony4-php-fpm context: ./docker_build/php
working_dir: /application args:
UID: 1000
container_name: docker-sf5-php
image: php-fpm_sf5:latest
working_dir: /var/www/app
volumes: volumes:
- .:/application - ./app:/var/www/app
- ./phpdocker/php-fpm/php-ini-overrides.ini:/etc/php/7.2/fpm/conf.d/99-overrides.ini - ./docker_build/php/php-ini-overrides.ini:/etc/php/7.2/fpm/conf.d/99-overrides.ini

0
docker_build/db/docker-entrypoint-initdb.d/000_add_extensions.sql Normal file
View File

10
phpdocker/nginx/nginx.conf → docker_build/nginx/nginx.conf
View File

@ -3,10 +3,10 @@ server {
client_max_body_size 108M; client_max_body_size 108M;
access_log /var/log/nginx/application.access.log; access_log /var/log/nginx/app.access.log;
root /application/public; root /var/www/app/public;
index index.php; index index.php;
if (!-e $request_filename) { if (!-e $request_filename) {
@ -14,13 +14,13 @@ server {
} }
location ~ \.php$ { location ~ \.php$ {
fastcgi_pass php-fpm:9000; fastcgi_pass php:9000;
fastcgi_index index.php; fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param PHP_VALUE "error_log=/var/log/nginx/application_php_errors.log"; fastcgi_param PHP_VALUE "error_log=/var/log/nginx/app_php_errors.log";
fastcgi_buffers 16 16k; fastcgi_buffers 16 16k;
fastcgi_buffer_size 32k; fastcgi_buffer_size 32k;
include fastcgi_params; include fastcgi_params;
} }
} }

4
phpdocker/php-fpm/Dockerfile → docker_build/php/Dockerfile
View File

@ -1,5 +1,5 @@
FROM phpdockerio/php72-fpm:latest FROM phpdockerio/php72-fpm:latest
WORKDIR "/application" WORKDIR "/var/www/app"
# Install selected extensions and other stuff # Install selected extensions and other stuff
RUN apt-get update \ RUN apt-get update \
@ -9,4 +9,4 @@ RUN apt-get update \
# Install git # Install git
RUN apt-get update \ RUN apt-get update \
&& apt-get -y install git \ && apt-get -y install git \
&& apt-get clean; rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/* && apt-get clean; rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/*

0
phpdocker/php-fpm/php-ini-overrides.ini → docker_build/php/php-ini-overrides.ini
View File

125
phpdocker/README.html
View File

@ -1,125 +0,0 @@
<html>
<head>
<title>PHPDocker.io Readme</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.6.0/pure-min.css">
<style>
code {
background-color : #ddd;
padding : 2px 5px;
font-family : monospace;
font-size : 16px;
}
</style>
</head>
<body>
<div class="pure-g">
<div class="pure-u-1-24"></div>
<div class="pure-u-22-24">
<h1>PHPDocker.io generated environment</h1>
<h1>Add to your project</h1>
<p>Simply, unzip the file into your project, this will create <code>docker-compose.yml</code> on the root of your project and a folder named <code>phpdocker</code> containing nginx and php-fpm config for it.</p>
<p>Ensure the webserver config on <code>docker\nginx.conf</code> is correct for your project. PHPDocker.io will have customised this file according to the application type you chose on the generator, for instance <code>web/app|app_dev.php</code> on a Symfony project, or <code>public/index.php</code> on generic apps.</p>
<p>Note: you may place the files elsewhere in your project. Make sure you modify the locations for the php-fpm dockerfile, the php.ini overrides and nginx config on <code>docker-compose.yml</code> if you do so.</p>
<h1>How to run</h1>
<p>Dependencies:</p>
<ul>
<li>Docker engine v1.13 or higher. Your OS provided package might be a little old, if you encounter problems, do upgrade. See <a href="https://docs.docker.com/engine/installation">https://docs.docker.com/engine/installation</a></li>
<li>Docker compose v1.12 or higher. See <a href="https://docs.docker.com/compose/install/">docs.docker.com/compose/install</a></li>
</ul>
<p>Once you're done, simply <code>cd</code> to your project and run <code>docker-compose up -d</code>. This will initialise and start all the containers, then leave them running in the background.</p>
<h2>Services exposed outside your environment</h2>
<p>You can access your application via <strong><code>localhost</code></strong>, if you're running the containers directly, or through <strong>``</strong> when run on a vm. nginx and mailhog both respond to any hostname, in case you want to add your own hostname on your <code>/etc/hosts</code></p>
<table>
<thead>
<tr>
<th>Service</th>
<th>Address outside containers</th>
</tr>
</thead>
<tbody>
<tr>
<td>Webserver</td>
<td><a href="http://localhost:8000">localhost:8000</a></td>
</tr>
<tr>
<td>MySQL</td>
<td><strong>host:</strong> <code>localhost</code>; <strong>port:</strong> <code>8002</code></td>
</tr>
</tbody>
</table>
<h2>Hosts within your environment</h2>
<p>You'll need to configure your application to use any services you enabled:</p>
<table>
<thead>
<tr>
<th>Service</th>
<th>Hostname</th>
<th>Port number</th>
</tr>
</thead>
<tbody>
<tr>
<td>php-fpm</td>
<td>php-fpm</td>
<td>9000</td>
</tr>
<tr>
<td>MySQL</td>
<td>mysql</td>
<td>3306 (default)</td>
</tr>
</tbody>
</table>
<h1>Docker compose cheatsheet</h1>
<p><strong>Note:</strong> you need to cd first to where your docker-compose.yml file lives.</p>
<ul>
<li>Start containers in the background: <code>docker-compose up -d</code></li>
<li>Start containers on the foreground: <code>docker-compose up</code>. You will see a stream of logs for every container running.</li>
<li>Stop containers: <code>docker-compose stop</code></li>
<li>Kill containers: <code>docker-compose kill</code></li>
<li>View container logs: <code>docker-compose logs</code></li>
<li>Execute command inside of container: <code>docker-compose exec SERVICE_NAME COMMAND</code> where <code>COMMAND</code> is whatever you want to run. Examples:
* Shell into the PHP container, <code>docker-compose exec php-fpm bash</code>
* Run symfony console, <code>docker-compose exec php-fpm bin/console</code>
* Open a mysql shell, <code>docker-compose exec mysql mysql -uroot -pCHOSEN_ROOT_PASSWORD</code></li>
</ul>
<h1>Recommendations</h1>
<p>It's hard to avoid file permission issues when fiddling about with containers due to the fact that, from your OS point of view, any files created within the container are owned by the process that runs the docker engine (this is usually root). Different OS will also have different problems, for instance you can run stuff in containers using <code>docker exec -it -u $(id -u):$(id -g) CONTAINER_NAME COMMAND</code> to force your current user ID into the process, but this will only work if your host OS is Linux, not mac. Follow a couple of simple rules and save yourself a world of hurt.</p>
<ul>
<li>Run composer outside of the php container, as doing so would install all your dependencies owned by <code>root</code> within your vendor folder.</li>
<li>Run commands (ie Symfony's console, or Laravel's artisan) straight inside of your container. You can easily open a shell as described above and do your thing from there.</li>
</ul>
</div>
<div class="pure-u-1-24"></div>
</div>
<script>
var tables = document.getElementsByTagName('table');
for (var i = 0; i < tables.length; i++) {
tables[i].className = "pure-table";
}
</script>
</body>
</html>

58
phpdocker/README.md
View File

@ -1,58 +0,0 @@
PHPDocker.io generated environment
==================================
# Add to your project#
Simply, unzip the file into your project, this will create `docker-compose.yml` on the root of your project and a folder named `phpdocker` containing nginx and php-fpm config for it.
Ensure the webserver config on `docker\nginx.conf` is correct for your project. PHPDocker.io will have customised this file according to the application type you chose on the generator, for instance `web/app|app_dev.php` on a Symfony project, or `public/index.php` on generic apps.
Note: you may place the files elsewhere in your project. Make sure you modify the locations for the php-fpm dockerfile, the php.ini overrides and nginx config on `docker-compose.yml` if you do so.
# How to run
Dependencies:
* Docker engine v1.13 or higher. Your OS provided package might be a little old, if you encounter problems, do upgrade. See [https://docs.docker.com/engine/installation](https://docs.docker.com/engine/installation)
* Docker compose v1.12 or higher. See [docs.docker.com/compose/install](https://docs.docker.com/compose/install/)
Once you're done, simply `cd` to your project and run `docker-compose up -d`. This will initialise and start all the containers, then leave them running in the background.
## Services exposed outside your environment
You can access your application via **`localhost`**, if you're running the containers directly, or through **``** when run on a vm. nginx and mailhog both respond to any hostname, in case you want to add your own hostname on your `/etc/hosts`
Service | Address outside containers
------ | ---------
Webserver | [localhost:8000](http://localhost:8000)
MySQL | **host:** `localhost`; **port:** `8002`
## Hosts within your environment
You'll need to configure your application to use any services you enabled:
Service|Hostname|Port number
------|---------|-----------
php-fpm|php-fpm|9000
MySQL|mysql|3306 (default)
# Docker compose cheatsheet#
**Note:** you need to cd first to where your docker-compose.yml file lives.
* Start containers in the background: `docker-compose up -d`
* Start containers on the foreground: `docker-compose up`. You will see a stream of logs for every container running.
* Stop containers: `docker-compose stop`
* Kill containers: `docker-compose kill`
* View container logs: `docker-compose logs`
* Execute command inside of container: `docker-compose exec SERVICE_NAME COMMAND` where `COMMAND` is whatever you want to run. Examples:
* Shell into the PHP container, `docker-compose exec php-fpm bash`
* Run symfony console, `docker-compose exec php-fpm bin/console`
* Open a mysql shell, `docker-compose exec mysql mysql -uroot -pCHOSEN_ROOT_PASSWORD`
# Recommendations
It's hard to avoid file permission issues when fiddling about with containers due to the fact that, from your OS point of view, any files created within the container are owned by the process that runs the docker engine (this is usually root). Different OS will also have different problems, for instance you can run stuff in containers using `docker exec -it -u $(id -u):$(id -g) CONTAINER_NAME COMMAND` to force your current user ID into the process, but this will only work if your host OS is Linux, not mac. Follow a couple of simple rules and save yourself a world of hurt.
* Run composer outside of the php container, as doing so would install all your dependencies owned by `root` within your vendor folder.
* Run commands (ie Symfony's console, or Laravel's artisan) straight inside of your container. You can easily open a shell as described above and do your thing from there.