You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 15, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ Download and install the latest release of [Docker Sync](http://docker-sync.io/)
85
85
86
86
## Quick start
87
87
88
-
Once you've downloaded this project, move to the root directory of this project and copy the file `.env.blueprint` and paste it to a file
88
+
Once you've downloaded this project, move to the root directory and copy the file `.env.blueprint` and paste it to a file
89
89
named `.env`.
90
90
91
91
| Linux/Mac | Windows |
@@ -110,6 +110,8 @@ Now open your hosts file...
110
110
127.0.0.1 rabbitmq.my-awesome-project.local
111
111
127.0.0.1 graylog.my-awesome-project.local
112
112
```
113
+
114
+
**Tip:** don't want to update your hosts file? Set `project.virtualhost.local` to `my-awesome-project.127.0.0.1.xip.io` in your `kickoff.yml` file. You're application will be available under https://www.my-awesome-project.127.0.0.1.xip.io/!
113
115
114
116
Good :smiley:? We're now done with the configuration! :metal:
115
117
@@ -126,8 +128,7 @@ and check if everything is OK!
126
128
127
129
## How does it works?
128
130
129
-
This project is mainly composed of templates (`*.blueprint.*`) which will be used to generate files thanks to [Orbit](https://github.com/gulien/orbit)
130
-
and values provided by `kickoff.yml` and `.env` configuration files.
131
+
This project is mainly composed of templates (`*.blueprint.*`) which will be used to generate the configuration files of your containers and Docker using values provided by `kickoff.yml` and `.env` configuration files.
131
132
132
133
### Project structure
133
134
@@ -145,6 +146,10 @@ and values provided by `kickoff.yml` and `.env` configuration files.
145
146
└── app # The source code of your PHP application
146
147
```
147
148
149
+
Only the configuration files and the application source code are directly mounted in the containers.
150
+
The data of others services (like MySQL) are mounted using named volumes. You can locate these volumes
151
+
on the host by utilizing the `docker inspect` command.
152
+
148
153
**Tip:** Your `app` folder should be a git submodule.
149
154
150
155
### Configuration files
@@ -177,7 +182,7 @@ with `yarn`.
177
182
178
183
It also generates useful files:
179
184
180
-
* The self-signed certificate on your local environment
185
+
* The self-signed certificate on your `local` environment
181
186
* The .htdigest file for authentication to the Traefik dashboard on environments <> `local`
182
187
* The SHA2 password and secret pepper for Graylog authentication
183
188
@@ -267,7 +272,7 @@ have to update it according to the PHP framework you wish to use.
267
272
268
273
Your PHP application will be accessible under https://my-awesome-project.local/ and https://www.my-awesome-project.local/.
269
274
270
-
**Note:**on `local` environment, you're also able to use Xdebug.
275
+
**Installed PHP extensions:**apcu, bcmath, gd, intl, mbstring, mcrypt, pdo_mysql, phpredis, opcache, xdebug (`local` environement only!) and zip
271
276
272
277
#### Configuration
273
278
@@ -289,7 +294,7 @@ automatically be connected as `root`
289
294
* By running `orbit run mysql-cli`: it will open the MySQL cli and connect you as `root` (on environments <> `local`, it will ask
290
295
you the MySQL root password)
291
296
* By mapping the container's port `3306` to a host port, you are able to use a more powerful tool like MySQL Workbench using
292
-
`127.0.0.1` as host and the port defined in the variable `MYSQL_HOST_PORT_TO_MAP` in your `.env` file
297
+
`127.0.0.1`(or your server IP) as host and the port defined in the variable `MYSQL_HOST_PORT_TO_MAP` in your `.env` file
0 commit comments