Merge pull request #20 from laradock/master

Just update the fork
This commit is contained in:
Luciano Jr 2017-05-24 17:56:05 +01:00 committed by GitHub
commit bf691337f1
199 changed files with 12200 additions and 12969 deletions

View File

@ -9,4 +9,4 @@ charset = utf-8
[{Dockerfile,docker-compose.yml}] [{Dockerfile,docker-compose.yml}]
indent_style = space indent_style = space
indent_size = 4 indent_size = 2

1
.env
View File

@ -1 +0,0 @@
COMPOSE_CONVERT_WINDOWS_PATHS=1

26
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,26 @@
### Info:
- Docker version (`$ docker --version`):
- Laradock commit (`$ git rev-parse HEAD`):
- System info (Mac, PC, Linux):
- System info disto/version:
### Issue:
##### What seems to be going wrong?
_____
### Expected behavior:
##### What should be happening instead?
_____
### Reproduce:
##### How might we be able to reproduce the error?
_____
### Relevant Code:
```
// place code here
```

2
.gitignore vendored
View File

@ -1,3 +1,5 @@
.idea .idea
/logs /logs
/data /data
.env
/.project

59
.travis.yml Normal file
View File

@ -0,0 +1,59 @@
language: bash
sudo: required
services:
- docker
env:
matrix:
- PHP_VERSION=56 BUILD_SERVICE="applications blackfire minio percona nginx caddy apache2 mysql mariadb phpmyadmin postgres postgres-postgis pgadmin neo4j mongo redis"
- PHP_VERSION=70 BUILD_SERVICE="applications blackfire minio percona nginx caddy apache2 mysql mariadb phpmyadmin postgres postgres-postgis pgadmin neo4j mongo redis"
- PHP_VERSION=71 BUILD_SERVICE="applications blackfire minio percona nginx caddy apache2 mysql mariadb phpmyadmin postgres postgres-postgis pgadmin neo4j mongo redis"
- PHP_VERSION=56 BUILD_SERVICE=workspace
- PHP_VERSION=70 BUILD_SERVICE=workspace
- PHP_VERSION=71 BUILD_SERVICE=workspace
- PHP_VERSION=56 BUILD_SERVICE=php-fpm
- PHP_VERSION=70 BUILD_SERVICE=php-fpm
- PHP_VERSION=71 BUILD_SERVICE=php-fpm
- PHP_VERSION=56 BUILD_SERVICE="php-worker hhvm"
- PHP_VERSION=70 BUILD_SERVICE="php-worker hhvm"
- PHP_VERSION=71 BUILD_SERVICE="php-worker hhvm"
- PHP_VERSION=56 BUILD_SERVICE=mssql
- PHP_VERSION=70 BUILD_SERVICE=mssql
- PHP_VERSION=71 BUILD_SERVICE=mssql
- PHP_VERSION=56 BUILD_SERVICE=rethinkdb
- PHP_VERSION=70 BUILD_SERVICE=rethinkdb
- PHP_VERSION=71 BUILD_SERVICE=rethinkdb
- PHP_VERSION=56 BUILD_SERVICE=aerospike
- PHP_VERSION=70 BUILD_SERVICE=aerospike
- PHP_VERSION=71 BUILD_SERVICE=aerospike
- PHP_VERSION=56 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog selenium jenkins proxy proxy2 balancer"
- PHP_VERSION=70 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog selenium jenkins proxy proxy2 balancer"
- PHP_VERSION=71 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog selenium jenkins proxy proxy2 balancer"
- HUGO_VERSION=0.20.2
# Installing a newer Docker version
before_install:
- sudo apt-get update
- sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-engine
script: ./travis-build.sh
deploy:
provider: pages
skip_cleanup: true
local_dir: docs
github_token: $GITHUB_TOKEN
on:
branch: master
condition: -n "${HUGO_VERSION}"
notifications:
email: false

View File

@ -1,17 +1,18 @@
baseurl = "http://laradock.io/" baseurl = "http://laradock.io/"
languageCode = "en-us" languageCode = "en-us"
publishDir = "../" publishDir = "../docs"
title = "Laradock" title = "Laradock"
theme = "hugo-material-docs" theme = "hugo-material-docs"
metadataformat = "yaml" metadataformat = "yaml"
canonifyurls = true canonifyurls = true
uglyurls = true
# Enable Google Analytics by entering your tracking id # Enable Google Analytics by entering your tracking id
googleAnalytics = "UA-37514928-9" googleAnalytics = "UA-37514928-9"
[params] [params]
# General information # General information
author = "Mahmoud Zalt" author = "Mahmoud Zalt"
description = "Laradock documentations." description = "Full PHP development environment for Docker."
copyright = "" copyright = ""
# Repository # Repository
@ -19,7 +20,7 @@ googleAnalytics = "UA-37514928-9"
repo_url = "" repo_url = ""
version = "" version = ""
logo = "" logo = "images/logo.png"
favicon = "" favicon = ""
permalink = "#" permalink = "#"
@ -62,8 +63,8 @@ googleAnalytics = "UA-37514928-9"
weight = 3 weight = 3
[[menu.main]] [[menu.main]]
name = "Related Projects" name = "Guides"
url = "related-projects/" url = "guides/"
weight = 4 weight = 4
[[menu.main]] [[menu.main]]
@ -71,15 +72,20 @@ googleAnalytics = "UA-37514928-9"
url = "help/" url = "help/"
weight = 5 weight = 5
[[menu.main]]
name = "Related Projects"
url = "related-projects/"
weight = 6
[[menu.main]] [[menu.main]]
name = "Contributing" name = "Contributing"
url = "contributing/" url = "contributing/"
weight = 6 weight = 7
[[menu.main]] [[menu.main]]
name = "License" name = "License"
url = "license/" url = "license/"
weight = 7 weight = 8
# ------- MENU END ----------------------------------------- # ------- MENU END -----------------------------------------

View File

@ -0,0 +1,207 @@
---
title: Contributing
type: index
weight: 7
---
## Have a Question
If you have questions about how to use Laradock, please direct your questions to the discussion on [Gitter](https://gitter.im/Laradock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Question`) And you can still seek help on Gitter for it.
## Found an Issue
If have an issue or you found a typo in the documentation, you can help us by
opnening an [Issue](https://github.com/laradock/laradock/issues).
**Steps to do before opening an Issue:**
1. Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).
2. Decide if the Issue belongs to this project or to [Docker](https://github.com/docker) itself! or even the tool you are using such as Nginx or MongoDB...
If your issue appears to be a bug, and hasn't been reported, then open a new issue.
*This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.*
## Want a Feature
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Feature Suggestion`). If you would like to implement a new feature then consider submitting a Pull Request yourself.
## Update the Documentation (Site)
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
Go the `DOCUMENTATION/content` and search for the markdown file you want to edit
Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site.
To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/config.toml` toml file.
> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
### Host the documentation locally
1. Install [Hugo](https://gohugo.io/) on your machine.
2. Edit the `DOCUMENTATION/content`.
3. Delete the `/docs` folder from the root.
4. After you finish the editing, go to `DOCUMENTATION/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder).
## Support new Software (Add new Container)
* Forke the repo and clone the code.
* Create folder as the software name (example: `mysql` - `nginx`).
* Add your `Dockerfile` in the folder "you may add additional files as well".
* Add the software to the `docker-compose.yml` file.
* Make sure you follow the same code/comments style.
* Add the environment variables to the `env-example` if you have any.
* **MOST IMPORTANTLY** updated the `Documentation`, add as much information.
* Submit a Pull Request, to the `master` branch.
## Edit supported Software (Edit a Container)
* Forke the repo and clone the code.
* Open the software (container) folder (example: `mysql` - `nginx`).
* Edit the files.
* Make sure to update the `Documentation` in case you made any changes.
* Submit a Pull Request, to the `master` branch.
## Edit Base Image
* Open any dockerfile, copy the base image name (example: `FROM phusion/baseimage:latest`).
* Search for the image in the [Docker Hub](https://hub.docker.com/search/) and find the source..
*Most of the image in Laradock are offical images, these projects live in other repositories and maintainer by other orgnizations.*
**Note:** Laradock has two base images for (`Workspace` and `php-fpm`, mainly made to speed up the build time on your machine.
* Find the dockerfiles, edit them and submit a Pull Request.
* When updating a Laradock base image (`Workspace` or `php-fpm`), ask a project maintainer "Admin" to build a new image after your PR is merged.
**Note:** after the base image is updated, every dockerfile that uses that image, needs to update his base image tag to get the updated code.
<br>
## Submit Pull Request Instructions
### 1. Before Submitting a Pull Request (PR)
Always Test everything and make sure its working:
- Pull the latest updates (or fork of you dont have permission)
- Before editing anything:
- Test building the container (docker-compose build --no-cache container-name) build with no cache first.
- Test running the container with some other containers in real app and see of everything is working fine.
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
- Testing building the container (docker-compose build container-name) with no errors.
- Test it in a real App if possible.
### 2. Submitting a PR
Consider the following guidelines:
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate efforts.
* Make your changes in a new git branch:
```shell
git checkout -b my-fix-branch master
```
* Commit your changes using a descriptive commit message.
* Push your branch to GitHub:
```shell
git push origin my-fix-branch
```
* In GitHub, send a pull request to `laradock:master`.
* If we suggest changes then:
* Make the required updates.
* Commit your changes to your branch (e.g. `my-fix-branch`).
* Push the changes to your GitHub repository (this will update your Pull Request).
> If the PR gets too outdated we may ask you to rebase and force push to update the PR:
```shell
git rebase master -i
git push origin my-fix-branch -f
```
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.*
### 3. After your PR is merged
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete my-fix-branch
```
* Check out the master branch:
```shell
git checkout master -f
```
* Delete the local branch:
```shell
git branch -D my-fix-branch
```
* Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
<br>
#### Happy Coding :)

View File

@ -153,9 +153,28 @@ You might use the `--no-cache` option if you want full rebuilding (`docker-compo
<br>
<a name="Docker-Sync"></a>
## Docker-Sync
Docker on the Mac [is slow](https://github.com/docker/for-mac/issues/77), at the time of writing. Especially for larger projects, this can be a problem. The problem is [older than March 2016](https://forums.docker.com/t/file-access-in-mounted-volumes-extremely-slow-cpu-bound/8076) - as it's a such a long-running issue, we're including it in the docs here.
The problem originates in bind-mount performance on MacOS. Docker for Mac uses osxfs by default. This is not without reason, it has [a lot of advantages](https://docs.docker.com/docker-for-mac/osxfs/).
Solutions to resolve this issue are easily installed however, we're hoping it'll be fixed by Docker themselves over time. They are currently [adding "cached and delegated" options](https://github.com/docker/for-mac/issues/77#issuecomment-283996750), which is partly available for Docker Edge.
Options are [to switch over to NFS](https://github.com/IFSight/d4m-nfs) which is the simplest. The fastest option is [Docker-Sync "native"](https://github.com/EugenMayer/docker-sync) which is still quite easy to install.
Clone [this repo](https://github.com/EugenMayer/docker-sync-boilerplate) to your machine, copy `default/docker-sync.yml` to your Laradock directory and run `docker-sync-stack start`. Be sure to use `docker-sync-stack clean` to stop and `docker-compose build` to rebuild. More information can be found [in the Docker-sync docs](https://github.com/EugenMayer/docker-sync).
<br> <br>
<a name="Add-Docker-Images"></a> <a name="Add-Docker-Images"></a>
## Add more Software (Docker Images) ## Add more Software (Docker Images)
To add an image (software), just edit the `docker-compose.yml` and add your container details, to do so you need to be familiar with the [docker compose file syntax](https://docs.docker.com/compose/compose-file/). To add an image (software), just edit the `docker-compose.yml` and add your container details, to do so you need to be familiar with the [docker compose file syntax](https://docs.docker.com/compose/compose-file/).
@ -176,6 +195,11 @@ However to view the logs of all the other containers (MySQL, PHP-FPM,...) you ca
docker logs {container-name} docker logs {container-name}
``` ```
More [options](https://docs.docker.com/compose/reference/logs/)
```bash
docker logs -f {container-name}
```
@ -329,13 +353,13 @@ For information on how to configure xDebug with your IDE and work it out, check
By installing xDebug, you are enabling it to run on startup by default. By installing xDebug, you are enabling it to run on startup by default.
To control the behavior of xDebug (in the `php-fpm` Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose): To control the behavior of xDebug (in the `php-fpm` Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):
- Stop xDebug from running by default: `./xdebugPhpFpm stop`. - Stop xDebug from running by default: `.php-fpm/xdebug stop`.
- Start xDebug by default: `./xdebugPhpFpm start`. - Start xDebug by default: `.php-fpm/xdebug start`.
- See the status: `./xdebugPhpFpm status`. - See the status: `.php-fpm/xdebug status`.
Note: If `./xdebugPhpFpm` doesn't execute and gives `Permission Denied` error the problem can be that file `xdebugPhpFpm` doesn't have execution access. This can be fixed by running `chmod` command with desired access permissions. Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error the problem can be that file `xdebug` doesn't have execution access. This can be fixed by running `chmod` command with desired access permissions.
@ -381,10 +405,10 @@ It should be like this:
<br> <br>
<a name="LaraDock-for-Production"></a> <a name="Laradock-for-Production"></a>
## Prepare LaraDock for Production ## Prepare Laradock for Production
It's recommended for production to create a custom `docker-compose.yml` file. For that reason, LaraDock is shipped with `production-docker-compose.yml` which should contain only the containers you are planning to run on production (usage example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`). It's recommended for production to create a custom `docker-compose.yml` file. For that reason, Laradock is shipped with `production-docker-compose.yml` which should contain only the containers you are planning to run on production (usage example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines: Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:
@ -439,7 +463,7 @@ For more about the Laravel installation click [here](https://laravel.com/docs/ma
3 - Edit `docker-compose.yml` to Map the new application path: 3 - Edit `docker-compose.yml` to Map the new application path:
By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder. By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.
Since the new Laravel application is in the `my-cool-app` folder, we need to replace `../:/var/www` with `../my-cool-app/:/var/www`, as follow: Since the new Laravel application is in the `my-cool-app` folder, we need to replace `../:/var/www` with `../my-cool-app/:/var/www`, as follow:
@ -456,7 +480,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
cd my-cool-app cd my-cool-app
``` ```
5 - Go back to the LaraDock installation steps to see how to edit the `.env` file. 5 - Go back to the Laradock installation steps to see how to edit the `.env` file.
@ -581,7 +605,7 @@ composer require predis/predis:^1.0
5 - You can manually test it from Laravel with this code: 5 - You can manually test it from Laravel with this code:
```php ```php
\Cache::store('redis')->put('LaraDock', 'Awesome', 10); \Cache::store('redis')->put('Laradock', 'Awesome', 10);
``` ```
@ -694,6 +718,8 @@ docker-compose up -d mysql phpmyadmin
docker-compose up -d mariadb phpmyadmin docker-compose up -d mariadb phpmyadmin
``` ```
*Note: To use with MariaDB, open `.env` and set `PMA_DB_ENGINE=mysql` to `PMA_DB_ENGINE=mariadb`.*
2 - Open your browser and visit the localhost on port **8080**: `http://localhost:8080` 2 - Open your browser and visit the localhost on port **8080**: `http://localhost:8080`
@ -701,6 +727,24 @@ docker-compose up -d mariadb phpmyadmin
<br>
<a name="Use-Adminer"></a>
## Use Adminer
1 - Run the Adminer Container (`adminer`) with the `docker-compose up` command. Example:
```bash
docker-compose up -d adminer
```
2 - Open your browser and visit the localhost on port **8080**: `http://localhost:8080`
**Note:** We've locked Adminer to version 4.3.0 as at the time of writing [it contained a major bug](https://sourceforge.net/p/adminer/bugs-and-features/548/) preventing PostgreSQL users from logging in. If that bug is fixed (or if you're not using PostgreSQL) feel free to set Adminer to the latest version within [the Dockerfile](https://github.com/laradock/laradock/blob/master/adminer/Dockerfile#L1): `FROM adminer:latest`
<br> <br>
<a name="Use-pgAdmin"></a> <a name="Use-pgAdmin"></a>
## Use PgAdmin ## Use PgAdmin
@ -893,7 +937,7 @@ docker-compose up -d minio
<a name="Install-CodeIgniter"></a> <a name="Install-CodeIgniter"></a>
## Install CodeIgniter ## Install CodeIgniter
To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps: To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:
1 - Open the `docker-compose.yml` file. 1 - Open the `docker-compose.yml` file.
@ -1198,7 +1242,7 @@ It should be like this:
<a name="Common-Aliases"></a> <a name="Common-Aliases"></a>
<br> <br>
## Common Terminal Aliases ## Common Terminal Aliases
When you start your docker container, LaraDock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file. When you start your docker container, Laradock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file.
You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements. You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements.
@ -1214,11 +1258,11 @@ You are free to modify the `aliases.sh` as you see fit, adding your own aliases
<br> <br>
a) open the `docker-compose.yml` file a) open the `docker-compose.yml` file
<br> <br>
b) search for the `INSTALL_AEROSPIKE_EXTENSION` argument under the Workspace Container b) search for the `INSTALL_AEROSPIKE` argument under the Workspace Container
<br> <br>
c) set it to `true` c) set it to `true`
<br> <br>
d) search for the `INSTALL_AEROSPIKE_EXTENSION` argument under the PHP-FPM Container d) search for the `INSTALL_AEROSPIKE` argument under the PHP-FPM Container
<br> <br>
e) set it to `true` e) set it to `true`
@ -1229,13 +1273,13 @@ It should be like this:
build: build:
context: ./workspace context: ./workspace
args: args:
- INSTALL_AEROSPIKE_EXTENSION=true - INSTALL_AEROSPIKE=true
... ...
php-fpm: php-fpm:
build: build:
context: ./php-fpm context: ./php-fpm
args: args:
- INSTALL_AEROSPIKE_EXTENSION=true - INSTALL_AEROSPIKE=true
... ...
``` ```
@ -1292,10 +1336,10 @@ Remote debug Laravel web and phpunit tests.
<br> <br>
<a name="keep-tracking-LaraDock"></a> <a name="keep-tracking-Laradock"></a>
## Keep track of your LaraDock changes ## Keep track of your Laradock changes
1. Fork the LaraDock repository. 1. Fork the Laradock repository.
2. Use that fork as a submodule. 2. Use that fork as a submodule.
3. Commit all your changes to your fork. 3. Commit all your changes to your fork.
4. Pull new stuff from the main repository from time to time. 4. Pull new stuff from the main repository from time to time.
@ -1308,14 +1352,14 @@ Remote debug Laravel web and phpunit tests.
<br> <br>
<a name="upgrading-laradock"></a> <a name="upgrading-laradock"></a>
## Upgrading LaraDock ## Upgrading Laradock
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*: Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:
1. Stop the docker VM `docker-machine stop {default}` 1. Stop the docker VM `docker-machine stop {default}`
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/). 2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
3. Upgrade LaraDock to `v4.*.*` (`git pull origin master`) 3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`. 4. Use Laradock as you used to do: `docker-compose up -d nginx mysql`.
**Note:** If you face any problem with the last step above: rebuild all your containers **Note:** If you face any problem with the last step above: rebuild all your containers
`docker-compose build --no-cache` `docker-compose build --no-cache`
@ -1327,15 +1371,36 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ
<br> <br>
<a name="Speed-MacOS"></a> <a name="Speed-MacOS"></a>
## Improve speed on MacOS ## Improve speed on MacOS
Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container. Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:
> How to share files using NFS (d4m-nfs) ### Workaround A: using dinghy
[d4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one. [Dinghy](https://github.com/codekitchen/dinghy) creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.
Quick Setup giude, (we recommend you check their docs)
1) `brew tap codekitchen/dinghy`
2) `brew install dinghy`
3) `dinghy create --provider virtualbox` (must have virtualbox installed, but they support other providers if you prefer)
4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)
5) `docker-compose up ...`
### Workaround B: using d4m-nfs
[D4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one.
1) Update the Docker [File Sharing] preferences: 1) Update the Docker [File Sharing] preferences:
@ -1353,14 +1418,12 @@ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
```txt ```txt
/Users:/Users /Users:/Users
/Volumes:/Volumes
/private:/private
``` ```
5) Create (or edit) the file `/etc/exports`, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the `d4m-nfs.sh` script before). 5) Create (or edit) the file `/etc/exports`, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the `d4m-nfs.sh` script before).
6) Run the `d4m-nfs.sh` script: 6) Run the `d4m-nfs.sh` script (might need Sudo):
```bash ```bash
~/d4m-nfs/d4m-nfs.sh ~/d4m-nfs/d4m-nfs.sh
@ -1369,10 +1432,26 @@ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
That's it! Run your containers.. Example: That's it! Run your containers.. Example:
```bash ```bash
docker-compose up -d nginx mysql docker-compose up ...
``` ```
**Note:** If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear. *Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear.*
### Other good workarounds:
- [docker-sync](https://github.com/EugenMayer/docker-sync)
- Add more here..
More details about this issue [here](https://github.com/docker/for-mac/issues/77).
@ -1454,4 +1533,4 @@ This error sometimes happens because your Laravel application isn't running on t
1. Check your running Laravel application IP by dumping `Request::ip()` variable using `dd(Request::ip())` anywhere on your application. The result is the IP of your Laravel container. 1. Check your running Laravel application IP by dumping `Request::ip()` variable using `dd(Request::ip())` anywhere on your application. The result is the IP of your Laravel container.
2. Change the `DB_HOST` variable on env with the IP that you received from previous step. 2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
* Option B * Option B
1. Change the `DB_HOST` value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as `mysql` 1. Change the `DB_HOST` value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as `mysql`

View File

@ -0,0 +1,214 @@
---
title: Getting Started
type: index
weight: 2
---
## Requirements
- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/) `>= 1.12`
## Installation
Choose the setup the best suits your needs.
- [A) Setup for Single Project](#A)
- [A.1) Already have a PHP project](#A1)
- [A.2) Don't have a PHP project yet](#A2)
- [B) Setup for Multiple Projects](#B)
<a name="A"></a>
### A) Setup for Single Project
> (Follow these steps if you want a separate Docker environment for each project)
<a name="A1"></a>
### A.1) Already have a PHP project:
1 - Clone laradock on your project root directory:
```bash
git submodule add https://github.com/Laradock/laradock.git
```
Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `.
*To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)*
Your folder structure should look like this:
```
+ project-a
+ laradock-a
+ project-b
+ laradock-b
```
*(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).*
> **Now jump to the [Usage](#Usage) section.**
<a name="A2"></a>
### A.2) Don't have a PHP project yet:
1 - Clone this repository anywhere on your machine:
```bash
git clone https://github.com/laradock/laradock.git
```
Your folder structure should look like this:
```
+ laradock
+ project-z
```
2 - Edit your web server sites configuration.
We'll need to do step 1 of the [Usage](#Usage) section now to make this happen.
```
cp env-example .env
```
At the top, change the `APPLICATION` variable to your project path.
```
APPLICATION=../project-z/
```
Make sure to replace `project-z` with your project folder name.
> **Now jump to the [Usage](#Usage) section.**
<a name="B"></a>
### B) Setup for Multiple Projects:
> (Follow these steps if you want a single Docker environment for all your project)
1 - Clone this repository anywhere on your machine (similar to [Steps A.2. from above](#A2)):
```bash
git clone https://github.com/laradock/laradock.git
```
Your folder structure should look like this:
```
+ laradock
+ project-1
+ project-2
```
2 - Go to `nginx/sites` and create config files to point to different project directory when visiting different domains.
Laradock by default includes `project-1.conf` and `project-2.conf` as working samples.
3 - change the default names `project-n`:
You can rename the config files, project folders and domains as you like, just make sure the `root` in the config files, is pointing to the correct project folder name.
4 - Add the domains to the **hosts** files.
```
127.0.0.1 project-1.dev
127.0.0.1 project-2.dev
```
> **Now jump to the [Usage](#Usage) section.**
<a name="Usage"></a>
## Usage
**Read Before starting:**
If you are using **Docker Toolbox** (VM), do one of the following:
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/documentation/#upgrading-laradock)
- Use Laradock v3.\*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. *(outdated)*
<br>
We recommend using a Docker version which is newer than 1.13.
<br>
>**Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent as much errors as possible.
<br>
1 - Enter the laradock folder and copy `env-example` to `.env`
```shell
cp env-example .env
```
You can edit the `.env` file to chose which software's you want to be installed in your environment. You can always refer to the `docker-compose.yml` file to see how those variables are been used.
2 - Build the enviroment and run it using `docker-compose`
In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:
```bash
docker-compose up -d nginx mysql
```
**Note**: The `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command. If you couldn't find them running then you need specify them as follow: `docker-compose up -d nginx php-fpm mysql workspace`.
You can select your own combination of containers form [this list](http://laradock.io/introduction/#supported-software-images).
*(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers).*
<br>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...)
```bash
docker-compose exec workspace bash
```
*Alternatively, for Windows PowerShell users: execute the following command to enter any running container:*
```bash
docker exec -it {workspace-container-id} bash
```
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
```shell
docker-compose exec --user=laradock workspace bash
```
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
<br>
4 - Update your project configurations to use the database host
Open your PHP project's `.env` file or whichever configuration file you are reading from, and set the database host `DB_HOST` to `mysql`:
```env
DB_HOST=mysql
```
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
<br>
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`.

View File

@ -0,0 +1,550 @@
---
title: Guides
type: index
weight: 4
---
* [Production Setup on Digital Ocean](#Digital-Ocean)
* [PHPStorm XDebug Setup](#PHPStorm-Debugging)
<a name="Digital-Ocean"></a>
# Production Setup on Digital Ocean
## Install Docker
- Visit [DigitalOcean](https://cloud.digitalocean.com/login) and login.
- Click the `Create Droplet` button.
- Open the `One-click apps` tab.
- Select Docker with your preferred version.
- Continue creating the droplet as you normally would.
- If needed, check your e-mail for the droplet root password.
## SSH to your Server
Find the IP address of the droplet in the DigitalOcean interface. Use it to connect to the server.
```
ssh root@ipaddress
```
You may be prompted for a password. Type the one you found within your e-mailbox. It'll then ask you to change the password.
You can now check if Docker is available:
```
$root@server:~# docker
```
## Set Up Your Laravel Project
```
$root@server:~# apt-get install git
$root@server:~# git clone https://github.com/laravel/laravel
$root@server:~# cd laravel
$root@server:~/laravel/ git submodule add https://github.com/Laradock/laradock.git
$root@server:~/laravel/ cd laradock
```
## Install docker-compose command
```
$root@server:~/laravel/laradock# curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$root@server:~/chmod +x /usr/local/bin/docker-compose
```
## Enter the laradock folder and rename env-example to .env.
```
$root@server:~/laravel/laradock# cp env-example .env
```
## Create Your Laradock Containers
```
$root@server:~/laravel/laradock# docker-compose up -d nginx mysql
```
Note that more containers are available, find them in the [docs](http://laradock.io/introduction/#supported-software-containers) or the `docker-compose.yml` file.
## Go to Your Workspace
```
docker-compose exec workspace bash
```
## Install and configure Laravel
Let's install Laravel's dependencies, add the `.env` file, generate the key and give proper permissions to the cache folder.
```
$ root@workspace:/var/www# composer install
$ root@workspace:/var/www# cp .env.example .env
$ root@workspace:/var/www# php artisan key:generate
$ root@workspace:/var/www# exit
$root@server:~/laravel/laradock# cd ..
$root@server:~/laravel# sudo chmod -R 777 storage bootstrap/cache
```
You can then view your Laravel site by visiting the IP address of your server in your browser. For example:
```
http://192.168.1.1
```
It should show you the Laravel default welcome page.
However, we want it to show up using your custom domain name, as well.
## Using Your Own Domain Name
Login to your DNS provider, such as Godaddy, Namecheap.
Point the Custom Domain Name Server to:
```
ns1.digitalocean.com
ns2.digitalocean.com
ns3.digitalocean.com
```
Within DigitalOcean, you'll need to change some settings, too.
Visit: https://cloud.digitalocean.com/networking/domains
Add your domain name and choose the server IP you'd provision earlier.
## Serving Site With NGINX (HTTP ONLY)
Go back to command line.
```
$root@server:~/laravel/laradock# cd nginx
$root@server:~/laravel/laradock/nginx# vim laravel.conf
```
Remove `default_server`
```
listen 80 default_server;
listen [::]:80 default_server ipv6only=on;
```
And add `server_name` (your custom domain)
```
listen 80;
listen [::]:80 ipv6only=on;
server_name yourdomain.com;
```
## Rebuild Your Nginx
```
$root@server:~/laravel/laradock# docker-compose down
$root@server:~/laravel/laradock# docker-compose build nginx
```
## Re Run Your Containers MYSQL and NGINX
```
$root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
```
**View Your Site with HTTP ONLY (http://yourdomain.com)**
## Run Site on SSL with Let's Encrypt Certificate
**Note: You need to Use Caddy here Instead of Nginx**
To go Caddy Folders and Edit CaddyFile
```
$root@server:~/laravel/laradock# cd caddy
$root@server:~/laravel/laradock/caddy# vim Caddyfile
```
Remove 0.0.0.0:80
```
0.0.0.0:80
root /var/www/public
```
and replace with your https://yourdomain.com
```
https://yourdomain.com
root /var/www/public
```
uncomment tls
```
#tls self-signed
```
and replace self-signed with your email address
```
tls serverbreaker@gmai.com
```
This is needed Prior to Creating Let's Encypt
## Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
```
$root@server:~/laravel/laradock/caddy# docker-compose up caddy
```
You'll be prompt here to enter your email... you may enter it or not
```
Attaching to laradock_mysql_1, laradock_caddy_1
caddy_1 | Activating privacy features...
caddy_1 | Your sites will be served over HTTPS automatically using Let's Encrypt.
caddy_1 | By continuing, you agree to the Let's Encrypt Subscriber Agreement at:
caddy_1 | https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf
caddy_1 | Activating privacy features... done.
caddy_1 | https://yourdomain.com
caddy_1 | http://yourdomain.com
```
After it finishes, press `Ctrl` + `C` to exit.
## Stop All Containers and ReRun Caddy and Other Containers on Background
```
$root@server:~/laravel/laradock/caddy# docker-compose down
$root@server:~/laravel/laradock/caddy# docker-compose up -d mysql caddy
```
View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)
**Note that Certificate will be Automatically Renew By Caddy**
>References:
>
- [https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04)
- [https://www.digitalocean.com/products/one-click-apps/docker/](https://www.digitalocean.com/products/one-click-apps/docker/)
- [https://docs.docker.com/engine/installation/linux/ubuntulinux/](https://docs.docker.com/engine/installation/linux/ubuntulinux/)
- [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
- [https://caddyserver.com/docs/automatic-https](https://caddyserver.com/docs/automatic-https)
- [https://caddyserver.com/docs/tls](https://caddyserver.com/docs/tls)
- [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)
<br>
<br>
<br>
<br>
<br>
<a name="PHPStorm-Debugging"></a>
# PHPStorm XDebug Setup
- [Intro](#Intro)
- [Installation](#Installation)
- [Customize laradock/docker-compose.yml](#CustomizeDockerCompose)
- [Clean House](#InstallCleanHouse)
- [Laradock Dial Tone](#InstallLaradockDialTone)
- [hosts](#AddToHosts)
- [Firewall](#FireWall)
- [Enable xDebug on php-fpm](#enablePhpXdebug)
- [PHPStorm Settings](#InstallPHPStorm)
- [Configs](#InstallPHPStormConfigs)
- [Usage](#Usage)
- [Laravel](#UsageLaravel)
- [Run ExampleTest](#UsagePHPStormRunExampleTest)
- [Debug ExampleTest](#UsagePHPStormDebugExampleTest)
- [Debug Web Site](#UsagePHPStormDebugSite)
- [SSH into workspace](#SSHintoWorkspace)
- [KiTTY](#InstallKiTTY)
<a name="Intro"></a>
## Intro
Wiring up [Laravel](https://laravel.com/), [Laradock](https://github.com/Laradock/laradock) [Laravel+Docker] and [PHPStorm](https://www.jetbrains.com/phpstorm/) to play nice together complete with remote xdebug'ing as icing on top! Although this guide is based on `PHPStorm Windows`,
you should be able to adjust accordingly. This guide was written based on Docker for Windows Native.
<a name="Installation"></a>
## Installation
- This guide assumes the following:
- you have already installed and are familiar with Laravel, Laradock and PHPStorm.
- you have installed Laravel as a parent of `laradock`. This guide assumes `/c/_dk/laravel`.
<a name="AddToHosts"></a>
## hosts
- Add `laravel` to your hosts file located on Windows 10 at `C:\Windows\System32\drivers\etc\hosts`. It should be set to the IP of your running container. Mine is: `10.0.75.2`
On Windows you can find it by opening Windows `Hyper-V Manager`.
- ![Windows Hyper-V Manager](images/photos/PHPStorm/Settings/WindowsHyperVManager.png)
- [Hosts File Editor](https://github.com/scottlerch/HostsFileEditor) makes it easy to change your hosts file.
- Set `laravel` to your docker host IP. See [Example](images/photos/SimpleHostsEditor/AddHost_laravel.png).
<a name="FireWall"></a>
## Firewall
Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.
- It is important to note that if the Application PHPStorm is NOT enabled in the firewall, you will not be able to recreate a rule to override that.
- Also be aware that if you are installing/upgrade different versions of PHPStorm, you MAY have orphaned references to PHPStorm in your Firewall! You may decide to remove orphaned references however in either case, make sure that they are set to receive public TCP traffic.
### Edit laradock/docker-compose.yml
Set the following variables:
```
### Workspace Utilities Container ###############
workspace:
build:
context: ./workspace
args:
- INSTALL_XDEBUG=true
- INSTALL_WORKSPACE_SSH=true
...
### PHP-FPM Container #####################
php-fpm:
build:
context: ./php-fpm
args:
- INSTALL_XDEBUG=true
...
```
### Edit xdebug.ini files
- `laradock/workspace/xdebug.ini`
- `laradock/php-fpm/xdebug.ini`
Set the following variables:
```
xdebug.remote_autostart=1
xdebug.remote_enable=1
xdebug.remote_connect_back=1
xdebug.cli_color=1
```
<a name="InstallCleanHouse"></a>
### Need to clean house first?
Make sure you are starting with a clean state. For example, do you have other Laradock containers and images?
Here are a few things I use to clean things up.
- Delete all containers using `grep laradock_` on the names, see: [Remove all containers based on docker image name](https://linuxconfig.org/remove-all-containners-based-on-docker-image-name).
`docker ps -a | awk '{ print $1,$2 }' | grep laradock_ | awk '{print $1}' | xargs -I {} docker rm {}`
- Delete all images containing `laradock`.
`docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}`
**Note:** This will only delete images that were built with `Laradock`, **NOT** `laradock/*` which are pulled down by `Laradock` such as `laradock/workspace`, etc.
**Note:** Some may fail with:
`Error response from daemon: conflict: unable to delete 3f38eaed93df (cannot be forced) - image has dependent child images`
- I added this to my `.bashrc` to remove orphaned images.
```
dclean() {
processes=`docker ps -q -f status=exited`
if [ -n "$processes" ]; thend
docker rm $processes
fi
images=`docker images -q -f dangling=true`
if [ -n "$images" ]; then
docker rmi $images
fi
}
```
- If you frequently switch configurations for Laradock, you may find that adding the following and added to your `.bashrc` or equivalent useful:
```
# remove laravel* containers
# remove laravel_* images
dcleanlaradockfunction()
{
echo 'Removing ALL containers associated with laradock'
docker ps -a | awk '{ print $1,$2 }' | grep laradock | awk '{print $1}' | xargs -I {} docker rm {}
# remove ALL images associated with laradock_
# does NOT delete laradock/* which are hub images
echo 'Removing ALL images associated with laradock_'
docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}
echo 'Listing all laradock docker hub images...'
docker images | grep laradock
echo 'dcleanlaradock completed'
}
# associate the above function with an alias
# so can recall/lookup by typing 'alias'
alias dcleanlaradock=dcleanlaradockfunction
```
<a name="InstallLaradockDialTone"></a>
## Let's get a dial-tone with Laravel
```
# barebones at this point
docker-compose up -d nginx mysql
# run
docker-compose ps
# Should see:
Name Command State Ports
-----------------------------------------------------------------------------------------------------------
laradock_mysql_1 docker-entrypoint.sh mysqld Up 0.0.0.0:3306->3306/tcp
laradock_nginx_1 nginx Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp
laradock_php-fpm_1 php-fpm Up 9000/tcp
laradock_volumes_data_1 true Exit 0
laradock_volumes_source_1 true Exit 0
laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222->22/tcp
```
<a name="enablePhpXdebug"></a>
## Enable xDebug on php-fpm
In a host terminal sitting in the laradock folder, run: `.php-fpm/xdebug status`
You should see something like the following:
```
xDebug status
laradock_php-fpm_1
PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS )
Copyright (c) 1997-2016 The PHP Group
Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies
with Xdebug v2.4.1, Copyright (c) 2002-2016, by Derick Rethans
```
Other commands include `.php-fpm/xdebug start | stop`.
If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will already be running when
`php-fpm` is started and listening for debug info on port 9000.
<a name="InstallPHPStormConfigs"></a>
## PHPStorm Settings
- Here are some settings that are known to work:
- `Settings/BuildDeploymentConnection`
- ![Settings/BuildDeploymentConnection](/images/photos/PHPStorm/Settings/BuildDeploymentConnection.png)
- `Settings/BuildDeploymentConnectionMappings`
- ![Settings/BuildDeploymentConnectionMappings](/images/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png)
- `Settings/BuildDeploymentDebugger`
- ![Settings/BuildDeploymentDebugger](/images/photos/PHPStorm/Settings/BuildDeploymentDebugger.png)
- `Settings/EditRunConfigurationRemoteWebDebug`
- ![Settings/EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png)
- `Settings/EditRunConfigurationRemoteExampleTestDebug`
- ![Settings/EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png)
- `Settings/LangsPHPDebug`
- ![Settings/LangsPHPDebug](/images/photos/PHPStorm/Settings/LangsPHPDebug.png)
- `Settings/LangsPHPInterpreters`
- ![Settings/LangsPHPInterpreters](/images/photos/PHPStorm/Settings/LangsPHPInterpreters.png)
- `Settings/LangsPHPPHPUnit`
- ![Settings/LangsPHPPHPUnit](/images/photos/PHPStorm/Settings/LangsPHPPHPUnit.png)
- `Settings/LangsPHPServers`
- ![Settings/LangsPHPServers](/images/photos/PHPStorm/Settings/LangsPHPServers.png)
- `RemoteHost`
To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`.
- ![RemoteHost](/images/photos/PHPStorm/RemoteHost.png)
- `RemoteWebDebug`
- ![DebugRemoteOn](/images/photos/PHPStorm/DebugRemoteOn.png)
- `EditRunConfigurationRemoteWebDebug`
Go to: `Menu/Run/Edit Configurations`.
- ![EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png)
- `EditRunConfigurationRemoteExampleTestDebug`
Go to: `Menu/Run/Edit Configurations`.
- ![EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png)
- `WindowsFirewallAllowedApps`
Go to: `Control Panel\All Control Panel Items\Windows Firewall\Allowed apps`.
- ![WindowsFirewallAllowedApps.png](/images/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png)
- `hosts`
Edit: `C:\Windows\System32\drivers\etc\hosts`.
- ![WindowsFirewallAllowedApps.png](/images/photos/PHPStorm/Settings/hosts.png)
- [Enable xDebug on php-fpm](#enablePhpXdebug)
<a name="Usage"></a>
## Usage
<a name="UsagePHPStormRunExampleTest"></a>
### Run ExampleTest
- right-click on `tests/ExampleTest.php`
- Select: `Run 'ExampleTest.php'` or `Ctrl+Shift+F10`.
- Should pass!! You just ran a remote test via SSH!
<a name="UsagePHPStormDebugExampleTest"></a>
### Debug ExampleTest
- Open to edit: `tests/ExampleTest.php`
- Add a BreakPoint on line 16: `$this->visit('/')`
- right-click on `tests/ExampleTest.php`
- Select: `Debug 'ExampleTest.php'`.
- Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
- ![Remote Test Debugging Success](/images/photos/PHPStorm/RemoteTestDebuggingSuccess.png)
<a name="UsagePHPStormDebugSite"></a>
### Debug WebSite
- In case xDebug is disabled, from the `laradock` folder run:
`.php-fpm/xdebug start`.
- To switch xdebug off, run:
`.php-fpm/xdebug stop`
- Start Remote Debugging
- ![DebugRemoteOn](/images/photos/PHPStorm/DebugRemoteOn.png)
- Open to edit: `bootstrap/app.php`
- Add a BreakPoint on line 14: `$app = new Illuminate\Foundation\Application(`
- Reload [Laravel Site](http://laravel/)
- Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
- ![Remote Debugging Success](/images/photos/PHPStorm/RemoteDebuggingSuccess.png)
<a name="SSHintoWorkspace"></a>
## Let's shell into workspace
Assuming that you are in laradock folder, type:
`ssh -i workspace/insecure_id_rsa -p2222 root@laravel`
**Cha Ching!!!!**
- `workspace/insecure_id_rsa.ppk` may become corrupted. In which case:
- fire up `puttygen`
- import `workspace/insecure_id_rsa`
- save private key to `workspace/insecure_id_rsa.ppk`
<a name="InstallKiTTY"></a>
### KiTTY
[Kitty](http://www.9bis.net/kitty/) KiTTY is a fork from version 0.67 of PuTTY.
- Here are some settings that are working for me:
- ![Session](/images/photos/KiTTY/Session.png)
- ![Terminal](/images/photos/KiTTY/Terminal.png)
- ![Window](/images/photos/KiTTY/Window.png)
- ![WindowAppearance](/images/photos/KiTTY/WindowAppearance.png)
- ![Connection](/images/photos/KiTTY/Connection.png)
- ![ConnectionData](/images/photos/KiTTY/ConnectionData.png)
- ![ConnectionSSH](/images/photos/KiTTY/ConnectionSSH.png)
- ![ConnectionSSHAuth](/images/photos/KiTTY/ConnectionSSHAuth.png)
- ![TerminalShell](/images/photos/KiTTY/TerminalShell.png)

View File

@ -4,6 +4,6 @@ type: index
weight: 5 weight: 5
--- ---
Join the chat room on [Gitter](https://gitter.im/LaraDock/laradock) and get help and support from the community. Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community.
You can as well can open an [issue](https://github.com/laradock/laradock/issues) on Github (will be labeled as Question) and discuss it with people on [Gitter](https://gitter.im/LaraDock/laradock). You can as well can open an [issue](https://github.com/laradock/laradock/issues) on Github (will be labeled as Question) and discuss it with people on [Gitter](https://gitter.im/Laradock/laradock).

View File

@ -0,0 +1,168 @@
---
title: Introduction
type: index
weight: 1
---
A full PHP development environment for Docker.
Includes pre-packaged Docker Images, all pre-configured to provide a wonderful PHP development environment.
Laradock is well known in the Laravel community, as the project started with single focus on running Laravel projects on Docker. Later and due to the large adoption from the PHP community, it started supporting other PHP projects like Symfony, CodeIgniter, WordPress, Drupal...
![](https://s19.postimg.org/jblfytw9f/laradock-logo.jpg)
## Quick Overview
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `Beanstalkd`:
1 - Clone Laradock inside your PHP project:
```shell
git clone https://github.com/Laradock/laradock.git
```
2 - Enter the laradock folder and rename `env-example` to `.env`.
```shell
cp env-example .env
```
3 - Run your containers:
```shell
docker-compose up -d nginx mysql redis beanstalkd
```
4 - Open your project's `.env` file and set the following:
```shell
DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd
```
5 - Open your browser and visit localhost: `http://localhost`.
```shell
That's it! enjoy :)
```
<a name="features"></a>
## Features
- Easy switch between PHP versions: 7.1, 7.0, 5.6...
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
- Run your own combination of software: Memcached, HHVM, Beanstalkd...
- Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI...
- Easy to customize any container, with simple edit to the `Dockerfile`.
- All Images extends from an official base Image. (Trusted base Images).
- Pre-configured NGINX to host any code at your root directory.
- Can use Laradock per project, or single Laradock for all projects.
- Easy to install/remove software's in Containers using environment variables.
- Clean and well structured Dockerfiles (`Dockerfile`).
- Latest version of the Docker Compose file (`docker-compose`).
- Everything is visible and editable.
- Fast Images Builds.
- More to come every week..
<a name="Supported-Containers"></a>
## Supported Software (Images)
In adhering to the separation of concerns principle as promoted by Docker, Laradock runs each software on its own Container.
You can turn On/Off as many instances of as any container without worrying about the configurations, everything works like a charm.
- **Database Engines:**
MySQL - MariaDB - Percona - MongoDB - Neo4j - RethinkDB - MSSQL - PostgreSQL - Postgres Postgis.
- **Cache Engines:**
Redis - Memcached - Aerospike
- **PHP Servers:**
NGINX - Apache2 - Caddy
- **PHP Compilers:**
PHP FPM - HHVM
- **Message Queuing:**
Beanstalkd - Beanstalkd Console - RabbitMQ - RabbitMQ Console - PHP Worker
- **Tools:**
HAProxy - Jenkins - ElasticSearch - Selenium - Certbot - Mailhog - Minio - Varnish - PhpMyAdmin - Adminer - PgAdmin - MailHog - [Blackfire](https://blackfire.io)...
Laradock introduces the **Workspace** Image, as a development environment.
It contains a rich set of helpful tools, all pre-configured to work and integrate with almost any combination of Containers and tools you may choose.
**Workspace Image Tools**
PHP CLI - Composer - Git - Linuxbrew - Node - V8JS - Gulp - SQLite - xDebug - Envoy - Deployer - Vim - Yarn - SOAP - Drush...
You can choose, which tools to install in your workspace container and other containers, from the `.env` file.
> If you modify `docker-compose.yml`, `.env` or any `dockerfile` file, you must re-build your containers, to see those effects in the running instance.
If you can't find your Software in the list, build it yourself and submit it. Contributions are welcomed :)
<a name="what-is-docker"></a>
## What is Docker?
[Docker](https://www.docker.com) is an open platform for developing, shipping, and running applications.
Docker enables you to separate your applications from your infrastructure so you can deliver software quickly.
With Docker, you can manage your infrastructure in the same ways you manage your applications.
By taking advantage of Dockers methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.
<a name="why-docker-not-vagrant"></a>
## Why Docker not Vagrant!?
[Vagrant](https://www.vagrantup.com) creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.
Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you **lightweight** Virtual Containers, that share the same kernel and allow to safely execute independent processes.
In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.
Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).
<a name="Demo"></a>
## Demo Video
What's better than a **Demo Video**:
- Laradock v5.* (soon or never)
- Laradock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
- Laradock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
- Laradock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- Laradock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
<a name="Chat"></a>
## Chat with us
You are welcome to join our chat room on Gitter.
[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

View File

@ -1,7 +1,7 @@
--- ---
title: License title: License
type: index type: index
weight: 7 weight: 8
--- ---
[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT) [MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT)

View File

@ -1,13 +1,13 @@
--- ---
title: Related Projects title: Related Projects
type: index type: index
weight: 4 weight: 6
--- ---
LaraDock related projects: Laradock related projects:
* [LaraDock CLI](https://github.com/lorinlee/laradock-cli) by [LorinLee](https://github.com/lorinlee) * [Laradock CLI](https://github.com/lorinlee/laradock-cli) by [LorinLee](https://github.com/lorinlee)
* [LaraDock Env](https://github.com/bagart/laradock_env) by [BAGArt](https://github.com/bagart) * [Laradock Env](https://github.com/bagart/laradock_env) by [BAGArt](https://github.com/bagart)
* [Klaradock](https://github.com/poyhsiao/Klaradock) by [Kim Hsiao](https://github.com/poyhsiao) * [Klaradock](https://github.com/poyhsiao/Klaradock) by [Kim Hsiao](https://github.com/poyhsiao)
* [Ansible Laradock Kubernetes](https://github.com/sifat-rahim/ansible-laradock-kubernetes) by [Sifat Rahim](https://github.com/sifat-rahim) * [Ansible Laradock Kubernetes](https://github.com/sifat-rahim/ansible-laradock-kubernetes) by [Sifat Rahim](https://github.com/sifat-rahim)
These Docker Compose projects have piqued our interest: These Docker Compose projects have piqued our interest:

View File

@ -1,11 +1,11 @@
<nav aria-label="Navigation"> <nav aria-label="Navigation">
<!--<a href="{{ with .Site.Params.repo_url }}{{ . }}{{ else }}{{ .Site.BaseURL }}{{ end }}" class="project">--> <a href="{{ with .Site.Params.repo_url }}{{ . }}{{ else }}{{ .Site.BaseURL }}{{ end }}" class="project">
<!--<div class="banner">--> <div class="banner">
<!--{{ with .Site.Params.logo }}--> {{ with .Site.Params.logo }}
<!--<div class="logo">--> <div class="logo">
<!--<img src="{{ $.Site.BaseURL }}{{ . }}">--> <img src="{{ $.Site.BaseURL }}{{ . }}">
<!--</div>--> </div>
<!--{{ end }}--> {{ end }}
<!--<div class="name">--> <!--<div class="name">-->
<!--<strong>{{ .Site.Title }} {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>--> <!--<strong>{{ .Site.Title }} {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>-->
<!--{{ with .Scratch.Get "repo_id" }}--> <!--{{ with .Scratch.Get "repo_id" }}-->
@ -13,8 +13,8 @@
<!--{{ . }}--> <!--{{ . }}-->
<!--{{ end }}--> <!--{{ end }}-->
<!--</div>--> <!--</div>-->
<!--</div>--> </div>
<!--</a>--> </a>
<div class="scrollable"> <div class="scrollable">
<div class="wrapper"> <div class="wrapper">

View File

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 3.8 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

@ -3,7 +3,7 @@
* theme that is used as fallback in codeblocks * theme that is used as fallback in codeblocks
*/ */
.article pre code { .article pre code {
color: rgba(0, 0, 0, 0.8) !important; color: rgba(0, 0, 0, 0.78) !important;
} }
@ -103,3 +103,14 @@ font-style:italic;
.hljs-strong { .hljs-strong {
font-weight:700; font-weight:700;
} }
/*
OVERRIDING THE DEFAULT STYLES - By Mahmoud Zalt (mahmoud@zalt.me) for Laradock.io
*/
.project .logo img{
width: 140px;
height: 140px;
background: transparent;
border-radius: 0%;
}

View File

@ -1,24 +1,23 @@
# LaraDock # Laradock
[![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me) [![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me)
[![Gitter](https://badges.gitter.im/LaraDock/laradock.svg)](https://gitter.im/LaraDock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
LaraDock能够帮你在**Docker**上快速搭建**Laravel**应用。 Laradock 能够帮你在 **Docker** 上快速搭建 **Laravel** 应用。
<br>
就像Laravel Homestead一样但是Docker替换了Vagrant。 就像 Laravel Homestead 一样,但是 Docker 替换了 Vagrant。
> 先在使用 LaraDock然后再学习它们。
> 先在使用 Laradock然后再学习它们。
<br>
## 目录 ## 目录
- [Intro](#Intro) - [Intro](#Intro)
- [Features](#features) - [Features](#features)
- [Supported Software's](#Supported-Containers) - [Supported Software's](#Supported-Containers)
- [What is Docker](#what-is-docker) - [What is Docker](#what-is-docker)
- [What is Laravel](#what-is-laravel) - [What is Laravel](#what-is-laravel)
- [Why Docker not Vagrant](#why-docker-not-vagrant) - [Why Docker not Vagrant](#why-docker-not-vagrant)
- [LaraDock VS Homestead](#laradock-vs-homestead) - [Laradock VS Homestead](#laradock-vs-homestead)
- [Demo Video](#Demo) - [Demo Video](#Demo)
- [Requirements](#Requirements) - [Requirements](#Requirements)
- [Installation](#Installation) - [Installation](#Installation)
@ -50,44 +49,51 @@ LaraDock能够帮你在**Docker**上快速搭建**Laravel**应用。
- [Install Prestissimo](#Install-Prestissimo) - [Install Prestissimo](#Install-Prestissimo)
- [Install Node + NVM](#Install-Node) - [Install Node + NVM](#Install-Node)
- [Debugging](#debugging) - [Debugging](#debugging)
- [Upgrading LaraDock](#upgrading-laradock) - [Upgrading Laradock](#upgrading-laradock)
- [Help & Questions](#Help) - [Help & Questions](#Help)
<a name="Intro"></a> <a name="Intro"></a>
## 介绍 ## 介绍
LaraDock努力简化创建开发环境过程。
它包含预包装Docker镜像提供你一个美妙的开发环境而不需要安装PHP,NGINX,MySQL和其他任何软件在你本地机器上。 Laradock 努力简化创建开发环境过程。
它包含预包装 Docker 镜像,提供你一个美妙的开发环境而不需要安装 PHP, NGINX, MySQL 和其他任何软件在你本地机器上。
**使用概览:** **使用概览:**
让我们了解使用它安装 `NGINX`, `PHP`, `Composer`, `MySQL``Redis`,然后运行 `Laravel`
让我们了解使用它安装`NGINX`, `PHP`, `Composer`, `MySQL``Redis`,然后运行`Laravel` 1. 将 Laradock 放到你的 Laravel 项目中:
```bash
git clone https://github.com/laradock/laradock.git
```
1. 将LaraDock放到你的Laravel项目中 2. 进入 Laradock 目录
<br> ```bash
`git clone https://github.com/laradock/laradock.git`. cp env-example .env
2. 进入LaraDock目录然后运行这些容器。 ```
<br>
`docker-compose up -d nginx mysql redis`
3. 打开你的`.env`文件,然后设置`mysql`的`DB_HOST` 和 `redis`的`REDIS_HOST`。
4. 打开浏览器访问localhost
3. 运行这些容器。
```bash
docker-compose up -d nginx mysql redis
```
4. 打开你的Laravel 项目的 `.env` 文件,然后设置 `mysql``DB_HOST``redis` 的`REDIS_HOST`。
5. 打开浏览器,访问 localhost
<a name="features"></a> <a name="features"></a>
### 特点 ### 特点
- 在PHP版本7.05.6.5.5...之中可以简单切换。 - 在 PHP 版本7.05.6.5.5...之中可以简单切换。
- 可选择你最喜欢的数据库引擎比如MySQL, Postgres, MariaDB... - 可选择你最喜欢的数据库引擎比如MySQL, Postgres, MariaDB...
- 可运行自己的软件组合比如Memcached, HHVM, Beanstalkd... - 可运行自己的软件组合比如Memcached, HHVM, Beanstalkd...
- 所有软件运行在不同的容器之中比如PHP-FPM, NGINX, PHP-CLI... - 所有软件运行在不同的容器之中比如PHP-FPM, NGINX, PHP-CLI...
- 通过简单的编写`dockerfile`容易定制任何容器。 - 通过简单的编写 `Dockerfile` 容易定制任何容器。
- 所有镜像继承自一个官方基础镜像Trusted base Images - 所有镜像继承自一个官方基础镜像Trusted base Images
- 可预配置Laravel的Nginx环境 - 可预配置Laravel的Nginx环境
- 容易应用容器中的配置 - 容易应用容器中的配置 配置文件(`Dockerfile`
- 干净的结构化的Docker配置文件`dockerfile` - 最新的 Docker Compose 版本(`docker-compose`
- 最新的Docker Compose 版本(`docker-compose`
- 所有的都是可视化和可编辑的 - 所有的都是可视化和可编辑的
- 快速的镜像构建 - 快速的镜像构建
- 每周都会有更新... - 每周都会有更新...
@ -115,96 +121,82 @@ LaraDock努力简化创建开发环境过程。
- Beanstalkd (+ Beanstalkd Console) - Beanstalkd (+ Beanstalkd Console)
- **工具:** - **工具:**
- Workspace (PHP7-CLI, Composer, Git, Node, Gulp, SQLite, Vim, Nano, cURL...) - Workspace (PHP7-CLI, Composer, Git, Node, Gulp, SQLite, Vim, Nano, cURL...)
>如果你找不到你需要的软件,构建它然后把它添加到这个列表。你的贡献是受欢迎的。 >如果你找不到你需要的软件,构建它然后把它添加到这个列表。你的贡献是受欢迎的。
<a name="what-is-docker"></a> <a name="what-is-docker"></a>
### Docker是什么? ### Docker 是什么?
[Docker](https://www.docker.com) 是一个开源项目,自动化部署应用程序软件的容器,在Linux, Mac OS and Windows提供一个额外的抽象层和自动化的[操作系统级的虚拟化](https://en.wikipedia.org/wiki/Operating-system-level_virtualization) [Docker](https://www.docker.com) 是一个开源项目,自动化部署应用程序软件的容器,在 Linux, Mac OS and Windows 提供一个额外的抽象层和自动化的[操作系统级的虚拟化](https://en.wikipedia.org/wiki/Operating-system-level_virtualization)
<a name="what-is-laravel"></a> <a name="what-is-laravel"></a>
### Laravel是什么? ### Laravel 是什么?
额,这很认真的!!! 额,这很认真的!!!
<a name="why-docker-not-vagrant"></a> <a name="why-docker-not-vagrant"></a>
### 为什么使用Docker而不是Vagrant!? ### 为什么使用 Docker 而不是 Vagrant!?
[Vagrant](https://www.vagrantup.com)构建虚拟机需要几分钟然而Docker构建虚拟容器只需要几秒钟。 [Vagrant](https://www.vagrantup.com) 构建虚拟机需要几分钟然而 Docker 构建虚拟容器只需要几秒钟。
而不是提供一个完整的虚拟机,就像你用Vagrant,Docker为您提供**轻量级**虚拟容器,共享相同的内核和允许安全执行独立的进程。 而不是提供一个完整的虚拟机,就像你用 Vagrant, Docker 为您提供**轻量级**虚拟容器,共享相同的内核和允许安全执行独立的进程。
除了速度,Docker提供大量的Vagrant无法实现的功能。 除了速度, Docker 提供大量的 Vagrant 无法实现的功能。
最重要的是Docker可以运行在开发和生产(相同环境无处不在)。Vagrant是专为开发,(所以在生产环境你必须每一次重建您的服务器)。 最重要的是 Docker 可以运行在开发和生产(相同环境无处不在)。Vagrant 是专为开发,(所以在生产环境你必须每一次重建您的服务器)。
<a name="laradock-vs-homestead"></a> <a name="laradock-vs-homestead"></a>
### LaraDock Homestead 对比 ### Laradock Homestead 对比
LaraDock and [Homestead](https://laravel.com/docs/master/homestead) 给你一个完整的虚拟开发环境。(不需要安装和配置软件在你自己的每一个操作系统)。 Laradock and [Homestead](https://laravel.com/docs/master/homestead) 给你一个完整的虚拟开发环境。(不需要安装和配置软件在你自己的每一个操作系统)。
Homestead 是一个工具,为你控制虚拟机(使用Homestead特殊命令)。Vagrant可以管理你的管理虚容器。
运行一个虚拟容器比运行一整个虚拟机快多了**LaraDock 比 Homestead快多了**
Homestead 是一个工具,为你控制虚拟机(使用 Homestead 特殊命令)。Vagrant 可以管理你的管理虚容器。
运行一个虚拟容器比运行一整个虚拟机快多了 **Laradock 比 Homestead 快多了**
<a name="Demo"></a> <a name="Demo"></a>
## 演示视频 ## 演示视频
还有什么比**演示视频**好: 还有什么比**演示视频**好:
- LaraDock [v4.0](https://www.youtube.com/watch?v=TQii1jDa96Y) - Laradock [v4.0](https://www.youtube.com/watch?v=TQii1jDa96Y)
- LaraDock [v2.2](https://www.youtube.com/watch?v=-DamFMczwDA) - Laradock [v2.2](https://www.youtube.com/watch?v=-DamFMczwDA)
- LaraDock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI) - Laradock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- LaraDock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80) - Laradock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
<a name="Requirements"></a> <a name="Requirements"></a>
## 依赖 ## 依赖
- [Git](https://git-scm.com/downloads) - [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/) - [Docker](https://www.docker.com/products/docker/)
<a name="Installation"></a> <a name="Installation"></a>
## 安装 ## 安装
1 - 克隆 `Laradock` 仓库:
1 - 克隆 `LaraDock` 仓库: **A)** 如果你已经有一个 Laravel 项目,克隆这个仓库在到 `Laravel` 根目录
**A)** 如果你已经有一个Laravel项目,克隆这个仓库在到`Laravel`根目录
```bash ```bash
git submodule add https://github.com/laradock/laradock.git git submodule add https://github.com/laradock/laradock.git
``` ```
>如果你不是使用Git管理Laravel项目,您可以使用 `git clone` 而不是`git submodule`。
>如果你不是使用 Git 管理 Laravel 项目,您可以使用 `git clone` 而不是 `git submodule`
**B)** 如果你没有一个Laravel项目,你想Docker安装Laravel,克隆这个源在您的机器任何地方上: **B)** 如果你没有一个 Laravel 项目,你想 Docker 安装 Laravel,克隆这个源在您的机器任何地方上:
```bash ```bash
git clone https://github.com/laradock/laradock.git git clone https://github.com/laradock/laradock.git
``` ```
<a name="Usage"></a> <a name="Usage"></a>
## 使用 ## 使用
**请在开始之前阅读:** **请在开始之前阅读:**
如果你正在使用**Docker Toolbox** (VM),选择以下任何一个方法: 如果你正在使用 **Docker Toolbox** (VM),选择以下任何一个方法:
- 更新到Docker [Native](https://www.docker.com/products/docker) Mac/Windows版本 (建议). 查看 [Upgrading LaraDock](#upgrading-laradock) - 更新到 Docker [Native](https://www.docker.com/products/docker) Mac/Windows 版本 (建议). 查看 [Upgrading Laradock](#upgrading-laradock)
- 使用 LaraDock v3.* (访问 `LaraDock-ToolBox` [分支](https://github.com/laradock/laradock/tree/LaraDock-ToolBox)). - 使用 Laradock v3.* (访问 `Laradock-ToolBox` [分支](https://github.com/laradock/laradock/tree/Laradock-ToolBox)).
如果您使用的是**Docker Native**(Mac / Windows版本)甚至是Linux版本,通常可以继续阅读这个文档LaraDock v4以上版本将仅支持**Docker Native**。 如果您使用的是 **Docker Native**(Mac / Windows 版本)甚至是 Linux 版本,通常可以继续阅读这个文档Laradock v4 以上版本将仅支持 **Docker Native**
<br>
<br>
1 - 运行容器: *(在运行`docker-compose`命令之前,确认你在 `laradock` 目录中*
1 - 运行容器: *(在运行 `docker-compose` 命令之前,确认你在 `laradock` 目录中*
**例子:** 运行 NGINX 和 MySQL: **例子:** 运行 NGINX 和 MySQL:
@ -213,77 +205,50 @@ docker-compose up -d nginx mysql
``` ```
你可以从以下列表选择你自己的容器组合: 你可以从以下列表选择你自己的容器组合:
`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `workspace`. `nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `workspace`.
**说明**: `workspace``php-fpm` 将运行在大部分实例中, 所以不需要在 `up` 命令中加上它们. **说明**: `workspace``php-fpm` 将运行在大部分实例中, 所以不需要在 `up` 命令中加上它们.
<br>
2 - 进入 Workspace 容器, 执行像 (Artisan, Composer, PHPUnit, Gulp, ...)等命令 2 - 进入 Workspace 容器, 执行像 (Artisan, Composer, PHPUnit, Gulp, ...)等命令
```bash ```bash
docker-compose exec workspace bash docker-compose exec workspace bash
``` ```
<br />
增加 `--user=laradock` (例如 `docker-compose exec --user=laradock workspace bash`) 作为您的主机的用户创建的文件. (你可以从 `docker-compose.yml`修改 PUID (User id) 和 PGID (group id) 值 ). 增加 `--user=laradock` (例如 `docker-compose exec --user=laradock workspace bash`) 作为您的主机的用户创建的文件. (你可以从 `docker-compose.yml`修改 PUID (User id) 和 PGID (group id) 值 ).
<br>
3 - 编辑 Laravel 的配置. 3 - 编辑 Laravel 的配置.
如果你还没有安装Laravel项目请查看 [How to Install Laravel in a Docker Container](#Install-Laravel). 如果你还没有安装 Laravel 项目,请查看 [How to Install Laravel in a Docker Container](#Install-Laravel).
打开 Laravel的 `.env` 文件 然后 配置 你的`mysql`的`DB_HOST`: 打开 Laravel `.env` 文件 然后 配置 你的 `mysql` `DB_HOST`:
```env ```env
DB_HOST=mysql DB_HOST=mysql
``` ```
4 - 打开浏览器访问 localhost (`http://localhost/`).
<br>
4 - 打开浏览器访问localhost (`http://localhost/`).
<br>
**调试**: 如果你碰到任何问题,请查看 [调试](#debugging) 章节 **调试**: 如果你碰到任何问题,请查看 [调试](#debugging) 章节
如果你需要特别支持,请联系我,更多细节在[帮助 & 问题](#Help)章节 如果你需要特别支持,请联系我,更多细节在[帮助 & 问题](#Help)章节
<br>
<a name="Documentation"></a> <a name="Documentation"></a>
## 文档 ## 文档
<a name="Docker"></a> <a name="Docker"></a>
### [Docker] ### [Docker]
<a name="List-current-running-Containers"></a> <a name="List-current-running-Containers"></a>
### 列出正在运行的容器 ### 列出正在运行的容器
```bash ```bash
docker ps docker ps
``` ```
你也可以使用以下命令查看某项目的容器 你也可以使用以下命令查看某项目的容器
```bash ```bash
docker-compose ps docker-compose ps
``` ```
<br>
<a name="Close-all-running-Containers"></a> <a name="Close-all-running-Containers"></a>
### 关闭所有容器 ### 关闭所有容器
```bash ```bash
@ -296,25 +261,18 @@ docker-compose stop
docker-compose stop {容器名称} docker-compose stop {容器名称}
``` ```
<br>
<a name="Delete-all-existing-Containers"></a> <a name="Delete-all-existing-Containers"></a>
### 删除所有容器 ### 删除所有容器
```bash ```bash
docker-compose down docker-compose down
``` ```
小心这个命令,因为它也会删除你的数据容器。(如果你想保留你的数据你应该在上述命令后列出容器名称删除每个容器本身):* 小心这个命令,因为它也会删除你的数据容器。(如果你想保留你的数据你应该在上述命令后列出容器名称删除每个容器本身):*
<br>
<a name="Enter-Container"></a> <a name="Enter-Container"></a>
### 进入容器 (通过SSH 进入一个运行中的容器) ### 进入容器 (通过 SSH 进入一个运行中的容器)
1 - 首先使用 `docker ps`命令查看正在运行的容器 1 - 首先使用 `docker ps` 命令查看正在运行的容器
2 - 进入某个容器使用: 2 - 进入某个容器使用:
@ -331,12 +289,6 @@ docker-compose exec mysql bash
3 - 退出容器, 键入 `exit`. 3 - 退出容器, 键入 `exit`.
<br>
<a name="Edit-Container"></a> <a name="Edit-Container"></a>
### 编辑默认容器配置 ### 编辑默认容器配置
打开 `docker-compose.yml` 然后 按照你想的修改. 打开 `docker-compose.yml` 然后 按照你想的修改.
@ -357,18 +309,10 @@ docker-compose exec mysql bash
- "1111:6379" - "1111:6379"
``` ```
<br>
<a name="Edit-a-Docker-Image"></a> <a name="Edit-a-Docker-Image"></a>
### 编辑Docker镜像 ### 编辑 Docker 镜像
1 - 找到你想修改的镜像的 `dockerfile` , 1 - 找到你想修改的镜像的 `Dockerfile` ,
<br> <br>
例如: `mysql``mysql/Dockerfile`. 例如: `mysql``mysql/Dockerfile`.
@ -379,28 +323,19 @@ docker-compose exec mysql bash
```bash ```bash
docker-compose build mysql docker-compose build mysql
``` ```
更多信息在容器重建中 [点击这里](#Build-Re-build-Containers).
更多信息在容器重建中[点击这里](#Build-Re-build-Containers).
<br>
<a name="Build-Re-build-Containers"></a> <a name="Build-Re-build-Containers"></a>
### 建立/重建容器 ### 建立/重建容器
如果你做任何改变 `Dockerfile` 确保你运行这个命令,可以让所有修改更改生效:
如果你做任何改变`dockerfile`确保你运行这个命令,可以让所有修改更改生效:
```bash ```bash
docker-compose build docker-compose build
``` ```
选择你可以指定哪个容器重建(而不是重建所有的容器):
选择你可以指定哪个容器重建(而不是重建所有的容器):
```bash ```bash
docker-compose build {container-name} docker-compose build {container-name}
@ -408,25 +343,11 @@ docker-compose build {container-name}
如果你想重建整个容器,你可能需要使用 `--no-cache` 选项 (`docker-compose build --no-cache {container-name}`). 如果你想重建整个容器,你可能需要使用 `--no-cache` 选项 (`docker-compose build --no-cache {container-name}`).
<br>
<a name="Add-Docker-Images"></a> <a name="Add-Docker-Images"></a>
### 增加更多软件 (Docker 镜像) ### 增加更多软件 (Docker 镜像)
为了增加镜像(软件), 编辑 `docker-compose.yml` 添加容器细节, 你需要熟悉 [docker compose 文件语法](https://docs.docker.com/compose/compose-file/). 为了增加镜像(软件), 编辑 `docker-compose.yml` 添加容器细节, 你需要熟悉 [docker compose 文件语法](https://docs.docker.com/compose/compose-file/).
<br>
<a name="View-the-Log-files"></a> <a name="View-the-Log-files"></a>
### 查看日志文件 ### 查看日志文件
Nginx的日志在 `logs/nginx` 目录 Nginx的日志在 `logs/nginx` 目录
@ -437,19 +358,12 @@ Nginx的日志在 `logs/nginx` 目录
docker logs {container-name} docker logs {container-name}
``` ```
<br>
<a name="Laravel"></a> <a name="Laravel"></a>
### [Laravel] ### [Laravel]
<a name="Install-Laravel"></a> <a name="Install-Laravel"></a>
### 从Docker镜像安装Laravel ### 从 Docker 镜像安装 Laravel
1 - 首先你需要进入 Workspace 容器. 1 - 首先你需要进入 Workspace 容器.
2 - 安装 Laravel. 2 - 安装 Laravel.
@ -460,16 +374,15 @@ docker logs {container-name}
composer create-project laravel/laravel my-cool-app "5.2.*" composer create-project laravel/laravel my-cool-app "5.2.*"
``` ```
> 我们建议使用 `composer create-project` 替换Laravel 安装器去安装Laravel. > 我们建议使用 `composer create-project` 替换 Laravel 安装器去安装 Laravel.
关于更多Laravel安装内容请 [点击这儿](https://laravel.com/docs/master#installing-laravel). 关于更多 Laravel 安装内容请 [点击这儿](https://laravel.com/docs/master#installing-laravel).
3 - 编辑 `docker-compose.yml` 映射新的应用目录: 3 - 编辑 `docker-compose.yml` 映射新的应用目录:
系统默认LaraDock假定Laravel应用在LaraDock的父级目录中 系统默认 Laradock 假定 Laravel 应用在 laradock 的父级目录中
By default LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
更新Laravel应用在 `my-cool-app` 目录中, 我们需要用 `../my-cool-app/:/var/www`替换 `../:/var/www` , 如下: 更新 Laravel 应用在 `my-cool-app` 目录中, 我们需要用 `../my-cool-app/:/var/www`替换 `../:/var/www` , 如下:
```yaml ```yaml
application: application:
@ -477,32 +390,33 @@ By default LaraDock assumes the Laravel application is living in the parent dire
volumes: volumes:
- ../my-cool-app/:/var/www - ../my-cool-app/:/var/www
``` ```
4 - 进入目录下继续工作.. 4 - 进入目录下继续工作..
```bash ```bash
cd my-cool-app cd my-cool-app
``` ```
5 - 回到LaraDock安装步骤,看看如何编辑`env`的文件。 5 - 回到 Laradock 安装步骤,看看如何编辑 `.env` 的文件。
<br>
<a name="Run-Artisan-Commands"></a> <a name="Run-Artisan-Commands"></a>
### 运行 Artisan 命令 ### 运行 Artisan 命令
你可以从Workspace容器运行artisan命令和其他终端命令
1 - 确认Workspace容器已经运行. 你可以从 Workspace 容器运行 artisan 命令和其他终端命令
1 - 确认 Workspace 容器已经运行.
```bash ```bash
docker-compose up -d workspace // ..and all your other containers docker-compose up -d workspace // ..and all your other containers
``` ```
2 - 找到Workspace容器名称: 2 - 找到 Workspace 容器名称:
```bash ```bash
docker-compose ps docker-compose ps
``` ```
3 - 进入Workspace容器: 3 - 进入 Workspace 容器:
```bash ```bash
docker-compose exec workspace bash docker-compose exec workspace bash
@ -510,35 +424,33 @@ docker-compose exec workspace bash
增加 `--user=laradock` (例如 `docker-compose exec --user=laradock workspace bash`) 作为您的主机的用户创建的文件. 增加 `--user=laradock` (例如 `docker-compose exec --user=laradock workspace bash`) 作为您的主机的用户创建的文件.
4 - 运行任何你想的 :) 4 - 运行任何你想的 :)
```bash ```bash
php artisan php artisan
``` ```
```bash ```bash
Composer update composer update
``` ```
```bash ```bash
phpunit phpunit
``` ```
<br>
<a name="Use-Redis"></a> <a name="Use-Redis"></a>
### 使用 Redis ### 使用 Redis
1 - 首先务必用 `docker-compose up` 命令运行 (`redis`)容器. 1 - 首先务必用 `docker-compose up` 命令运行 (`redis`) 容器.
```bash ```bash
docker-compose up -d redis docker-compose up -d redis
``` ```
2 - 打开你的Laravel的 `.env` 文件 然后 配置`redis`的`REDIS_HOST` 2 - 打开你的Laravel的 `.env` 文件 然后 配置 `redis` `REDIS_HOST`
```env ```env
REDIS_HOST=redis REDIS_HOST=redis
``` ```
如果在你的`.env` 文件没有找到`REDIS_HOST`变量。打开数据库配置文件`config/database.php`然后用`redis`替换默认IP`127.0.0.1`,例如:
如果在你的 `.env` 文件没有找到 `REDIS_HOST` 变量。打开数据库配置文件 `config/database.php` 然后用 `redis` 替换默认 IP `127.0.0.1`,例如:
```php ```php
@ -552,44 +464,35 @@ REDIS_HOST=redis
], ],
``` ```
3 - 启用Redis缓存或者开启Session管理也在`.env`文件中用`redis`替换默认`file`设置`CACHE_DRIVER` 和 `SESSION_DRIVER` 3 - 启用 Redis 缓存或者开启 Session 管理也在 `.env` 文件中用 `redis` 替换默认 `file` 设置 `CACHE_DRIVER``SESSION_DRIVER`
```env ```env
CACHE_DRIVER=redis CACHE_DRIVER=redis
SESSION_DRIVER=redis SESSION_DRIVER=redis
``` ```
4 - 最好务必通过Compose安装 `predis/predis``(~1.0)`: 4 - 最好务必通过 Composer 安装 `predis/predis``(~1.0)`:
```bash ```bash
composer require predis/predis:^1.0 composer require predis/predis:^1.0
``` ```
5 - 你可以用以下代码在Laravel中手动测试 5 - 你可以用以下代码在 Laravel 中手动测试:
```php ```php
\Cache::store('redis')->put('LaraDock', 'Awesome', 10); \Cache::store('redis')->put('Laradock', 'Awesome', 10);
``` ```
<br>
<a name="Use-Mongo"></a> <a name="Use-Mongo"></a>
### 使用 Mongo ### 使用 Mongo
1 - 首先在Workspace和PHP-FPM容器中安装`mongo`: 1 - 首先在 Workspace 和 PHP-FPM 容器中安装 `mongo`:
<br>
a) 打开 `docker-compose.yml` 文件
<br>
b) 在Workspace容器中找到`INSTALL_MONGO`选项:
<br> a) 打开 `docker-compose.yml` 文件
c) 设置为 `true` b) 在 Workspace 容器中找到 `INSTALL_MONGO` 选项:
<br> c) 设置为 `true`
d) 在PHP-FPM容器中找到`INSTALL_MONGO` <br> d) 在 PHP-FPM 容器中找到 `INSTALL_MONGO`
e) 设置为 `true` e) 设置为 `true`
相关配置项如下: 相关配置项如下:
@ -608,18 +511,19 @@ e) 设置为 `true`
... ...
``` ```
2 - 重建`Workspace、PHP-FPM`容器 `docker-compose build workspace php-fpm` 2 - 重建 `Workspace、PHP-FPM` 容器
```bash
docker-compose build workspace php-fpm
```
3 - 使用 `docker-compose up` 命令运行 MongoDB 容器 (`mongo`)
3 - 使用`docker-compose up` 命令运行MongoDB容器 (`mongo`)
```bash ```bash
docker-compose up -d mongo docker-compose up -d mongo
``` ```
4 - 在 `config/database.php` 文件添加 MongoDB 的配置项:
4 - 在`config/database.php` 文件添加MongoDB的配置项:
```php ```php
'connections' => [ 'connections' => [
@ -641,65 +545,53 @@ docker-compose up -d mongo
], ],
``` ```
5 - 打开Laravel的 `.env` 文件 然后 更新以下字段: 5 - 打开 Laravel `.env` 文件然后更新以下字段:
- 设置 `DB_HOST``mongo`的主机IP. - 设置 `DB_HOST``mongo` 的主机 IP.
- 设置 `DB_PORT``27017`. - 设置 `DB_PORT``27017`.
- 设置 `DB_DATABASE``database`. - 设置 `DB_DATABASE``database`.
6 - 最后务必通过Composer安装`jenssegers/mongodb`包添加服务提供者Laravel Service Provider 6 - 最后务必通过 Composer 安装 `jenssegers/mongodb` 添加服务提供者Laravel Service Provider
```bash ```bash
composer require jenssegers/mongodb composer require jenssegers/mongodb
``` ```
更多细节内容 [点击这儿](https://github.com/jenssegers/laravel-mongodb#installation). 更多细节内容 [点击这儿](https://github.com/jenssegers/laravel-mongodb#installation).
7 - 测试: 7 - 测试:
- 首先让你的模型继承Mongo的Eloquent Model. 查看 [文档](https://github.com/jenssegers/laravel-mongodb#eloquent). - 首先让你的模型继承 Mongo Eloquent Model. 查看 [文档](https://github.com/jenssegers/laravel-mongodb#eloquent).
- 进入Workspace容器. - 进入 Workspace 容器.
- 迁移数据库 `php artisan migrate`. - 迁移数据库 `php artisan migrate`.
<br>
<a name="PHP"></a> <a name="PHP"></a>
### [PHP] ### [PHP]
<a name="Install-PHP-Extensions"></a> <a name="Install-PHP-Extensions"></a>
### 安装PHP拓展 ### 安装 PHP 拓展
安装PHP扩展之前,你必须决定你是否需要`FPM`或`CLI`,因为他们安装在不同的容器上,如果你需要两者,则必须编辑两个容器。
PHP-FPM拓展务必安装在 `php-fpm/Dockerfile-XX`. *(用你PHP版本号替换 XX)*. 安装 PHP 扩展之前,你必须决定你是否需要 `FPM``CLI`,因为他们安装在不同的容器上,如果你需要两者,则必须编辑两个容器。
<br>
PHP-CLI拓展应该安装到`workspace/Dockerfile`.
PHP-FPM 拓展务必安装在 `php-fpm/Dockerfile-XX`. *(用你 PHP 版本号替换 XX)*.
PHP-CLI 拓展应该安装到 `workspace/Dockerfile`.
<br>
<a name="Change-the-PHP-FPM-Version"></a> <a name="Change-the-PHP-FPM-Version"></a>
### 修改PHP-FPM版本 ### 修改 PHP-FPM 版本
默认运行**PHP-FPM 7.0**版本. 默认运行 **PHP-FPM 7.0** 版本.
>PHP-FPM负责服务你的应用代码,如果你是计划运行您的应用程序在不同PHP-FPM版本上则不需要更改PHP-CLI版本。
>PHP-FPM 负责服务你的应用代码,如果你是计划运行您的应用程序在不同 PHP-FPM 版本上,则不需要更改 PHP-CLI 版本。
#### A) 切换版本 PHP `7.0` 到 PHP `5.6` #### A) 切换版本 PHP `7.0` 到 PHP `5.6`
1 - 打开 `docker-compose.yml` 1 - 打开 `docker-compose.yml`
2 - 在PHP容器的 `Dockerfile-70`文件。 2 - 在PHP容器的 `Dockerfile-70` 文件。
3 - 修改版本号, 用`Dockerfile-56`替换 `Dockerfile-70` , 例如: 3 - 修改版本号, 用 `Dockerfile-56` 替换 `Dockerfile-70` , 例如:
```txt ```txt
php-fpm: php-fpm:
@ -718,57 +610,39 @@ docker-compose build php
#### B) 切换版本 PHP `7.0``5.6` 到 PHP `5.5` #### B) 切换版本 PHP `7.0``5.6` 到 PHP `5.5`
我们已不在本地支持PHP5.5,但是你按照以下步骤获取: 我们已不在本地支持 PHP5.5,但是你按照以下步骤获取:
1 - 克隆 `https://github.com/laradock/php-fpm`. 1 - 克隆 `https://github.com/laradock/php-fpm`.
3 - 重命名 `Dockerfile-56``Dockerfile-55`. 2 - 重命名 `Dockerfile-56``Dockerfile-55`.
3 - 编辑文件 `FROM php:5.6-fpm``FROM php:5.5-fpm`. 3 - 编辑文件 `FROM php:5.6-fpm``FROM php:5.5-fpm`.
4 - 从 `Dockerfile-55`构建镜像. 4 - 从 `Dockerfile-55` 构建镜像.
5 - 打开 `docker-compose.yml` 文件. 5 - 打开 `docker-compose.yml` 文件.
6 - 将 `php-fpm` 指向你的 `Dockerfile-55` 文件. 6 - 将 `php-fpm` 指向你的 `Dockerfile-55` 文件.
<br>
<a name="Change-the-PHP-CLI-Version"></a> <a name="Change-the-PHP-CLI-Version"></a>
### 修改 PHP-CLI 版本 ### 修改 PHP-CLI 版本
默认运行**PHP-CLI 7.0**版本 默认运行 **PHP-CLI 7.0** 版本
>说明: PHP-CLI只用于执行Artisan和Composer命令不服务于你的应用代码这是PHP-FPM的工作所以编辑PHP-CLI的版本不是很重要。 >说明: PHP-CLI 只用于执行 Artisan 和 Composer 命令,不服务于你的应用代码,这是 PHP-FPM 的工作,所以编辑 PHP-CLI 的版本不是很重要。
PHP-CLI安装在Workspace容器改变PHP-CLI版本你需要编辑`workspace/Dockerfile`. PHP-CLI 安装在 Workspace 容器,改变 PHP-CLI 版本你需要编辑 `workspace/Dockerfile`.
现在你必须手动修改PHP-FPM的`Dockerfile`或者创建一个新的。 (可以考虑贡献功能). 现在你必须手动修改 PHP-FPM 的 `Dockerfile` 或者创建一个新的。 (可以考虑贡献功能).
<br>
<a name="Install-xDebug"></a> <a name="Install-xDebug"></a>
### 安装 xDebug ### 安装 xDebug
1 - 首先在Workspace和PHP-FPM容器安装 `xDebug`: 1 - 首先在 Workspace 和 PHP-FPM 容器安装 `xDebug`:
<br>
a) 打开 `docker-compose.yml` 文件 a) 打开 `docker-compose.yml` 文件
<br> b) 在 Workspace 容器中找到 `INSTALL_XDEBUG` 选项
b) 在Workspace容器中找到 `INSTALL_XDEBUG` 选项 c) 改为 `true`
<br> d) 在 PHP-FPM 容器中找到 `INSTALL_XDEBUG ` 选项
c) 改为 `true` e) 改为 `true`
<br>
d) 在PHP-FPM容器中找到 `INSTALL_XDEBUG ` 选项<br>
e) 改为 `true`
例如: 例如:
@ -789,44 +663,35 @@ e) 改为 `true`
2 - 重建容器 `docker-compose build workspace php-fpm` 2 - 重建容器 `docker-compose build workspace php-fpm`
<br>
<a name="Misc"></a> <a name="Misc"></a>
### [Misc] ### [Misc]
<br>
<a name="Use-custom-Domain"></a> <a name="Use-custom-Domain"></a>
### 使用自定义域名 (替换Docker的IP) ### 使用自定义域名 (替换 Docker 的 IP)
假定你的自定义域名是 `laravel.dev` 假定你的自定义域名是 `laravel.dev`
1 - 打开 `/etc/hosts` 文件 添加以下内容映射你的localhost 地址 `127.0.0.1``laravel.dev` 域名 1 - 打开 `/etc/hosts` 文件添加以下内容,映射你的 localhost 地址 `127.0.0.1``laravel.dev` 域名
```bash ```bash
127.0.0.1 laravel.dev 127.0.0.1 laravel.dev
``` ```
2 - 打开你的浏览器访问 `{http://laravel.dev}` 2 - 打开你的浏览器访问 `{http://laravel.dev}`
你可以在nginx配置文件自定义服务器名称,如下: 你可以在 nginx 配置文件自定义服务器名称,如下:
```conf ```conf
server_name laravel.dev; server_name laravel.dev;
``` ```
<br>
<a name="Enable-Global-Composer-Build-Install"></a> <a name="Enable-Global-Composer-Build-Install"></a>
### 安装全局Composer命令 ### 安装全局 Composer 命令
为启用全局Composer Install在容器构建中允许你安装composer的依赖然后构建完成后就是可用的。 为启用全局 Composer Install 在容器构建中允许你安装 composer 的依赖,然后构建完成后就是可用的。
1 - 打开 `docker-compose.yml` 文件 1 - 打开 `docker-compose.yml` 文件
2 - 在Workspace容器找到 `COMPOSER_GLOBAL_INSTALL` 选项并设置为 `true` 2 - 在 Workspace 容器找到 `COMPOSER_GLOBAL_INSTALL` 选项并设置为 `true`
例如: 例如:
@ -840,19 +705,16 @@ server_name laravel.dev;
``` ```
3 - 现在特价你的依赖关系到 `workspace/composer.json` 3 - 现在特价你的依赖关系到 `workspace/composer.json`
4 - 重建Workspace容器 `docker-compose build workspace` 4 - 重建 Workspace 容器 `docker-compose build workspace`
<br>
<a name="Install-Prestissimo"></a> <a name="Install-Prestissimo"></a>
### 安装 Prestissimo ### 安装 Prestissimo
[Prestissimo](https://github.com/hirak/prestissimo) 是一个平行安装功能的composer插件。 [Prestissimo](https://github.com/hirak/prestissimo) 是一个平行安装功能的 composer 插件。
1 - 在安装期间使全局Composer Install 正在运行:
点击这个 [启用全局Composer构建安装](#Enable-Global-Composer-Build-Install) 然后继续步骤1、2. 1 - 在安装期间,使全局 Composer Install 正在运行:
点击这个 [启用全局 Composer 构建安装](#Enable-Global-Composer-Build-Install) 然后继续步骤1、2.
2 - 添加 prestissimo 依赖到 Composer: 2 - 添加 prestissimo 依赖到 Composer:
@ -860,19 +722,17 @@ a - 现在打开 `workspace/composer.json` 文件
b - 添加 `"hirak/prestissimo": "^0.3"` 依赖 b - 添加 `"hirak/prestissimo": "^0.3"` 依赖
c - 重建Workspace容器 `docker-compose build workspace` c - 重建 Workspace 容器 `docker-compose build workspace`
<br>
<a name="Install-Node"></a> <a name="Install-Node"></a>
### 安装 Node + NVM ### 安装 Node + NVM
在Workspace 容器安装 NVM 和 NodeJS 在 Workspace 容器安装 NVM 和 NodeJS
1 - 打开 `docker-compose.yml` 文件 1 - 打开 `docker-compose.yml` 文件
2 - 在Workspace容器找到 `INSTALL_NODE` 选项设为 `true` 2 - 在 Workspace 容器找到 `INSTALL_NODE` 选项设为 `true`
例如: 例如:
@ -887,17 +747,14 @@ c - 重建Workspace容器 `docker-compose build workspace`
3 - 重建容器 `docker-compose build workspace` 3 - 重建容器 `docker-compose build workspace`
<br>
<a name="debugging"></a> <a name="debugging"></a>
### Debugging ### Debugging
*这里是你可能面临的常见问题列表,以及可能的解决方案.* *这里是你可能面临的常见问题列表,以及可能的解决方案.*
#### 看到空白页而不是Laravel的欢迎页面! #### 看到空白页而不是 Laravel 的欢迎页面!
在Laravel根目录运行下列命令: Laravel 根目录,运行下列命令:
```bash ```bash
sudo chmod -R 777 storage bootstrap/cache sudo chmod -R 777 storage bootstrap/cache
@ -909,45 +766,39 @@ sudo chmod -R 777 storage bootstrap/cache
#### 看到包含 `address already in use` 的错误 #### 看到包含 `address already in use` 的错误
确保你想运行的服务端口(80, 3306, etc.)不是已经被其他程序使用,例如`apache`/`httpd`服务或其他安装的开发工具 确保你想运行的服务端口(80, 3306, etc.)不是已经被其他程序使用,例如 `apache`/`httpd` 服务或其他安装的开发工具
<br>
<a name="upgrading-laradock"></a> <a name="upgrading-laradock"></a>
### LaraDock 升级 ### Laradock 升级
Docker Toolbox (VirtualBox)移动到Docker Native (for Mac/Windows),需要从 LaraDock v3.* 升级到 v4.*: Docker Toolbox (VirtualBox) 移动到 Docker Native (for Mac/Windows),需要从 Laradock v3.* 升级到 v4.*:
1. 停止Docker虚拟机 `docker-machine stop {default}` 1. 停止 Docker 虚拟机 `docker-machine stop {default}`
2. 安装 Docker [Mac](https://docs.docker.com/docker-for-mac/) 或 [Windows](https://docs.docker.com/docker-for-windows/). 2. 安装 Docker [Mac](https://docs.docker.com/docker-for-mac/) 或 [Windows](https://docs.docker.com/docker-for-windows/).
3. 升级 LaraDock 到 `v4.*.*` (`git pull origin master`) 3. 升级 Laradock 到 `v4.*.*` (`git pull origin master`)
4. 像之前一样使用LaraDock: `docker-compose up -d nginx mysql`. 4. 像之前一样使用 Laradock: `docker-compose up -d nginx mysql`.
**说明:** 如果你面临任何上面的问题的最后一步:重建你所有的容器 **说明:** 如果你面临任何上面的问题的最后一步:重建你所有的容器
`docker-compose build --no-cache` ```bash
docker-compose build --no-cache
```
"警告:容器数据可能会丢失!" "警告:容器数据可能会丢失!"
<br>
## 贡献 ## 贡献
这个小项目是由一个有一个全职工作和很多的职责的人建立的,所以如果你喜欢这个项目,并且发现它需要一个bug修复或支持或新软件或升级任何容器,或其他任何. . 你是非常欢迎,欢迎毫不不犹豫地贡献吧:) 这个小项目是由一个有一个全职工作和很多的职责的人建立的,所以如果你喜欢这个项目,并且发现它需要一个 bug 修复或支持或新软件或升级任何容器,或其他任何. . 你是非常欢迎,欢迎毫不不犹豫地贡献吧:)
#### 阅读我们的 [贡献说明](https://github.com/laradock/laradock/blob/master/CONTRIBUTING.md) #### 阅读我们的 [贡献说明](https://github.com/laradock/laradock/blob/master/CONTRIBUTING.md)
<a name="Help"></a> <a name="Help"></a>
## 帮助 & 问题 ## 帮助 & 问题
从聊天室 [Gitter](https://gitter.im/LaraDock/laradock) 社区获取帮助和支持. 从聊天室 [Gitter](https://gitter.im/Laradock/laradock) 社区获取帮助和支持.
你也可以打开Github上的 [issue](https://github.com/laradock/laradock/issues) (将被贴上问题和答案) 或与大家讨论 [Gitter](https://gitter.im/LaraDock/laradock). 你也可以打开 Github 上的 [issue](https://github.com/laradock/laradock/issues) (将被贴上问题和答案) 或与大家讨论 [Gitter](https://gitter.im/Laradock/laradock).
Docker或Laravel的特别帮助你可以在[Codementor.io](https://www.codementor.io/mahmoudz)上直接和项目创始人在线沟通 Docker Laravel 的特别帮助,你可以在 [Codementor.io](https://www.codementor.io/mahmoudz) 上直接和项目创始人在线沟通
## 关于作者 ## 关于作者

View File

@ -1,10 +1,12 @@
# Laradock ![](https://s19.postimg.org/jblfytw9f/laradock-logo.jpg)
[![Build Status](https://travis-ci.org/laradock/laradock.svg?branch=master)](https://travis-ci.org/laradock/laradock) [![GitHub issues](https://img.shields.io/github/issues/laradock/laradock.svg)](https://github.com/laradock/laradock/issues) [![GitHub forks](https://img.shields.io/github/forks/laradock/laradock.svg)](https://github.com/laradock/laradock/network) [![GitHub stars](https://img.shields.io/github/stars/laradock/laradock.svg)](https://github.com/laradock/laradock/stargazers) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/laradock/laradock/master/LICENSE)
> Use Docker first and learn about it later. > Use Docker first and learn about it later.
[![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me) A Docker PHP development environment that facilitates running **PHP** Apps on **Docker**.
Laradock is a Docker PHP development environment that facilitate running **PHP** Apps on **Docker**. [![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me)
## Documentation ## Documentation
@ -12,17 +14,18 @@ Laradock is a Docker PHP development environment that facilitate running **PHP**
## Credits ## Credits
**Super Admins:** **Maintainers:**
- [Mahmoud Zalt](https://github.com/Mahmoudz) (mahmoudz) [ [Twitter](https://twitter.com/Mahmoud_Zalt) | [Personal Site](http://zalt.me) | [LinkedIn](https://www.linkedin.com/in/mahmoudzalt) ] - [Mahmoud Zalt](https://github.com/Mahmoudz) @mahmoudz | [Twitter](https://twitter.com/Mahmoud_Zalt) | [Site](http://zalt.me)
- [Bo-Yi Wu](https://github.com/appleboy) (appleboy) [ [Twitter](https://twitter.com/appleboy) ] - [Bo-Yi Wu](https://github.com/appleboy) @appleboy | [Twitter](https://twitter.com/appleboy)
- [Philippe Trépanier](https://github.com/philtrep) (philtrep) - [Philippe Trépanier](https://github.com/philtrep) @philtrep
- [Mike Erickson](https://github.com/mikeerickson) (mikeerickson) - [Mike Erickson](https://github.com/mikeerickson) @mikeerickson
- Join Us! - [Dwi Fahni Denni](https://github.com/zeroc0d3) @zeroc0d3
- [Thor Erik](https://github.com/thorerik) @thorerik
**Amazing Contributors:** - [Winfried van Loon](https://github.com/winfried-van-loon) @winfried-van-loon
- [TJ Miller](https://github.com/sixlive) @sixlive
- [Contributors](https://github.com/laradock/laradock/graphs/contributors) - [Yu-Lung Shao (Allen)](https://github.com/bestlong) @bestlong
- Join Us.
## License ## License

View File

@ -1,213 +0,0 @@
#### Install Docker
```
Login Digital Ocean
Add Droplet
1 Click Install docker
Choose Droplet
reset ROOT password
check email
```
#### SSH to your Server
```
ssh root@ipaddress
```
you will be prompt of that password.
type the password you receive in your email
then it will ask to you to change a new password
just change it to the custom root password you want
After SSH
you can check that docker command is working by typing
```
$root@midascode:~# docker
```
#### Set Up Your Laravel Project
```
$root@midascode:~# apt-get install git
$root@midascode:~# git clone https://github.com/laravel/laravel
$root@midascode:~# cd laravel
$root@midascode:~/laravel/ git submodule add https://github.com/LaraDock/laradock.git
$root@midascode:~/laravel/ cd laradock
```
#### Install docker-compose command
```
$root@midascode:~/laravel/laradock# curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$root@midascode:~/chmod +x /usr/local/bin/docker-compose
```
#### Create Your LaraDock Containers
```
$root@midascode:~/laravel/laradock# docker-compose up -d nginx mysql
```
#### Go to Your Workspace
```
docker-compose exec workspace bash
```
#### Install laravel Dependencies, Add .env , generate Key and give proper permission certain folder
```
$ root@0e77851d27d3:/var/www# composer install
$ root@0e77851d27d3:/var/www# cp .env.example .env
$ root@0e77851d27d3:/var/www# php artisan key:generate
$ root@0e77851d27d3:/var/www# exit
$root@midascode:~/laravel/laradock# cd ..
$root@midascode:~/laravel# sudo chmod -R 777 storage bootstrap/cache
```
you can then view your laravel site at your ipaddress
for example
```
192.168.1.1
```
You will see there Laravel Default Welcome Page
but if you need to view on your custom domain name
which you would.
#### Using Your Own Domain Name
login to your DNS provider
Godaddy, Namecheap what ever...
And Point the Custom Domain Name Server to
```
ns1.digitalocean.com
ns2.digitalocean.com
ns3.digitalocean.com
```
In Your Digital Ocean Account go to
```
https://cloud.digitalocean.com/networking/domains
```
add your domain name and choose the server ip you provision earlier
#### Serve Site With NGINX (HTTP ONLY)
Go back to command line
```
$root@midascode:~/laravel/laradock# cd nginx
$root@midascode:~/laravel/laradock/nginx# vim laravel.conf
```
remove default_server
```
listen 80 default_server;
listen [::]:80 default_server ipv6only=on;
```
and add server_name (your custom domain)
```
listen 80;
listen [::]:80 ipv6only=on;
server_name yourdomain.com;
```
#### Rebuild Your Nginx
```
$root@midascode:~/laravel/laradock/nginx# docker-compose down
$root@midascode:~/laravel/laradock/nginx# docker-compose build nginx
```
#### Re Run Your Containers MYSQL and NGINX
```
$root@midascode:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
```
###### View Your Site with HTTP ONLY (http://yourdomain.com)
#### Run Site on SSL with Let's Encrypt Certificate
###### Note: You need to Use Caddy here Instead of Nginx
###### To go Caddy Folders and Edit CaddyFile
```
$root@midascode:~/laravel/laradock# cd caddy
$root@midascode:~/laravel/laradock/caddy# vim Caddyfile
```
Remove 0.0.0.0:80
```
0.0.0.0:80
root /var/www/public
```
and replace with your https://yourdomain.com
```
https://yourdomain.com
root /var/www/public
```
uncomment tls
```
#tls self-signed
```
and replace self-signed with your email address
```
tls midascodebreaker@gmai.com
```
This is needed Prior to Creating Let's Encypt
#### Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
```
$root@midascode:~/laravel/laradock/caddy# docker-compose up caddy
```
you will be prompt here to enter your email... you may enter it or not
```
Attaching to laradock_mysql_1, laradock_caddy_1
caddy_1 | Activating privacy features...
caddy_1 | Your sites will be served over HTTPS automatically using Let's Encrypt.
caddy_1 | By continuing, you agree to the Let's Encrypt Subscriber Agreement at:
caddy_1 | https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf
caddy_1 | Activating privacy features... done.
caddy_1 | https://yourdomain.com
caddy_1 | http://yourdomain.com
```
After it finish Press Ctrl + C to exit ...
#### Stop All Containers and ReRun Caddy and Other Containers on Background
```
$root@midascode:~/laravel/laradock/caddy# docker-compose down
$root@midascode:~/laravel/laradock/caddy# docker-compose up -d mysql caddy
```
View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)
##### Note that Certificate will be Automatically Renew By Caddy
>References:
>
- [https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04)
- [https://www.digitalocean.com/products/one-click-apps/docker/](https://www.digitalocean.com/products/one-click-apps/docker/)
- [https://docs.docker.com/engine/installation/linux/ubuntulinux/](https://docs.docker.com/engine/installation/linux/ubuntulinux/)
- [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
- [https://caddyserver.com/docs/automatic-https](https://caddyserver.com/docs/automatic-https)
- [https://caddyserver.com/docs/tls](https://caddyserver.com/docs/tls)
- [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)

View File

@ -1,302 +0,0 @@
# PHPStorm Debugging Guide
- [Intro](#Intro)
- [Installation](#Installation)
- [Customize laradock/docker-compose.yml](#CustomizeDockerCompose)
- [Clean House](#InstallCleanHouse)
- [LaraDock Dial Tone](#InstallLaraDockDialTone)
- [hosts](#AddToHosts)
- [Firewall](#FireWall)
- [Enable xDebug on php-fpm](#enablePhpXdebug)
- [PHPStorm Settings](#InstallPHPStorm)
- [Configs](#InstallPHPStormConfigs)
- [Usage](#Usage)
- [Laravel](#UsageLaravel)
- [Run ExampleTest](#UsagePHPStormRunExampleTest)
- [Debug ExampleTest](#UsagePHPStormDebugExampleTest)
- [Debug Web Site](#UsagePHPStormDebugSite)
- [SSH into workspace](#SSHintoWorkspace)
- [KiTTY](#InstallKiTTY)
<a name="Intro"></a>
## Intro
Wiring up [Laravel](https://laravel.com/), [LaraDock](https://github.com/LaraDock/laradock) [Laravel+Docker] and [PHPStorm](https://www.jetbrains.com/phpstorm/) to play nice together complete with remote xdebug'ing as icing on top! Although this guide is based on `PHPStorm Windows`,
you should be able to adjust accordingly. This guide was written based on Docker for Windows Native.
<a name="Installation"></a>
## Installation
- This guide assumes the following:
- you have already installed and are familiar with Laravel, LaraDock and PHPStorm.
- you have installed Laravel as a parent of `laradock`. This guide assumes `/c/_dk/laravel`.
<a name="AddToHosts"></a>
## hosts
- Add `laravel` to your hosts file located on Windows 10 at `C:\Windows\System32\drivers\etc\hosts`. It should be set to the IP of your running container. Mine is: `10.0.75.2`
On Windows you can find it by opening Windows `Hyper-V Manager`.
- ![Windows Hyper-V Manager](photos/PHPStorm/Settings/WindowsHyperVManager.png)
- [Hosts File Editor](https://github.com/scottlerch/HostsFileEditor) makes it easy to change your hosts file.
- Set `laravel` to your docker host IP. See [Example](photos/SimpleHostsEditor/AddHost_laravel.png).
<a name="FireWall"></a>
## Firewall
Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.
- It is important to note that if the Application PHPStorm is NOT enabled in the firewall, you will not be able to recreate a rule to override that.
- Also be aware that if you are installing/upgrade different versions of PHPStorm, you MAY have orphaned references to PHPStorm in your Firewall! You may decide to remove orphaned references however in either case, make sure that they are set to receive public TCP traffic.
### Edit laradock/docker-compose.yml
Set the following variables:
```
### Workspace Utilities Container ###########################
workspace:
build:
context: ./workspace
args:
- INSTALL_XDEBUG=true
- INSTALL_WORKSPACE_SSH=true
...
### PHP-FPM Container #######################################
php-fpm:
build:
context: ./php-fpm
args:
- INSTALL_XDEBUG=true
...
```
### Edit xdebug.ini files
- `laradock/workspace/xdebug.ini`
- `laradock/php-fpm/xdebug.ini`
Set the following variables:
```
xdebug.remote_autostart=1
xdebug.remote_enable=1
xdebug.remote_connect_back=1
xdebug.cli_color=1
```
<a name="InstallCleanHouse"></a>
### Need to clean house first?
Make sure you are starting with a clean state. For example, do you have other LaraDock containers and images?
Here are a few things I use to clean things up.
- Delete all containers using `grep laradock_` on the names, see: [Remove all containers based on docker image name](https://linuxconfig.org/remove-all-containners-based-on-docker-image-name).
`docker ps -a | awk '{ print $1,$2 }' | grep laradock_ | awk '{print $1}' | xargs -I {} docker rm {}`
- Delete all images containing `laradock`.
`docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}`
**Note:** This will only delete images that were built with `LaraDock`, **NOT** `laradock/*` which are pulled down by `LaraDock` such as `laradock/workspace`, etc.
**Note:** Some may fail with:
`Error response from daemon: conflict: unable to delete 3f38eaed93df (cannot be forced) - image has dependent child images`
- I added this to my `.bashrc` to remove orphaned images.
```
dclean() {
processes=`docker ps -q -f status=exited`
if [ -n "$processes" ]; thend
docker rm $processes
fi
images=`docker images -q -f dangling=true`
if [ -n "$images" ]; then
docker rmi $images
fi
}
```
- If you frequently switch configurations for LaraDock, you may find that adding the following and added to your `.bashrc` or equivalent useful:
```
# remove laravel* containers
# remove laravel_* images
dcleanlaradockfunction()
{
echo 'Removing ALL containers associated with laradock'
docker ps -a | awk '{ print $1,$2 }' | grep laradock | awk '{print $1}' | xargs -I {} docker rm {}
# remove ALL images associated with laradock_
# does NOT delete laradock/* which are hub images
echo 'Removing ALL images associated with laradock_'
docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}
echo 'Listing all laradock docker hub images...'
docker images | grep laradock
echo 'dcleanlaradock completed'
}
# associate the above function with an alias
# so can recall/lookup by typing 'alias'
alias dcleanlaradock=dcleanlaradockfunction
```
<a name="InstallLaraDockDialTone"></a>
#### Let's get a dial-tone with Laravel
```
# barebones at this point
docker-compose up -d nginx mysql
# run
docker-compose ps
# Should see:
Name Command State Ports
-----------------------------------------------------------------------------------------------------------
laradock_mysql_1 docker-entrypoint.sh mysqld Up 0.0.0.0:3306->3306/tcp
laradock_nginx_1 nginx Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp
laradock_php-fpm_1 php-fpm Up 9000/tcp
laradock_volumes_data_1 true Exit 0
laradock_volumes_source_1 true Exit 0
laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222->22/tcp
```
<a name="enablePhpXdebug"></a>
#### Enable xDebug on php-fpm
In a host terminal sitting in the laradock folder, run: `./xdebugPhpFpm status`
You should see something like the following:
```
xDebug status
laradock_php-fpm_1
PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS )
Copyright (c) 1997-2016 The PHP Group
Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies
with Xdebug v2.4.1, Copyright (c) 2002-2016, by Derick Rethans
```
Other commands include `./xdebugPhpFpm start | stop`.
If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will already be running when
`php-fpm` is started and listening for debug info on port 9000.
<a name="InstallPHPStormConfigs"></a>
#### PHPStorm Settings
- Here are some settings that are known to work:
- `Settings/BuildDeploymentConnection`
- ![Settings/BuildDeploymentConnection](photos/PHPStorm/Settings/BuildDeploymentConnection.png)
- `Settings/BuildDeploymentConnectionMappings`
- ![Settings/BuildDeploymentConnectionMappings](photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png)
- `Settings/BuildDeploymentDebugger`
- ![Settings/BuildDeploymentDebugger](photos/PHPStorm/Settings/BuildDeploymentDebugger.png)
- `Settings/EditRunConfigurationRemoteWebDebug`
- ![Settings/EditRunConfigurationRemoteWebDebug](photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png)
- `Settings/EditRunConfigurationRemoteExampleTestDebug`
- ![Settings/EditRunConfigurationRemoteExampleTestDebug](photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png)
- `Settings/LangsPHPDebug`
- ![Settings/LangsPHPDebug](photos/PHPStorm/Settings/LangsPHPDebug.png)
- `Settings/LangsPHPInterpreters`
- ![Settings/LangsPHPInterpreters](photos/PHPStorm/Settings/LangsPHPInterpreters.png)
- `Settings/LangsPHPPHPUnit`
- ![Settings/LangsPHPPHPUnit](photos/PHPStorm/Settings/LangsPHPPHPUnit.png)
- `Settings/LangsPHPServers`
- ![Settings/LangsPHPServers](photos/PHPStorm/Settings/LangsPHPServers.png)
- `RemoteHost`
To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`.
- ![RemoteHost](photos/PHPStorm/RemoteHost.png)
- `RemoteWebDebug`
- ![DebugRemoteOn](photos/PHPStorm/DebugRemoteOn.png)
- `EditRunConfigurationRemoteWebDebug`
Go to: `Menu/Run/Edit Configurations`.
- ![EditRunConfigurationRemoteWebDebug](photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png)
- `EditRunConfigurationRemoteExampleTestDebug`
Go to: `Menu/Run/Edit Configurations`.
- ![EditRunConfigurationRemoteExampleTestDebug](photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png)
- `WindowsFirewallAllowedApps`
Go to: `Control Panel\All Control Panel Items\Windows Firewall\Allowed apps`.
- ![WindowsFirewallAllowedApps.png](photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png)
- `hosts`
Edit: `C:\Windows\System32\drivers\etc\hosts`.
- ![WindowsFirewallAllowedApps.png](photos/PHPStorm/Settings/hosts.png)
- [Enable xDebug on php-fpm](#enablePhpXdebug)
<a name="Usage"></a>
## Usage
<a name="UsagePHPStormRunExampleTest"></a>
### Run ExampleTest
- right-click on `tests/ExampleTest.php`
- Select: `Run 'ExampleTest.php'` or `Ctrl+Shift+F10`.
- Should pass!! You just ran a remote test via SSH!
<a name="UsagePHPStormDebugExampleTest"></a>
### Debug ExampleTest
- Open to edit: `tests/ExampleTest.php`
- Add a BreakPoint on line 16: `$this->visit('/')`
- right-click on `tests/ExampleTest.php`
- Select: `Debug 'ExampleTest.php'`.
- Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
- ![Remote Test Debugging Success](photos/PHPStorm/RemoteTestDebuggingSuccess.png)
<a name="UsagePHPStormDebugSite"></a>
### Debug WebSite
- In case xDebug is disabled, from the `laradock` folder run:
`./xdebugPhpFpm start`.
- To switch xdebug off, run:
`./xdebugPhpFpm stop`
- Start Remote Debugging
- ![DebugRemoteOn](photos/PHPStorm/DebugRemoteOn.png)
- Open to edit: `bootstrap/app.php`
- Add a BreakPoint on line 14: `$app = new Illuminate\Foundation\Application(`
- Reload [Laravel Site](http://laravel/)
- Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
- ![Remote Debugging Success](photos/PHPStorm/RemoteDebuggingSuccess.png)
<a name="SSHintoWorkspace"></a>
#### Let's shell into workspace
Assuming that you are in laradock folder, type:
`ssh -i workspace/insecure_id_rsa -p2222 root@laravel`
**Cha Ching!!!!**
- `workspace/insecure_id_rsa.ppk` may become corrupted. In which case:
- fire up `puttygen`
- import `workspace/insecure_id_rsa`
- save private key to `workspace/insecure_id_rsa.ppk`
<a name="InstallKiTTY"></a>
##### KiTTY
[Kitty](http://www.9bis.net/kitty/) KiTTY is a fork from version 0.67 of PuTTY.
- Here are some settings that are working for me:
- ![Session](photos/KiTTY/Session.png)
- ![Terminal](photos/KiTTY/Terminal.png)
- ![Window](photos/KiTTY/Window.png)
- ![WindowAppearance](photos/KiTTY/WindowAppearance.png)
- ![Connection](photos/KiTTY/Connection.png)
- ![ConnectionData](photos/KiTTY/ConnectionData.png)
- ![ConnectionSSH](photos/KiTTY/ConnectionSSH.png)
- ![ConnectionSSHAuth](photos/KiTTY/ConnectionSSHAuth.png)
- ![TerminalShell](photos/KiTTY/TerminalShell.png)

12
adminer/Dockerfile Normal file
View File

@ -0,0 +1,12 @@
FROM adminer:4.3.0
# Version 4.3.1 contains PostgreSQL login errors. See docs.
# See https://sourceforge.net/p/adminer/bugs-and-features/548/
MAINTAINER Patrick Artounian <partounian@gmail.com>
# Add volume for sessions to allow session persistence
VOLUME /sessions
# We expose Adminer on port 8080 (Adminer's default)
EXPOSE 8080

View File

@ -6,11 +6,13 @@ ARG PHP_SOCKET=php-fpm:9000
ENV WEB_PHP_SOCKET=$PHP_SOCKET ENV WEB_PHP_SOCKET=$PHP_SOCKET
ENV WEB_DOCUMENT_ROOT=/var/www/public ENV WEB_DOCUMENT_ROOT=/var/www/public/
EXPOSE 80 443 EXPOSE 80 443
WORKDIR /var/www/public WORKDIR /var/www/public/
COPY vhost.conf /etc/apache2/sites-enabled/vhost.conf
ENTRYPOINT ["/opt/docker/bin/entrypoint.sh"] ENTRYPOINT ["/opt/docker/bin/entrypoint.sh"]

3
apache2/sites/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*.conf
!default.conf
!default.apache.conf

View File

@ -0,0 +1,16 @@
<VirtualHost *:80>
ServerName laradock.dev
DocumentRoot /var/www/public/
Options Indexes FollowSymLinks
<Directory "/var/www/public/">
AllowOverride All
<IfVersion < 2.4>
Allow from all
</IfVersion>
<IfVersion >= 2.4>
Require all granted
</IfVersion>
</Directory>
</VirtualHost>

View File

@ -0,0 +1,16 @@
<VirtualHost *:80>
ServerName sample.dev
DocumentRoot /var/www/sample/public/
Options Indexes FollowSymLinks
<Directory "/var/www/sample/public/">
AllowOverride All
<IfVersion < 2.4>
Allow from all
</IfVersion>
<IfVersion >= 2.4>
Require all granted
</IfVersion>
</Directory>
</VirtualHost>

1
apache2/vhost.conf Normal file
View File

@ -0,0 +1 @@
Include /etc/apache2/sites-available/*.conf

View File

@ -2,17 +2,17 @@ FROM alpine:3.4
MAINTAINER Eric Pfeiffer <computerfr33k@users.noreply.github.com> MAINTAINER Eric Pfeiffer <computerfr33k@users.noreply.github.com>
ENV caddy_version=0.9.5 ENV caddy_version=0.10.0
LABEL caddy_version="$caddy_version" architecture="amd64" LABEL caddy_version="$caddy_version" architecture="amd64"
RUN apk update \ RUN apk update \
&& apk upgrade \ && apk upgrade \
&& apk add tar curl && apk add tar curl git
RUN curl --silent --show-error --fail --location \ RUN curl --silent --show-error --fail --location \
--header "Accept: application/tar+gzip, application/x-gzip, application/octet-stream" -o - \ --header "Accept: application/tar+gzip, application/x-gzip, application/octet-stream" -o - \
"https://caddyserver.com/download/build?os=linux&arch=amd64&features=cloudflare%2Cdigitalocean%2Cdnsimple%2Cdyn%2Cgooglecloud%2Clinode%2Croute53" \ "https://caddyserver.com/download/linux/amd64?plugins=http.cgi,http.cors,http.expires,http.filemanager,http.git,http.ipfilter,http.realip,tls.dns.cloudflare,tls.dns.digitalocean,tls.dns.dnspod,tls.dns.dyn,tls.dns.googlecloud,tls.dns.linode,tls.dns.namecheap,tls.dns.ovh,tls.dns.route53,tls.dns.vultr" \
| tar --no-same-owner -C /usr/bin/ -xz caddy \ | tar --no-same-owner -C /usr/bin/ -xz caddy \
&& mv /usr/bin/caddy /usr/bin/caddy \ && mv /usr/bin/caddy /usr/bin/caddy \
&& chmod 0755 /usr/bin/caddy && chmod 0755 /usr/bin/caddy
@ -21,4 +21,4 @@ EXPOSE 80 443 2015
WORKDIR /var/www/public WORKDIR /var/www/public
CMD ["/usr/bin/caddy", "-conf", "/etc/Caddyfile"] CMD ["/usr/bin/caddy", "-conf", "/etc/Caddyfile"]

10
certbot/Dockerfile Normal file
View File

@ -0,0 +1,10 @@
FROM phusion/baseimage:latest
MAINTAINER Mahmoud Zalt <mahmoud@zalt.me>
COPY run-certbot.sh /root/certbot/run-certbot.sh
RUN apt-get update
RUN apt-get install -y letsencrypt
ENTRYPOINT bash -c "bash /root/certbot/run-certbot.sh && sleep infinity"

6
certbot/run-certbot.sh Normal file
View File

@ -0,0 +1,6 @@
#!/bin/bash
letsencrypt certonly --webroot -w /var/www/letsencrypt -d "$CN" --agree-tos --email "$EMAIL" --non-interactive --text
cp /etc/letsencrypt/archive/"$CN"/cert1.pem /var/certs/cert1.pem
cp /etc/letsencrypt/archive/"$CN"/privkey1.pem /var/certs/privkey1.pem

View File

@ -5,384 +5,622 @@ services:
### Applications Code Container ############################# ### Applications Code Container #############################
applications: applications:
image: tianon/true image: tianon/true
volumes: volumes:
- ../:/var/www - ${APPLICATION}:/var/www
# - ../sample/:/var/www/sample
### Workspace Utilities Container ########################### ### Workspace Utilities Container ###########################
workspace: workspace:
build: build:
context: ./workspace context: ./workspace
args: args:
- INSTALL_XDEBUG=false - INSTALL_XDEBUG=${WORKSPACE_INSTALL_XDEBUG}
- INSTALL_SOAP=false - INSTALL_BLACKFIRE=${INSTALL_BLACKFIRE}
- INSTALL_MONGO=false - INSTALL_SOAP=${WORKSPACE_INSTALL_SOAP}
- INSTALL_NODE=false - INSTALL_MONGO=${WORKSPACE_INSTALL_MONGO}
- INSTALL_YARN=false - INSTALL_MSSQL=${WORKSPACE_INSTALL_MSSQL}
- INSTALL_DRUSH=false - INSTALL_NODE=${WORKSPACE_INSTALL_NODE}
- INSTALL_AEROSPIKE_EXTENSION=false - INSTALL_YARN=${WORKSPACE_INSTALL_YARN}
- INSTALL_V8JS_EXTENSION=false - INSTALL_DRUSH=${WORKSPACE_INSTALL_DRUSH}
- COMPOSER_GLOBAL_INSTALL=false - INSTALL_AEROSPIKE=${WORKSPACE_INSTALL_AEROSPIKE}
- INSTALL_WORKSPACE_SSH=false - INSTALL_V8JS=${WORKSPACE_INSTALL_V8JS}
- INSTALL_LARAVEL_ENVOY=false - COMPOSER_GLOBAL_INSTALL=${WORKSPACE_COMPOSER_GLOBAL_INSTALL}
- INSTALL_DEPLOYER=false - INSTALL_WORKSPACE_SSH=${WORKSPACE_INSTALL_WORKSPACE_SSH}
- INSTALL_LINUXBREW=false - INSTALL_LARAVEL_ENVOY=${WORKSPACE_INSTALL_LARAVEL_ENVOY}
- INSTALL_MC=false - INSTALL_DEPLOYER=${WORKSPACE_INSTALL_DEPLOYER}
- PUID=1000 - INSTALL_LINUXBREW=${WORKSPACE_INSTALL_LINUXBREW}
- PGID=1000 - INSTALL_MC=${WORKSPACE_INSTALL_MC}
- NODE_VERSION=stable - PUID=${WORKSPACE_PUID}
- YARN_VERSION=latest - PGID=${WORKSPACE_PGID}
- TZ=UTC - NODE_VERSION=${WORKSPACE_NODE_VERSION}
volumes_from: - YARN_VERSION=${WORKSPACE_YARN_VERSION}
- applications - TZ=${WORKSPACE_TIMEZONE}
extra_hosts: - BLACKFIRE_CLIENT_ID=${BLACKFIRE_CLIENT_ID}
# IMPORTANT: Replace with your Docker Host IP (will be appended to /etc/hosts) - BLACKFIRE_CLIENT_TOKEN=${BLACKFIRE_CLIENT_TOKEN}
- "dockerhost:10.0.75.1" dockerfile: "Dockerfile-${PHP_VERSION}"
ports: volumes_from:
- "2222:22" - applications
tty: true extra_hosts:
- "dockerhost:${DOCKER_HOST_IP}"
ports:
- "${WORKSPACE_SSH_PORT}:22"
tty: true
networks:
- frontend
- backend
### PHP-FPM Container ####################################### ### PHP-FPM Container #######################################
php-fpm: php-fpm:
build: build:
context: ./php-fpm context: ./php-fpm
args: args:
- INSTALL_XDEBUG=false - INSTALL_XDEBUG=${PHP_FPM_INSTALL_XDEBUG}
- INSTALL_SOAP=false - INSTALL_BLACKFIRE=${INSTALL_BLACKFIRE}
- INSTALL_MONGO=false - INSTALL_SOAP=${PHP_FPM_INSTALL_SOAP}
- INSTALL_ZIP_ARCHIVE=false - INSTALL_MONGO=${PHP_FPM_INSTALL_MONGO}
- INSTALL_BCMATH=false - INSTALL_MSSQL=${PHP_FPM_INSTALL_MSSQL}
- INSTALL_PHPREDIS=false - INSTALL_ZIP_ARCHIVE=${PHP_FPM_INSTALL_ZIP_ARCHIVE}
- INSTALL_MEMCACHED=false - INSTALL_BCMATH=${PHP_FPM_INSTALL_BCMATH}
- INSTALL_OPCACHE=false - INSTALL_PHPREDIS=${PHP_FPM_INSTALL_PHPREDIS}
- INSTALL_EXIF=false - INSTALL_MEMCACHED=${PHP_FPM_INSTALL_MEMCACHED}
- INSTALL_AEROSPIKE_EXTENSION=false - INSTALL_OPCACHE=${PHP_FPM_INSTALL_OPCACHE}
- CODEIGNITER=false - INSTALL_EXIF=${PHP_FPM_INSTALL_EXIF}
dockerfile: Dockerfile-70 - INSTALL_AEROSPIKE=${PHP_FPM_INSTALL_AEROSPIKE}
volumes_from: - INSTALL_MYSQLI=${PHP_FPM_INSTALL_MYSQLI}
- applications - INSTALL_TOKENIZER=${PHP_FPM_INSTALL_TOKENIZER}
expose: - INSTALL_INTL=${PHP_FPM_INSTALL_INTL}
- "9000" - INSTALL_GHOSTSCRIPT=${PHP_FPM_INSTALL_GHOSTSCRIPT}
links: - INSTALL_LDAP=${PHP_FPM_INSTALL_LDAP}
- workspace - INSTALL_SWOOLE=${PHP_FPM_INSTALL_SWOOLE}
extra_hosts: dockerfile: "Dockerfile-${PHP_VERSION}"
# IMPORTANT: Replace with your Docker Host IP (will be appended to /etc/hosts) volumes_from:
- "dockerhost:10.0.75.1" - applications
environment: volumes:
# IMPORTANT: Set the Remote Interpreter entry matching name to `laravel` - ./php-fpm/php${PHP_VERSION}.ini:/usr/local/etc/php/php.ini
- PHP_IDE_CONFIG=serverName=laravel expose:
- "9000"
depends_on:
- workspace
extra_hosts:
- "dockerhost:${DOCKER_HOST_IP}"
environment:
- PHP_IDE_CONFIG=${PHP_IDE_CONFIG}
networks:
- backend
### PHP Worker Container #####################################
php-worker:
build:
context: ./php-worker
volumes_from:
- applications
depends_on:
- workspace
extra_hosts:
- "dockerhost:${DOCKER_HOST_IP}"
networks:
- backend
### Nginx Server Container ################################## ### Nginx Server Container ##################################
nginx: nginx:
build: build:
context: ./nginx context: ./nginx
args: args:
- PHP_UPSTREAM=php-fpm - PHP_UPSTREAM=php-fpm
volumes_from: volumes_from:
- applications - applications
volumes: volumes:
- ./logs/nginx/:/var/log/nginx - ${NGINX_HOST_LOG_PATH}:/var/log/nginx
- ./nginx/sites/:/etc/nginx/sites-available - ${NGINX_SITES_PATH}:/etc/nginx/sites-available
ports: ports:
- "80:80" - "${NGINX_HOST_HTTP_PORT}:80"
- "443:443" - "${NGINX_HOST_HTTPS_PORT}:443"
links: depends_on:
- php-fpm - php-fpm
networks:
- frontend
- backend
### Blackfire Container #################################
blackfire:
image: blackfire/blackfire
environment:
- BLACKFIRE_SERVER_ID=${BLACKFIRE_SERVER_ID}
- BLACKFIRE_SERVER_TOKEN=${BLACKFIRE_SERVER_TOKEN}
depends_on:
- php-fpm
networks:
- backend
### Apache Server Container ################################# ### Apache Server Container #################################
apache2: apache2:
build: build:
context: ./apache2 context: ./apache2
args: args:
- PHP_SOCKET=php-fpm:9000 - PHP_SOCKET=${PHP_SOCKET}
volumes_from: volumes_from:
- applications - applications
volumes: volumes:
- ./logs/apache2:/var/log/apache2 - ${APACHE_HOST_LOG_PATH}:/var/log/apache2
ports: - ./apache2/sites:/etc/apache2/sites-available
- "80:80" ports:
- "443:443" - "${APACHE_HOST_HTTP_PORT}:80"
links: - "${APACHE_HOST_HTTPS_PORT}:443"
- php-fpm depends_on:
- php-fpm
networks:
- frontend
- backend
### HHVM Container ########################################## ### HHVM Container ##########################################
hhvm: hhvm:
build: ./hhvm build: ./hhvm
volumes_from: volumes_from:
- applications - applications
expose: expose:
- "9000" - "9000"
links: depends_on:
- workspace - workspace
networks:
- frontend
- backend
### Minio Container ######################################### ### Minio Container #########################################
minio: minio:
build: ./minio build: ./minio
volumes: volumes:
- minio:/export - minio:/export
ports: ports:
- "9000:9000" - "${MINIO_PORT}:9000"
environment: environment:
MINIO_ACCESS_KEY: access - MINIO_ACCESS_KEY=access
MINIO_SECRET_KEY: secretkey - MINIO_SECRET_KEY=secretkey
networks:
- frontend
### MySQL Container ######################################### ### MySQL Container #########################################
mysql: mysql:
build: build:
context: ./mysql context: ./mysql
args: environment:
- MYSQL_DATABASE=homestead - MYSQL_DATABASE=${MYSQL_DATABASE}
- MYSQL_USER=homestead - MYSQL_USER=${MYSQL_USER}
- MYSQL_PASSWORD=secret - MYSQL_PASSWORD=${MYSQL_PASSWORD}
- MYSQL_ROOT_PASSWORD=root - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
volumes: volumes:
- mysql:/var/lib/mysql - ${DATA_SAVE_PATH}/mysql:/var/lib/mysql
ports: - ./mysql/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
- "3306:3306" ports:
- "${MYSQL_PORT}:3306"
networks:
- backend
### Percona Container #########################################
percona:
build:
context: ./percona
environment:
- MYSQL_DATABASE=${PERCONA_DATABASE}
- MYSQL_USER=${PERCONA_USER}
- MYSQL_PASSWORD=${PERCONA_PASSWORD}
- MYSQL_ROOT_PASSWORD=${PERCONA_ROOT_PASSWORD}
volumes:
- ${DATA_SAVE_PATH}/percona:/var/lib/mysql
- ./percona/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
ports:
- "${PERCONA_PORT}:3306"
networks:
- backend
### MSSQL Container #########################################
mssql:
build:
context: ./mssql
environment:
- MSSQL_DATABASE=${MSSQL_DATABASE}
- SA_PASSWORD=${MSSQL_PASSWORD}
- ACCEPT_EULA=Y
volumes:
- ${DATA_SAVE_PATH}/mssql:/var/opt/mssql
ports:
- "${MSSQL_PORT}:1433"
networks:
- backend
### MariaDB Container ####################################### ### MariaDB Container #######################################
mariadb: mariadb:
build: ./mariadb build: ./mariadb
volumes: volumes:
- mariadb:/var/lib/mysql - ${DATA_SAVE_PATH}/mariadb:/var/lib/mysql
ports: - ./mariadb/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
- "3306:3306" ports:
environment: - "${MARIADB_PORT}:3306"
MYSQL_DATABASE: homestead environment:
MYSQL_USER: homestead - MYSQL_DATABASE=${MARIADB_DATABASE}
MYSQL_PASSWORD: secret - MYSQL_USER=${MARIADB_USER}
MYSQL_ROOT_PASSWORD: root - MYSQL_PASSWORD=${MARIADB_PASSWORD}
- MYSQL_ROOT_PASSWORD=${MARIADB_ROOT_PASSWORD}
networks:
- backend
### PostgreSQL Container #################################### ### PostgreSQL Container ####################################
postgres: postgres:
build: ./postgres build: ./postgres
volumes: volumes:
- postgres:/var/lib/postgresql/data - ${DATA_SAVE_PATH}/postgres:/var/lib/postgresql/data
ports: ports:
- "5432:5432" - "${POSTGRES_PORT}:5432"
environment: environment:
POSTGRES_DB: homestead - POSTGRES_DB=${POSTGRES_DB}
POSTGRES_USER: homestead - POSTGRES_USER=${POSTGRES_USER}
POSTGRES_PASSWORD: secret - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
networks:
- backend
### PostgreSQL PostGis Container ############################ ### PostgreSQL PostGis Container ############################
postgres-postgis: postgres-postgis:
build: ./postgres-postgis build: ./postgres-postgis
volumes: volumes:
- postgres:/var/lib/postgresql/data - ${DATA_SAVE_PATH}/postgres:/var/lib/postgresql/data
ports: ports:
- "5432:5432" - "${POSTGRES_PORT}:5432"
environment: environment:
POSTGRES_DB: homestead - POSTGRES_DB=${POSTGRES_DB}
POSTGRES_USER: homestead - POSTGRES_USER=${POSTGRES_USER}
POSTGRES_PASSWORD: secret - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
networks:
- backend
### Neo4j Container ######################################### ### Neo4j Container #########################################
neo4j: neo4j:
build: ./neo4j build: ./neo4j
ports: ports:
- "7474:7474" - "7474:7474"
- "1337:1337" - "1337:1337"
environment: environment:
- NEO4J_AUTH=homestead:secret - NEO4J_AUTH=default:secret
volumes: volumes:
- neo4j:/var/lib/neo4j/data - ${DATA_SAVE_PATH}/neo4j:/var/lib/neo4j/data
networks:
- backend
### MongoDB Container ####################################### ### MongoDB Container #######################################
mongo: mongo:
build: ./mongo build: ./mongo
ports: ports:
- "27017:27017" - "${MONGODB_PORT}:27017"
volumes: volumes:
- mongo:/data/db - ${DATA_SAVE_PATH}/mongo:/data/db
networks:
- backend
### RethinkDB Container ####################################### ### RethinkDB Container #######################################
rethinkdb: rethinkdb:
build: ./rethinkdb build: ./rethinkdb
ports: ports:
- "8090:8080" - "${RETHINKDB_PORT}:8080"
volumes: volumes:
- rethinkdb:/data/rethinkdb_data - ${DATA_SAVE_PATH}/rethinkdb:/data/rethinkdb_data
networks:
- backend
### Redis Container ######################################### ### Redis Container #########################################
redis: redis:
build: ./redis build: ./redis
volumes: volumes:
- redis:/data - ${DATA_SAVE_PATH}/redis:/data
ports: ports:
- "6379:6379" - "6379:6379"
networks:
- backend
### Aerospike c Container ################################### ### Aerospike c Container ###################################
aerospike: aerospike:
build: ./aerospike build: ./aerospike
volumes_from: volumes_from:
- workspace - workspace
volumes: volumes:
- aerospike:/opt/aerospike/data - ${DATA_SAVE_PATH}/aerospike:/opt/aerospike/data
ports: ports:
- "3000:3000" - "${AEROSPIKE_SERVICE_PORT}:3000"
- "3001:3001" - "${AEROSPIKE_FABRIC_PORT}:3001"
- "3002:3002" - "${AEROSPIKE_HEARTBEAT_PORT}:3002"
- "3003:3003" - "${AEROSPIKE_INFO_PORT}:3003"
networks:
- backend
### Memcached Container ##################################### ### Memcached Container #####################################
memcached: memcached:
build: ./memcached build: ./memcached
volumes: volumes:
- memcached:/var/lib/memcached - ${DATA_SAVE_PATH}/memcached:/var/lib/memcached
ports: ports:
- "11211:11211" - "${MEMCACHED_HOST_PORT}:11211"
links: depends_on:
- php-fpm - php-fpm
networks:
- backend
### Beanstalkd Container #################################### ### Beanstalkd Container ####################################
beanstalkd: beanstalkd:
build: ./beanstalkd build: ./beanstalkd
ports: ports:
- "11300:11300" - "${BEANSTALKD_HOST_PORT}:11300"
privileged: true privileged: true
links: depends_on:
- php-fpm - php-fpm
networks:
- backend
### RabbitMQ Container ###################################### ### RabbitMQ Container ######################################
rabbitmq: rabbitmq:
build: ./rabbitmq build: ./rabbitmq
ports: ports:
- "5672:5672" - "${RABBITMQ_NODE_HOST_PORT}:5672"
- "15671:15671" - "${RABBITMQ_MANAGEMENT_HTTP_HOST_PORT}:15672"
- "8080:15672" - "${RABBITMQ_MANAGEMENT_HTTPS_HOST_PORT}:15671"
privileged: true privileged: true
environment: environment:
RABBITMQ_DEFAULT_USER: guest - RABBITMQ_DEFAULT_USER=${RABBITMQ_DEFAULT_USER}
RABBITMQ_DEFAULT_PASS: guest - RABBITMQ_DEFAULT_PASS=${RABBITMQ_DEFAULT_PASS}
links: depends_on:
- php-fpm - php-fpm
networks:
- backend
### Beanstalkd Console Container ############################ ### Beanstalkd Console Container ############################
beanstalkd-console: beanstalkd-console:
build: ./beanstalkd-console build: ./beanstalkd-console
ports: ports:
- "2080:2080" - "2080:2080"
links: depends_on:
- beanstalkd - beanstalkd
networks:
- backend
### Caddy Server Container ################################## ### Caddy Server Container ##################################
caddy: caddy:
build: ./caddy build: ./caddy
ports: volumes_from:
- "80:80" - applications
- "443:443" volumes:
- "2015:2015" - ${CADDY_CUSTOM_CADDYFILE}:/etc/Caddyfile
volumes_from: - ${CADDY_HOST_LOG_PATH}:/var/log/caddy
- applications - ${DATA_SAVE_PATH}:/root/.caddy
volumes: ports:
- ./caddy/Caddyfile:/etc/Caddyfile - "${CADDY_HOST_HTTP_PORT}:80"
- ./logs/caddy:/var/log/caddy - "${CADDY_HOST_HTTPS_PORT}:443"
- caddy:/root/.caddy depends_on:
links: - php-fpm
- php-fpm networks:
- frontend
- backend
### phpMyAdmin Container #################################### ### phpMyAdmin Container ####################################
phpmyadmin: phpmyadmin:
build: ./phpmyadmin build: ./phpmyadmin
environment: environment:
PMA_ARBITRARY: 1 - PMA_ARBITRARY=1
MYSQL_USER: homestead - MYSQL_USER=${PMA_USER}
MYSQL_PASSWORD: secret - MYSQL_PASSWORD=${PMA_PASSWORD}
MYSQL_ROOT_PASSWORD: root - MYSQL_ROOT_PASSWORD=${PMA_ROOT_PASSWORD}
ports: ports:
- "8080:80" - "${PMA_PORT}:80"
links: depends_on:
# for mysql container - "${PMA_DB_ENGINE}"
- "mysql:db" networks:
# for mariadb container - frontend
# - "mariadb:db" - backend
### Adminer Container ####################################
adminer:
build: ./adminer
ports:
- "${ADM_PORT}:8080"
depends_on:
- php-fpm
networks:
- frontend
- backend
### pgAdmin Container ####################################### ### pgAdmin Container #######################################
pgadmin: pgadmin:
build: ./pgadmin build: ./pgadmin
ports: ports:
- "5050:5050" - "5050:5050"
links: depends_on:
- postgres - postgres
networks:
- frontend
- backend
### ElasticSearch Container ################################# ### ElasticSearch Container #################################
elasticsearch: elasticsearch:
build: ./elasticsearch build: ./elasticsearch
volumes: volumes:
- elasticsearch-data:/usr/share/elasticsearch/data - elasticsearch-data:/usr/share/elasticsearch/data
- elasticsearch-plugins:/usr/share/elasticsearch/data - elasticsearch-plugins:/usr/share/elasticsearch/plugins
ports: ports:
- "9200:9200" - "${ELASTICSEARCH_HOST_HTTP_PORT}:9200"
- "9300:9300" - "${ELASTICSEARCH_HOST_TRANSPORT_PORT}:9300"
links: depends_on:
- php-fpm - php-fpm
networks:
- frontend
- backend
### Selenium Container ######################################### ### Certbot Container ##################################
certbot:
build:
context: ./certbot
volumes:
- ./data/certbot/certs/:/var/certs
- ./certbot/letsencrypt/:/var/www/letsencrypt
environment:
- CN="fake.domain.com"
- EMAIL="fake.email@gmail.com"
networks:
- frontend
### Mailhog Container #########################################
mailhog:
build: ./mailhog
ports:
- "1025:1025"
- "8025:8025"
networks:
- frontend
### Selenium Container ########################################
selenium: selenium:
build: ./selenium build: ./selenium
ports: ports:
- "4444:4444" - "${SELENIUM_PORT}:4444"
volumes: volumes:
# see https://github.com/SeleniumHQ/docker-selenium#running-the-images - /dev/shm:/dev/shm
- /dev/shm:/dev/shm networks:
- frontend
### Volumes Setup ########################################### ### Varnish Proxy 1 ##########################################
proxy:
build: ./varnish
expose:
- ${VARNISH_PORT}
environment:
- VARNISH_CONFIG=${VARNISH_CONFIG}
- CACHE_SIZE=${VARNISH_PROXY1_CACHE_SIZE}
- VARNISHD_PARAMS=${VARNISHD_PARAMS}
- VARNISH_PORT=${VARNISH_PORT}
- BACKEND_HOST=${VARNISH_PROXY1_BACKEND_HOST}
- BACKEND_PORT=${VARNISH_BACKEND_PORT}
- VARNISH_SERVER=${VARNISH_PROXY1_SERVER}
links:
- workspace
networks:
- frontend
### Varnish Proxy 2 ##########################################
proxy2:
build: ./varnish
expose:
- ${VARNISH_PORT}
environment:
- VARNISH_CONFIG=${VARNISH_CONFIG}
- CACHE_SIZE=${VARNISH_PROXY2_CACHE_SIZE}
- VARNISHD_PARAMS=${VARNISHD_PARAMS}
- VARNISH_PORT=${VARNISH_PORT}
- BACKEND_HOST=${VARNISH_PROXY2_BACKEND_HOST}
- BACKEND_PORT=${VARNISH_BACKEND_PORT}
- VARNISH_SERVER=${VARNISH_PROXY2_SERVER}
links:
- workspace
networks:
- frontend
### Balancer Haproxy ##########################################
balancer:
build: ./haproxy
ports:
- "${HAPROXY_HOST_HTTP_PORT}:8085"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
links:
- proxy
- proxy2
### Jenkins ###################################################
jenkins:
build: ./jenkins
environment:
JAVA_OPTS: "-Djava.awt.headless=true"
ports:
- "${JENKINS_HOST_SLAVE_AGENT_PORT}:50000"
- "${JENKINS_HOST_HTTP_PORT}:8080"
privileged: true
volumes:
- ${JENKINS_HOME}:/var/jenkins_home
- /var/run/docker.sock:/var/run/docker.sock
networks:
- frontend
- backend
### Networks Setup ############################################
networks:
frontend:
driver: "bridge"
backend:
driver: "bridge"
### Volumes Setup #############################################
volumes: volumes:
mysql: mysql:
driver: "local" driver: "local"
postgres: percona:
driver: "local" driver: "local"
memcached: mssql:
driver: "local" driver: "local"
redis: postgres:
driver: "local" driver: "local"
neo4j: memcached:
driver: "local" driver: "local"
mariadb: redis:
driver: "local" driver: "local"
mongo: neo4j:
driver: "local" driver: "local"
minio: mariadb:
driver: "local" driver: "local"
rethinkdb: mongo:
driver: "local" driver: "local"
phpmyadmin: minio:
driver: "local" driver: "local"
aerospike: rethinkdb:
driver: "local" driver: "local"
caddy: phpmyadmin:
driver: "local" driver: "local"
elasticsearch-data: adminer:
driver: "local" driver: "local"
elasticsearch-plugins: aerospike:
driver: "local" driver: "local"
sessions: ## nothing is connected to this (- ./data/sessions:/sessions) caddy:
driver: "local" driver: "local"
elasticsearch-data:
driver: "local"
elasticsearch-plugins:
driver: "local"

View File

@ -1,164 +0,0 @@
---
title: Contributing
type: index
weight: 6
---
Your contribution is more than welcome.
## Got a Question or Problem?
If you have questions about how to use LaraDock, please direct your questions to the discussion on [Gitter](https://gitter.im/LaraDock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
## Found an Issue?
If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
## Want a Feature?
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.
## Update Documentation (Site)
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
1. Install [Hugo](https://gohugo.io/) on your machine.
2. Clone laradock.
3. Go to `/docs`.
4. Delete everything except the `_settings` folder & the `CNAME` file.
5. Open `docs/_settings` from your terminal and run `hugo serve` to host the website locally.
6. Open the `docs/_settings/content` and search for the folder of the section you want to edit.
7. In each section there's an `index.md` file, that's the file you need to edit.
8. To edit the sidebar (in case you are adding new section) go to `docs/_settings/config.toml` and add the section there.
9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder.
10. Go back to the project root directory, commit and push..
## Coding Guidelines
## Support new Software
* Create folder with the software name.
* Add a `Dockerfile`, write your code there.
* You may add additional files in the software folder.
* Add the software to the `docker-compose.yml` file.
* Make sure you follow our commenting style.
* Add the software in the `Readme`.
## Edit existing Software
* Open the software (container) folder.
* Edit the files you want to update.
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.
* Make sure to update the `Readme` in case you made any changes.
## Issue/PR Submission Guidelines
## Submitting an Issue
Before you submit your issue search the archive, maybe your question was already answered.
If your issue appears to be a bug, and hasn't been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.
## Before Submitting a Pull Request (PR)
Always Test everything and make sure its working:
- Pull the latest updates (or fork of you dont have permission)
- Before editing anything:
- Test building the container (docker-compose build --no-cache container-name) build with no cache first.
- Test running the container with some other containers in real app and see of everything is working fine.
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
- Testing building the container (docker-compose build container-name) with no errors.
- Test it in real App.
## Submitting a PR
Consider the following guidelines:
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
* Make your changes in a new git branch:
```shell
git checkout -b my-fix-branch master
```
* Commit your changes using a descriptive commit message.
* Push your branch to GitHub:
```shell
git push origin my-fix-branch
```
* In GitHub, send a pull request to `laradock:master`.
* If we suggest changes then:
* Make the required updates.
* Commit your changes to your branch (e.g. `my-fix-branch`).
* Push the changes to your GitHub repository (this will update your Pull Request).
> If the PR gets too outdated we may ask you to rebase and force push to update the PR:
```shell
git rebase master -i
git push origin my-fix-branch -f
```
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.*
## After your PR is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete my-fix-branch
```
* Check out the master branch:
```shell
git checkout master -f
```
* Delete the local branch:
```shell
git branch -D my-fix-branch
```
* Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
<br>
## Happy Coding :)

View File

@ -1,181 +0,0 @@
---
title: Getting Started
type: index
weight: 2
---
## Requirements
- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/) `>= 1.12`
## Installation
Choose the setup the best suits your needs.
#### A) Setup for Single Project:
*(In case you want a Docker environment for each project)*
##### A.1) Setup environment in existing Project:
*(In case you already have a project, and you want to setup an environment to run it)*
1 - Clone this repository on your project root directory:
```bash
git submodule add https://github.com/Laradock/laradock.git
```
*Note 1: If you are not yet using Git for your PHP project, you can use `git clone https://github.com/Laradock/laradock.git` instead.*
*Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. [Check this](#keep-tracking-LaraDock)*
*Note 3: In this case the folder structure will be like this:*
```
- project1
- laradock
- project2
- laradock
```
##### A.2) Setup environment first then create project:
*(In case you don't have a project, and you want to create your project inside the Docker environment)*
1 - Clone this repository anywhere on your machine:
```bash
git clone https://github.com/laradock/laradock.git
```
Note: In this case the folder structure will be like this:
```
- projects
- laradock
- myProject
```
2 - Edit the `docker-compose.yml` file to map to your project directory once you have it (example: `- ../myProject:/var/www`).
3 - Stop and re-run your docker-compose command for the changes to take place.
```
docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ ....
```
#### B) Setup for Multiple Projects:
1 - Clone this repository anywhere on your machine:
```bash
git clone https://github.com/laradock/laradock.git
```
2 - Edit the `docker-compose.yml` file to map to your projects directories:
```
applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../project2/:/var/www/project2
```
3 - You can access all sites by visiting `http://localhost/project1/public` and `http://localhost/project2/public` but of course that's not very useful so let's setup NGINX quickly.
4 - Go to `nginx/sites` and copy `sample.conf.example` to `project1.conf` then to `project2.conf`
5 - Open the `project1.conf` file and edit the `server_name` and the `root` as follow:
```
server_name project1.dev;
root /var/www/project1/public;
```
Do the same for each project `project2.conf`, `project3.conf`,...
6 - Add the domains to the **hosts** files.
```
127.0.0.1 project1.dev
```
7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.
## Usage
**Read Before starting:**
If you are using **Docker Toolbox** (VM), do one of the following:
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading LaraDock](#upgrading-laradock)
- Use LaraDock v3.* (Visit the `LaraDock-ToolBox` [Branch](https://github.com/laradock/laradock/tree/LaraDock-ToolBox)).
<br>
>**Warning:** If you used an older version of LaraDock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent errors as much as possible.
<br>
1 - Run Containers: *(Make sure you are in the `laradock` folder before running the `docker-compose` commands).*
**Example:** Running NGINX and MySQL:
```bash
docker-compose up -d nginx mysql
```
**Note**: The `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command. If you couldn't find them running then you need specify them as follow: `docker-compose up -d nginx php-fpm mysql workspace`.
You can select your own combination of Containers form the list below:
`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `workspace`, `phpmyadmin`, `aerospike`, `pgadmin`, `elasticsearch`, `rethinkdb`.
<br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...).
```bash
docker-compose exec workspace bash
```
Alternatively, for Windows PowerShell users: execute the following command to enter any running container:
```bash
docker exec -it {workspace-container-id} bash
```
**Note:** You can add `--user=laradock` (example `docker-compose exec --user=laradock workspace bash`) to have files created as your host's user. (you can change the PUID (User id) and PGID (group id) variables from the `docker-compose.yml`).
<br>
3 - Edit your project configurations.
Open your `.env` file and set the `DB_HOST` to `mysql`:
```env
DB_HOST=mysql
```
*If you want to use Laravel and you don't have it installed yet, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
<br>
4 - Open your browser and visit your localhost address (`http://localhost/`).
<br>
**Debugging**: if you are facing any problem here check the [Debugging](#debugging) section.
If you need a special support. Contact me, more details in the [Help & Questions](#Help) section.

View File

@ -1,5 +0,0 @@
---
title: Welcome
type: index
weight: 0
---

View File

@ -1,197 +0,0 @@
---
title: Introduction
type: index
weight: 1
---
LaraDock strives to make the PHP development experience easier and faster.
It contains pre-packaged Docker Images that provides you a wonderful *development* environment without requiring you to install PHP, NGINX, MySQL, Redis, and any other software on your machines.
LaraDock is configured to run Laravel Apps by default, and it can be modified to run all kinds of PHP Apps (Symfony, CodeIgniter, WordPress, Drupal...).
## Quick Overview
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `beanstalkd`:
1 - Clone LaraDock inside your PHP project:
```shell
git clone https://github.com/Laradock/laradock.git
```
2 - Enter the laradock folder and run this command:
```shell
docker-compose up -d nginx mysql redis beanstalkd
```
3 - Open your `.env` file and set the following:
```shell
DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd
```
4 - Open your browser and visit localhost: `http://localhost`.
```shell
That's it! enjoy :)
```
<a name="what-is-docker"></a>
## What is Docker?
[Docker](https://www.docker.com) is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of [operating-system-level virtualization](https://en.wikipedia.org/wiki/Operating-system-level_virtualization) on Linux, Mac OS and Windows.
<a name="why-docker-not-vagrant"></a>
## Why Docker not Vagrant!?
[Vagrant](https://www.vagrantup.com) creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.
Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you **lightweight** Virtual Containers, that share the same kernel and allow to safely execute independent processes.
In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.
Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).
<a name="laradock-vs-homestead"></a>
## LaraDock VS Homestead (For Laravel Developers)
> LaraDock It's like Laravel Homestead but for Docker instead of Vagrant.
LaraDock and [Homestead](https://laravel.com/docs/master/homestead) both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).
- Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.
- LaraDock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.
Running a virtual container is much faster than running a full virtual Machine. Thus **LaraDock is much faster than Homestead**.
<a name="Demo"></a>
## Demo Video
What's better than a **Demo Video**:
- LaraDock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
- LaraDock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
- LaraDock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- LaraDock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
<a name="features"></a>
## Features
- Easy switch between PHP versions: 7.0, 5.6, 5.5...
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
- Run your own combination of software: Memcached, HHVM, Beanstalkd...
- Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI...
- Easy to customize any container, with simple edit to the `Dockerfile`.
- All Images extends from an official base Image. (Trusted base Images).
- Pre-configured NGINX for Laravel.
- Easy to apply configurations inside containers.
- Clean and well structured Dockerfiles (`Dockerfile`).
- Latest version of the Docker Compose file (`docker-compose`).
- Everything is visible and editable.
- Fast Images Builds.
- More to come every week..
<a name="Supported-Containers"></a>
## Supported Software (Containers)
- **Database Engines:**
- MySQL
- PostgreSQL
- MariaDB
- MongoDB
- Neo4j
- RethinkDB
- **Cache Engines:**
- Redis
- Memcached
- Aerospike
- **PHP Servers:**
- NGINX
- Apache2
- Caddy
- **PHP Compilers:**
- PHP-FPM
- HHVM
- **Message Queuing Systems:**
- Beanstalkd
- Beanstalkd Console
- RabbitMQ
- RabbitMQ Console
- **Tools:**
- PhpMyAdmin
- PgAdmin
- ElasticSearch
- Selenium
- Minio
- Workspace
- PHP7-CLI
- Composer
- Git
- Linuxbrew
- Node
- Gulp
- SQLite
- xDebug
- Envoy
- Deployer
- Vim
- Yarn
- ... Many other supported tools are not documented. (Will be updated soon)
>If you can't find your Software, build it yourself and add it to this list. Contributions are welcomed :)
<a name="Chat"></a>
## Chat with us
You are welcome to join our chat room on Gitter.
[![Gitter](https://badges.gitter.im/LaraDock/laradock.svg)](https://gitter.im/LaraDock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 KiB

View File

@ -1,638 +0,0 @@
<!DOCTYPE html>
<html class="no-js">
<head lang="en-us">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Contributing - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="description" content="Laradock documentations.">
<link rel="canonical" href="http://laradock.io/contributing/">
<meta name="author" content="Mahmoud Zalt">
<meta property="og:url" content="http://laradock.io/contributing/">
<meta property="og:title" content="Laradock">
<meta name="apple-mobile-web-app-title" content="Laradock">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="shortcut icon" type="image/x-icon" href="http://laradock.io/images/favicon.ico">
<link rel="icon" type="image/x-icon" href="http://laradock.io/images/favicon.ico">
<style>
@font-face {
font-family: 'Icon';
src: url('http://laradock.io/fonts/icon.eot');
src: url('http://laradock.io/fonts/icon.eot')
format('embedded-opentype'),
url('http://laradock.io/fonts/icon.woff')
format('woff'),
url('http://laradock.io/fonts/icon.ttf')
format('truetype'),
url('http://laradock.io/fonts/icon.svg')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="http://laradock.io/stylesheets/application.css">
<link rel="stylesheet" href="http://laradock.io/stylesheets/temporary.css">
<link rel="stylesheet" href="http://laradock.io/stylesheets/palettes.css">
<link rel="stylesheet" href="http://laradock.io/stylesheets/highlight/highlight.css">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Doctarine:400,700|Source&#43;Code&#43;Pro">
<style>
body, input {
font-family: 'Doctarine', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: 'Source Code Pro', 'Courier New', 'Courier', monospace;
}
</style>
<script src="http://laradock.io/javascripts/modernizr.js"></script>
</head>
<body class="palette-primary-deep-purple palette-accent-purple">
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>
<header class="header">
<nav aria-label="Header">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
<span></span>
</label>
</div>
<div class="stretch">
<div class="title">
<b>Laradock</b> <span style="color: rgba(249, 245, 255, 0.63);"> / Contributing</span>
</div>
</div>
<div class="button button-github" role="button" aria-label="GitHub">
<a style="padding: 0px; font-size:40px" href="https://github.com/laradock/laradock" title="@laradock/laradock on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
</div>
<p style="font-size: 18px; padding: 8px">Github</p>
</div>
<div class="bar search">
<div class="button button-close" role="button" aria-label="Close">
<label class="toggle-button icon icon-back" for="toggle-search"></label>
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>
</header>
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<div class="scrollable">
<div class="wrapper">
<div class="toc">
<ul>
<li>
<a title="Introduction" href="http://laradock.io/introduction/">
Introduction
</a>
</li>
<li>
<a title="Getting Started" href="http://laradock.io/getting-started/">
Getting Started
</a>
</li>
<li>
<a title="Documentation" href="http://laradock.io/documentation/">
Documentation
</a>
</li>
<li>
<a title="Related Projects" href="http://laradock.io/related-projects/">
Related Projects
</a>
</li>
<li>
<a title="Help &amp; Questions" href="http://laradock.io/help/">
Help &amp; Questions
</a>
</li>
<li>
<a class="current" title="Contributing" href="http://laradock.io/contributing/">
Contributing
</a>
<ul id="scrollspy">
</ul>
</li>
<li>
<a title="License" href="http://laradock.io/license/">
License
</a>
</li>
</ul>
<ul>
</ul>
</div>
</div>
</div>
</nav>
</div>
<article class="article">
<div class="wrapper">
<h1>Contributing </h1>
<p>Your contribution is more than welcome.</p>
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
<p>If you have questions about how to use LaraDock, please direct your questions to the discussion on <a href="https://gitter.im/LaraDock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
<h2 id="found-an-issue">Found an Issue?</h2>
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
<h2 id="want-a-feature">Want a Feature?</h2>
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
<ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
<li>Clone laradock.</li>
<li>Go to <code>/docs</code>.</li>
<li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li>
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
<li>In each section there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li>
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
<li>Go back to the project root directory, commit and push..</li>
</ol>
<h2 id="coding-guidelines">Coding Guidelines</h2>
<h2 id="support-new-software">Support new Software</h2>
<ul>
<li><p>Create folder with the software name.</p></li>
<li><p>Add a <code>Dockerfile</code>, write your code there.</p></li>
<li><p>You may add additional files in the software folder.</p></li>
<li><p>Add the software to the <code>docker-compose.yml</code> file.</p></li>
<li><p>Make sure you follow our commenting style.</p></li>
<li><p>Add the software in the <code>Readme</code>.</p></li>
</ul>
<h2 id="edit-existing-software">Edit existing Software</h2>
<ul>
<li><p>Open the software (container) folder.</p></li>
<li><p>Edit the files you want to update.</p></li>
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.</p></li>
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
</ul>
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
<h2 id="submitting-an-issue">Submitting an Issue</h2>
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.</p>
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
<p>Always Test everything and make sure its working:</p>
<ul>
<li>Pull the latest updates (or fork of you dont have permission)</li>
<li>Before editing anything:
<ul>
<li>Test building the container (docker-compose build &ndash;no-cache container-name) build with no cache first.</li>
<li>Test running the container with some other containers in real app and see of everything is working fine.</li>
</ul></li>
<li>Now edit the container (edit section by section and test rebuilding the container after every edited section)
<ul>
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
<li>Test it in real App.</li>
</ul></li>
</ul>
<h2 id="submitting-a-pr">Submitting a PR</h2>
<p>Consider the following guidelines:</p>
<ul>
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate effort.</p></li>
<li><p>Make your changes in a new git branch:</p>
<pre><code class="language-shell"> git checkout -b my-fix-branch master
</code></pre></li>
<li><p>Commit your changes using a descriptive commit message.</p></li>
<li><p>Push your branch to GitHub:</p>
<pre><code class="language-shell">git push origin my-fix-branch
</code></pre></li>
<li><p>In GitHub, send a pull request to <code>laradock:master</code>.</p></li>
<li><p>If we suggest changes then:</p>
<ul>
<li>Make the required updates.</li>
<li>Commit your changes to your branch (e.g. <code>my-fix-branch</code>).</li>
<li>Push the changes to your GitHub repository (this will update your Pull Request).</li>
</ul></li>
</ul>
<blockquote>
<p>If the PR gets too outdated we may ask you to rebase and force push to update the PR:</p>
</blockquote>
<pre><code class="language-shell">git rebase master -i
git push origin my-fix-branch -f
</code></pre>
<p><em>WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.</em></p>
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
<p>After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:</p>
<ul>
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
<pre><code class="language-shell">git push origin --delete my-fix-branch
</code></pre></li>
<li><p>Check out the master branch:</p>
<pre><code class="language-shell">git checkout master -f
</code></pre></li>
<li><p>Delete the local branch:</p>
<pre><code class="language-shell">git branch -D my-fix-branch
</code></pre></li>
<li><p>Update your master with the latest upstream version:</p>
<pre><code class="language-shell">git pull --ff upstream master
</code></pre></li>
</ul>
<p><br></p>
<h2 id="happy-coding">Happy Coding :)</h2>
<aside class="copyright" role="note">
Documentation built with
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
using the
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
</aside>
<footer class="footer">
<nav class="pagination" aria-label="Footer">
<div class="previous">
<a href="http://laradock.io/help/" title="Help &amp; Questions">
<span class="direction">
Previous
</span>
<div class="page">
<div class="button button-previous" role="button" aria-label="Previous">
<i class="icon icon-back"></i>
</div>
<div class="stretch">
<div class="title">
Help &amp; Questions
</div>
</div>
</div>
</a>
</div>
<div class="next">
<a href="http://laradock.io/license/" title="License">
<span class="direction">
Next
</span>
<div class="page">
<div class="stretch">
<div class="title">
License
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
<i class="icon icon-forward"></i>
</div>
</div>
</a>
</div>
</nav>
</footer>
</div>
</article>
<div class="results" role="status" aria-live="polite">
<div class="scrollable">
<div class="wrapper">
<div class="meta"></div>
<div class="list"></div>
</div>
</div>
</div>
</main>
<script>
var base_url = '';
var repo_id = '';
</script>
<script src="http://laradock.io/javascripts/application.js"></script>
<script>
/* Add headers to scrollspy */
var headers = document.getElementsByTagName("h2");
var scrollspy = document.getElementById('scrollspy');
if(scrollspy) {
if(headers.length > 0) {
for(var i = 0; i < headers.length; i++) {
var li = document.createElement("li");
li.setAttribute("class", "anchor");
var a = document.createElement("a");
a.setAttribute("href", "#" + headers[i].id);
a.setAttribute("title", headers[i].innerHTML);
a.innerHTML = headers[i].innerHTML;
li.appendChild(a)
scrollspy.appendChild(li);
}
} else {
scrollspy.parentElement.removeChild(scrollspy)
}
/* Add permanent link next to the headers */
var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
for(var i = 0; i < headers.length; i++) {
var a = document.createElement("a");
a.setAttribute("class", "headerlink");
a.setAttribute("href", "#" + headers[i].id);
a.setAttribute("title", "Permanent link")
a.innerHTML = "#";
headers[i].appendChild(a);
}
}
</script>
<script>
(function(i,s,o,g,r,a,m){
i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||
[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
m.parentNode.insertBefore(a,m)
})(window, document,
'script', '//www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-37514928-9', 'auto');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
var buttons = document.querySelectorAll('a');
Array.prototype.map.call(buttons, function(item) {
if (item.host != document.location.host) {
item.addEventListener('click', function() {
var action = item.getAttribute('data-action') || 'follow';
ga('send', 'event', 'outbound', action, item.href);
});
}
});
var query = document.querySelector('.query');
query.addEventListener('blur', function() {
if (this.value) {
var path = document.location.pathname;
ga('send', 'pageview', path + '?q=' + this.value);
}
});
</script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>

View File

@ -1,186 +0,0 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Contributings on Laradock</title>
<link>http://laradock.io/contributing/index.xml</link>
<description>Recent content in Contributings on Laradock</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<atom:link href="http://laradock.io/contributing/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Contributing</title>
<link>http://laradock.io/contributing/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://laradock.io/contributing/</guid>
<description>
&lt;p&gt;Your contribution is more than welcome.&lt;/p&gt;
&lt;h2 id=&#34;got-a-question-or-problem&#34;&gt;Got a Question or Problem?&lt;/h2&gt;
&lt;p&gt;If you have questions about how to use LaraDock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Question).&lt;/p&gt;
&lt;h2 id=&#34;found-an-issue&#34;&gt;Found an Issue?&lt;/h2&gt;
&lt;p&gt;If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;. Even better you can submit a Pull Request with a fix.&lt;/p&gt;
&lt;h2 id=&#34;want-a-feature&#34;&gt;Want a Feature?&lt;/h2&gt;
&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.&lt;/p&gt;
&lt;h2 id=&#34;update-documentation-site&#34;&gt;Update Documentation (Site)&lt;/h2&gt;
&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine.&lt;/li&gt;
&lt;li&gt;Clone laradock.&lt;/li&gt;
&lt;li&gt;Go to &lt;code&gt;/docs&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Delete everything except the &lt;code&gt;_settings&lt;/code&gt; folder &amp;amp; the &lt;code&gt;CNAME&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;Open &lt;code&gt;docs/_settings&lt;/code&gt; from your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/li&gt;
&lt;li&gt;Open the &lt;code&gt;docs/_settings/content&lt;/code&gt; and search for the folder of the section you want to edit.&lt;/li&gt;
&lt;li&gt;In each section there&amp;rsquo;s an &lt;code&gt;index.md&lt;/code&gt; file, that&amp;rsquo;s the file you need to edit.&lt;/li&gt;
&lt;li&gt;To edit the sidebar (in case you are adding new section) go to &lt;code&gt;docs/_settings/config.toml&lt;/code&gt; and add the section there.&lt;/li&gt;
&lt;li&gt;After done editing, run the this command &lt;code&gt;hugo&lt;/code&gt; to generate the updated site inside the &lt;code&gt;docs&lt;/code&gt; folder.&lt;/li&gt;
&lt;li&gt;Go back to the project root directory, commit and push..&lt;/li&gt;
&lt;/ol&gt;
&lt;h2 id=&#34;coding-guidelines&#34;&gt;Coding Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;support-new-software&#34;&gt;Support new Software&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Create folder with the software name.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add a &lt;code&gt;Dockerfile&lt;/code&gt;, write your code there.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;You may add additional files in the software folder.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add the software to the &lt;code&gt;docker-compose.yml&lt;/code&gt; file.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make sure you follow our commenting style.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Readme&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;edit-existing-software&#34;&gt;Edit existing Software&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Open the software (container) folder.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Edit the files you want to update.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you want to edit the base image of the &lt;code&gt;Workspace&lt;/code&gt; or the &lt;code&gt;php-fpm&lt;/code&gt; Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Readme&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;issue-pr-submission-guidelines&#34;&gt;Issue/PR Submission Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;submitting-an-issue&#34;&gt;Submitting an Issue&lt;/h2&gt;
&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered.&lt;/p&gt;
&lt;p&gt;If your issue appears to be a bug, and hasn&amp;rsquo;t been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.&lt;/p&gt;
&lt;h2 id=&#34;before-submitting-a-pull-request-pr&#34;&gt;Before Submitting a Pull Request (PR)&lt;/h2&gt;
&lt;p&gt;Always Test everything and make sure its working:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Pull the latest updates (or fork of you dont have permission)&lt;/li&gt;
&lt;li&gt;Before editing anything:
&lt;ul&gt;
&lt;li&gt;Test building the container (docker-compose build &amp;ndash;no-cache container-name) build with no cache first.&lt;/li&gt;
&lt;li&gt;Test running the container with some other containers in real app and see of everything is working fine.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;Now edit the container (edit section by section and test rebuilding the container after every edited section)
&lt;ul&gt;
&lt;li&gt;Testing building the container (docker-compose build container-name) with no errors.&lt;/li&gt;
&lt;li&gt;Test it in real App.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;submitting-a-pr&#34;&gt;Submitting a PR&lt;/h2&gt;
&lt;p&gt;Consider the following guidelines:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate effort.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make your changes in a new git branch:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt; git checkout -b my-fix-branch master
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Commit your changes using a descriptive commit message.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Push your branch to GitHub:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git push origin my-fix-branch
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;In GitHub, send a pull request to &lt;code&gt;laradock:master&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;If we suggest changes then:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Make the required updates.&lt;/li&gt;
&lt;li&gt;Commit your changes to your branch (e.g. &lt;code&gt;my-fix-branch&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;Push the changes to your GitHub repository (this will update your Pull Request).&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;blockquote&gt;
&lt;p&gt;If the PR gets too outdated we may ask you to rebase and force push to update the PR:&lt;/p&gt;
&lt;/blockquote&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git rebase master -i
git push origin my-fix-branch -f
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.&lt;/em&gt;&lt;/p&gt;
&lt;h2 id=&#34;after-your-pr-is-merged&#34;&gt;After your PR is merged&lt;/h2&gt;
&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git push origin --delete my-fix-branch
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Check out the master branch:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git checkout master -f
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Delete the local branch:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git branch -D my-fix-branch
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Update your master with the latest upstream version:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git pull --ff upstream master
&lt;/code&gt;&lt;/pre&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;h2 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h2&gt;
</description>
</item>
</channel>
</rss>

Some files were not shown because too many files have changed in this diff Show More