Skip to content

Commit 891a1d7

Browse files
committed
updated README.md
1 parent 357d69a commit 891a1d7

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

README.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,23 @@ A development docker for every symfony project
66
## Features
77

88
- Build for symfony4, symfony5 and has cli tools
9-
- Bundle of `fpm`, `cli`, `nginx`, `redis`, `mariadb` and `phpmyadmin` containers
9+
- Bundle of `fpm`, `cli`, `nginx`, `mariadb`, `phpmyadmin`, `mongodb`, `redis` and `emailcatcher` containers
1010
- Latest php7.4, php7.3, php7.2 and php7.1 supported
11+
- Latest database mariadb10, mongodb4 and other versions supported
1112
- Latest node14.x, node13.x, node12.x, ... supported
1213
- Included symfony, composer and node cli
14+
- Included emailcatcher with smtp and web view
1315
- Support for PhpStorm or VSCode + WSL2/docker-desktop setup
16+
- Support for xdebug included check `.env` file
17+
- For tinkers, php8.0-rc is available (check php8.0-rc/README.md)
1418

1519

1620
## Docker setup
1721

1822
- `git clone https://github.com/readymadehost/symfony-dev-docker.git project-docker`
1923
- `cd project-docker`
2024
- `mkdir project` or `git clone <some_git_repo_url> project` for existing project
21-
- Verify `.env` file
25+
- `cp .env.sample .env` and review `.env` file
2226
- `docker-compose build`
2327
- `docker-compose up -d`
2428
- `docker-compose exec cli bash`
@@ -37,27 +41,50 @@ A development docker for every symfony project
3741

3842
- Project URL: http://{localhost/any_valid_host}:8080/
3943
- PhpMyAdmin URL: http://{localhost/any_valid_host}:8180/
44+
- Mailcatcher URL: http://{localhost/any_valid_host}:8280/
4045
- For more info and change, check `.env` and `docker-compose.yml`
4146
- Manage permission inside container using bash alias `mpp` or `/root/manage-project-permission.sh`
42-
- Mariadb default:- host: `mariadb` user: `root`, password: `root`
47+
- Mariadb default:- host: `mariadb` user: `root`, password: `root`, database: `project`
48+
- Mongodb default:- host: `mongodb` user: `root`, password: `root`, database: `project`, authSource: `admin`
4349

4450
```text
4551
- <docker_root_dir> <-- docker root dir
4652
- <docker_root_dir>/data <-- all docker data persist
4753
- <docker_root_dir>/nginx <-- nginx
4854
- <docker_root_dir>/php* <-- php cli and fpm containers
55+
- <docker_root_dir>/.env <-- docker environment configuration
56+
4957
- <docker_root_dir>/project <-- project root dir
58+
5059
- <docker_root_dir>/project* <-- added in .gitignore
5160
- <docker_root_dir>/*.sql <-- added in .gitignore
5261
```
5362

5463

55-
## Phpstorm
64+
## Mailcatcher support
65+
66+
Mailcatcher service is included, can be accessed using URL and can be configured using smtp:-
67+
68+
```
69+
smtp://mailcatcher:1025
70+
```
71+
72+
73+
## Mongodb support
74+
75+
Mongodb service is disabled by default. Check `.env` and `docker-compose.yml` for more info. Mongodb can be connected using compass:-
76+
77+
```
78+
mongodb://root:root@localhost:27017/?authSource=admin
79+
```
80+
81+
82+
## Phpstorm setup
5683

57-
Simply add remote docker php cli interpreter, change path mapping and configure remote interpreter everywhere.
84+
Simply add remote docker-compose php cli interpreter (exec with docker-compose.yml), change path mapping and configure remote interpreter for composer, phpunit, phpcs, phpcbf, phpmd and php-cs-fixer.
5885

5986

60-
## Container + vscode
87+
## Remote container extension + vscode
6188

6289
With vscode's remote container extension, we can simply connect into cli container.
6390

@@ -68,4 +95,4 @@ With vscode's remote container extension, we can simply connect into cli contain
6895

6996
## For production usages
7097

71-
- Planning for ready made host. Coming soon...
98+
- Current docker setup is for development only. Planning for ReadyMadeHost coming soon...

0 commit comments

Comments
 (0)