+
+
+## Sponsors
+
+
+
+
+
+## Contributors
+
+#### Core contributors:
+- [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)
+- [Philippe Trépanier](https://github.com/philtrep) @philtrep
+- [Mike Erickson](https://github.com/mikeerickson) @mikeerickson
+- [Dwi Fahni Denni](https://github.com/zeroc0d3) @zeroc0d3
+- [Thor Erik](https://github.com/thorerik) @thorerik
+- [Winfried van Loon](https://github.com/winfried-van-loon) @winfried-van-loon
+- [TJ Miller](https://github.com/sixlive) @sixlive
+- [Yu-Lung Shao (Allen)](https://github.com/bestlong) @bestlong
+- [Milan Urukalo](https://github.com/urukalo) @urukalo
+- [Vince Chu](https://github.com/vwchu) @vwchu
+- [Huadong Zuo](https://github.com/zuohuadong) @zuohuadong
+- Join us, by submitting 20 useful PR's.
+
+#### Awesome contributors:
+- See full list [here](https://github.com/apiato/apiato/graphs/contributors).
+
+
+## Donations
+
+> Help keeping the project development going, by [contributing](http://laradock.io/contributing) or donating a little.
+> Thanks in advance.
+
+Donate directly via [Paypal](https://www.paypal.me/mzalt)
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/mzalt)
+
+or show your support via [Beerpay](https://beerpay.io/laradock/laradock)
+
+[![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock)
+
+
+## License
+
+[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE)
diff --git a/.gitignore b/.gitignore
index 7c6f11b..702790a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,6 @@
.idea
/logs
/data
+.env
+/.project
+.docker-sync
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..7af8a7d
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,62 @@
+language: bash
+sudo: required
+services:
+ - docker
+
+env:
+ matrix:
+ - HUGO_VERSION=0.20.2
+
+ - 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 maildev selenium jenkins proxy proxy2 balancer"
+ - PHP_VERSION=70 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog maildev selenium jenkins proxy proxy2 balancer"
+ - PHP_VERSION=71 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog maildev selenium jenkins proxy proxy2 balancer"
+
+# Installing a newer Docker version
+before_install:
+ - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+ - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+ - sudo apt-get update
+ - sudo apt-get -y install docker-ce
+ - docker version
+
+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
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 1796032..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,140 +0,0 @@
-# Contributing to LaraDock
-
-Your contribution is more than welcome. Let's keep LaraDock amazing.
-
-
-### 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.
-
-
-## 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 Dockerfiles 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 don’t 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
- ```
-
-
-
-
-
-
-### Happy Coding :)
diff --git a/DOCUMENTATION/config.toml b/DOCUMENTATION/config.toml
new file mode 100644
index 0000000..74e4fa0
--- /dev/null
+++ b/DOCUMENTATION/config.toml
@@ -0,0 +1,97 @@
+baseurl = "http://laradock.io/"
+languageCode = "en-us"
+publishDir = "../docs"
+title = "Laradock"
+theme = "hugo-material-docs"
+metadataformat = "yaml"
+canonifyurls = true
+uglyurls = true
+# Enable Google Analytics by entering your tracking id
+googleAnalytics = "UA-37514928-9"
+
+[params]
+ # General information
+ author = "Mahmoud Zalt"
+ description = "Full PHP development environment for Docker."
+ copyright = ""
+
+ # Repository
+ provider = ""
+ repo_url = ""
+
+ version = ""
+ logo = "images/logo.png"
+ favicon = ""
+
+ permalink = "#"
+
+ # Custom assets
+ custom_css = []
+ custom_js = []
+
+ # Syntax highlighting theme
+ highlight_css = ""
+
+ [params.palette]
+ primary = "deep-purple"
+ accent = "purple"
+
+ [params.font]
+ text = "Doctarine"
+ code = "Source Code Pro"
+
+[social]
+ twitter = ""
+ github = "laradock/laradock"
+ email = ""
+
+# ------- MENU START -----------------------------------------
+
+[[menu.main]]
+ name = "Introduction"
+ url = "introduction/"
+ weight = 1
+
+[[menu.main]]
+ name = "Getting Started"
+ url = "getting-started/"
+ weight = 2
+
+[[menu.main]]
+ name = "Documentation"
+ url = "documentation/"
+ weight = 3
+
+[[menu.main]]
+ name = "Guides"
+ url = "guides/"
+ weight = 4
+
+[[menu.main]]
+ name = "Help & Questions"
+ url = "help/"
+ weight = 5
+
+[[menu.main]]
+ name = "Related Projects"
+ url = "related-projects/"
+ weight = 6
+
+[[menu.main]]
+ name = "Contributing"
+ url = "contributing/"
+ weight = 7
+
+[[menu.main]]
+ name = "License"
+ url = "license/"
+ weight = 8
+
+# ------- MENU END -----------------------------------------
+
+[blackfriday]
+ smartypants = true
+ fractions = true
+ smartDashes = true
+ plainIDAnchors = true
+
diff --git a/DOCUMENTATION/content/contributing/index.md b/DOCUMENTATION/content/contributing/index.md
new file mode 100644
index 0000000..94adc47
--- /dev/null
+++ b/DOCUMENTATION/content/contributing/index.md
@@ -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 you have an issue or you found a typo in the documentation, you can help us by
+opening 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 helps us 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)
+
+* Fork 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)
+
+* Fork 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+## 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 don’t 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
+ ```
+
+
+
+
+
+
+#### Happy Coding :)
diff --git a/README.md b/DOCUMENTATION/content/documentation/index.md
similarity index 53%
rename from README.md
rename to DOCUMENTATION/content/documentation/index.md
index 64bf4c7..113ca3c 100644
--- a/README.md
+++ b/DOCUMENTATION/content/documentation/index.md
@@ -1,474 +1,14 @@
-# LaraDock
-
-[![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)
-
-LaraDock is a Docker PHP development environment. It facilitate running **PHP** Apps on **Docker**.
-
->Use Docker first and learn about it later.
-
-
-
-
-
-
-
-## Intro
-
-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...).
-
-
-
-
-
-
-## Contents
-
-- [Readme Languages](#)
- - [English (Default)](#)
- - [Chinese](https://github.com/laradock/laradock/blob/master/README-zh.md)
-- [Intro](#Intro)
- - [Features](#features)
- - [Supported Software](#Supported-Containers)
- - [What is Docker](#what-is-docker)
- - [Why Docker not Vagrant](#why-docker-not-vagrant)
- - [LaraDock VS Homestead](#laradock-vs-homestead)
-- [Demo Video](#Demo)
-- [Requirements](#Requirements)
-- [Installation](#Installation)
-- [Usage](#Usage)
-- [Documentation](#Documentation)
- - [Docker](#Docker)
- - [List current running Containers](#List-current-running-Containers)
- - [Close all running Containers](#Close-all-running-Containers)
- - [Delete all existing Containers](#Delete-all-existing-Containers)
- - [Enter a Container (run commands in a running Container)](#Enter-Container)
- - [Edit default container configuration](#Edit-Container)
- - [Edit a Docker Image](#Edit-a-Docker-Image)
- - [Build/Re-build Containers](#Build-Re-build-Containers)
- - [Add more Software (Docker Images)](#Add-Docker-Images)
- - [View the Log files](#View-the-Log-files)
- - [PHP](#PHP)
- - [Install PHP Extensions](#Install-PHP-Extensions)
- - [Change the PHP-FPM Version](#Change-the-PHP-FPM-Version)
- - [Change the PHP-CLI Version](#Change-the-PHP-CLI-Version)
- - [Install xDebug](#Install-xDebug)
- - [Start/Stop xDebug](#Control-xDebug)
- - [Install Deployer](#Install-Deployer)
- - [Production](#Production)
- - [Prepare LaraDock for Production](#LaraDock-for-Production)
- - [Setup Laravel and Docker on Digital Ocean](#Digital-Ocean)
- - [Laravel](#Laravel):
- - [Install Laravel from a Docker Container](#Install-Laravel)
- - [Run Artisan Commands](#Run-Artisan-Commands)
- - [Run Laravel Queue Worker](#Run-Laravel-Queue-Worker)
- - [Use Redis](#Use-Redis)
- - [Use Mongo](#Use-Mongo)
- - [Use PhpMyAdmin](#Use-phpMyAdmin)
- - [Use PgAdmin](#Use-pgAdmin)
- - [Use Beanstalkd](#Use-Beanstalkd)
- - [Use ElasticSearch](#Use-ElasticSearch)
- - [Use Selenium](#Use-Selenium)
- - [Use RethinkDB](#Use-RethinkDB)
- - [CodeIgniter](#CodeIgniter):
- - [Install CodeIgniter](#Install-CodeIgniter)
- - [Misc](#Misc)
- - [Change the timezone](#Change-the-timezone)
- - [Adding cron jobs](#CronJobs)
- - [Access workspace via ssh](#Workspace-ssh)
- - [MySQL access from host](#MySQL-access-from-host)
- - [MySQL root access](#MySQL-root-access)
- - [Change MySQL port](#Change-MySQL-port)
- - [Use custom Domain](#Use-custom-Domain)
- - [Enable Global Composer Build Install](#Enable-Global-Composer-Build-Install)
- - [Install Prestissimo](#Install-Prestissimo)
- - [Install Node + NVM](#Install-Node)
- - [Install Node + YARN](#Install-Yarn)
- - [Install Linuxbrew](#Install-Linuxbrew)
- - [Common Terminal Aliases](#Common-Aliases)
- - [Install Aerospike extension](#Install-Aerospike-Extension)
- - [Install Laravel Envoy](#Install-Laravel-Envoy)
- - [PHPStorm Debugging Guide](#phpstorm-debugging)
- - [Keep track of your LaraDock changes](#keep-tracking-LaraDock)
- - [Upgrading LaraDock](#upgrading-laradock)
- - [Improve speed on MacOS](#Speed-MacOS)
- - [Common Problems](#Common-Problems)
-- [Related Projects](#related-projects)
-- [Help & Questions](#Help)
-
-
-
-
-
-### 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 :)
-```
-
-
-
-
-
-
-### 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..
-
-
-
-
-
-
-
-### 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
- - 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 :)
-
-
-
-
-
-
-
-### 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.
-
-
-
-
-
-
-
-### 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).
-
-
-
-
-
-
-
-### 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**.
-
-
-
-
-
-
-
-## 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)
-
-
-
-
-
-
-
-## 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)).
-
-
-
->**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.
-
-
-
-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`.
-
-
-
-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`).
-
-
-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).*
-
-
-4 - Open your browser and visit your localhost address (`http://localhost/`).
-
-
-**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.
-
-
-
-
-
-
-
-
-## Documentation
-
-
-
-
-
-
-
-
-
+---
+title: Documentation
+type: index
+weight: 3
+---
-### List current running Containers
+## List current running Containers
```bash
docker ps
```
@@ -485,7 +25,7 @@ docker-compose ps
-### Close all running Containers
+## Close all running Containers
```bash
docker-compose stop
```
@@ -503,7 +43,7 @@ docker-compose stop {container-name}
-### Delete all existing Containers
+## Delete all existing Containers
```bash
docker-compose down
```
@@ -515,7 +55,7 @@ docker-compose down
-### Enter a Container (run commands in a running Container)
+## Enter a Container (run commands in a running Container)
1 - First list the current running containers with `docker ps`
@@ -546,7 +86,7 @@ docker-compose exec mysql mysql -u homestead -psecret
-### Edit default container configuration
+## Edit default container configuration
Open the `docker-compose.yml` and change anything you want.
Examples:
@@ -574,7 +114,7 @@ Change Redis default port to 1111:
-### Edit a Docker Image
+## Edit a Docker Image
1 - Find the `Dockerfile` of the image you want to edit,
@@ -596,7 +136,7 @@ More info on Containers rebuilding [here](#Build-Re-build-Containers).
-### Build/Re-build Containers
+## Build/Re-build Containers
If you do any change to any `Dockerfile` make sure you run this command, for the changes to take effect:
@@ -615,10 +155,9 @@ You might use the `--no-cache` option if you want full rebuilding (`docker-compo
-
-### 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/).
@@ -629,15 +168,23 @@ To add an image (software), just edit the `docker-compose.yml` and add your cont
-### View the Log files
+## View the Log files
The NGINX Log file is stored in the `logs/nginx` directory.
However to view the logs of all the other containers (MySQL, PHP-FPM,...) you can run this:
```bash
-docker logs {container-name}
+docker-compose logs {container-name}
```
+```bash
+docker-compose logs -f {container-name}
+```
+
+More [options](https://docs.docker.com/compose/reference/logs/)
+
+
+
@@ -652,7 +199,7 @@ docker logs {container-name}
-### Install PHP Extensions
+## Install PHP Extensions
Before installing PHP extensions, you have to decide whether you need for the `FPM` or `CLI` because each lives on a different container, if you need it for both you have to edit both containers.
@@ -667,13 +214,13 @@ The PHP-CLI extensions should be installed in `workspace/Dockerfile`.
-### Change the (PHP-FPM) Version
+## Change the (PHP-FPM) Version
By default **PHP-FPM 7.0** is running.
>The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planning to run your application on different PHP-FPM version.
-#### A) Switch from PHP `7.0` to PHP `5.6`
+### A) Switch from PHP `7.0` to PHP `5.6`
1 - Open the `docker-compose.yml`.
@@ -685,7 +232,7 @@ By default **PHP-FPM 7.0** is running.
php-fpm:
build:
context: ./php-fpm
- dockerfile: Dockerfile-70
+ dockerfile: Dockerfile-56
...
```
@@ -698,7 +245,7 @@ docker-compose build php-fpm
> For more details about the PHP base image, visit the [official PHP docker images](https://hub.docker.com/_/php/).
-#### B) Switch from PHP `7.0` or `5.6` to PHP `5.5`
+### B) Switch from PHP `7.0` or `5.6` to PHP `5.5`
We do not natively support PHP 5.5 anymore, but you can get it in few steps:
@@ -721,7 +268,7 @@ We do not natively support PHP 5.5 anymore, but you can get it in few steps:
-### Change the PHP-CLI Version
+## Change the PHP-CLI Version
By default **PHP-CLI 7.0** is running.
>Note: it's not very essential to edit the PHP-CLI version. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.
@@ -737,7 +284,7 @@ Right now you have to manually edit the `Dockerfile` or create a new one like it
-### Install xDebug
+## Install xDebug
1 - First install `xDebug` in the Workspace and the PHP-FPM Containers:
@@ -768,9 +315,7 @@ It should be like this:
...
```
-2 - Re-build the containers `docker-compose build workspace php-fpm`
-
-3 - Open `laradock/workspace/xdebug.ini` and/or `laradock/php-fpm/xdebug.ini` and enable at least the following configurations:
+2 - Open `laradock/workspace/xdebug.ini` and `laradock/php-fpm/xdebug.ini` and enable at least the following configurations:
```
xdebug.remote_autostart=1
@@ -778,26 +323,41 @@ xdebug.remote_enable=1
xdebug.remote_connect_back=1
```
-For information on how to configure xDebug with your IDE and work it out, check this [Repository](https://github.com/LarryEitel/laravel-laradock-phpstorm).
+3 - Re-build the containers `docker-compose build workspace php-fpm`
+
+For information on how to configure xDebug with your IDE and work it out, check this [Repository](https://github.com/LarryEitel/laravel-laradock-phpstorm) or follow up on the next section if you use linux and PhpStorm.
+
+## Setup remote debugging for PhpStorm on Linux
+ - Make sure you have followed the steps above in the [Install Xdebug section](http://laradock.io/documentation/#install-xdebug).
+ - Make sure Xdebug accepts connections and listens on port 9000. (Should be default configuration).
+
+![Debug Configuration](/images/photos/PHPStorm/linux/configuration/debugConfiguration.png "Debug Configuration").
+
+ - Create a server with name `laradock` (matches **PHP_IDE_CONFIG** key in environment file) and make sure to map project root path with server correctly.
+
+![Server Configuration](/images/photos/PHPStorm/linux/configuration/serverConfiguration.png "Server Configuration").
+
+ - Start listening for debug connections, place a breakpoint and you are good to go !
-### Start/Stop xDebug:
+## Start/Stop xDebug:
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`.
-- Start xDebug by default: `./xdebugPhpFpm start`.
-- See the status: `./xdebugPhpFpm status`.
+- Stop xDebug from running by default: `.php-fpm/xdebug stop`.
+- Start xDebug by default: `.php-fpm/xdebug start`.
+- See the status: `.php-fpm/xdebug status`.
+
+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.
-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.
@@ -805,7 +365,7 @@ Note: If `./xdebugPhpFpm` doesn't execute and gives `Permission Denied` error th
-### Install Deployer (Deployment tool for PHP)
+## Install Deployer (Deployment tool for PHP)
1 - Open the `docker-compose.yml` file
@@ -827,7 +387,7 @@ It should be like this:
4 - Re-build the containers `docker-compose build workspace`
-######[Deployer Documentation Here](https://deployer.org/docs)
+[**Deployer Documentation Here**](https://deployer.org/docs)
@@ -842,10 +402,10 @@ It should be like this:
-
-### 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:
@@ -863,9 +423,9 @@ To learn more about how Docker publishes ports, please read [this excellent post
-### Setup Laravel and Docker on Digital Ocean
+## Setup Laravel and Docker on Digital Ocean
-####[Full Guide Here](https://github.com/laradock/laradock/blob/master/_guides/digital_ocean.md)
+### [Full Guide Here](https://github.com/laradock/laradock/blob/master/_guides/digital_ocean.md)
@@ -881,7 +441,7 @@ To learn more about how Docker publishes ports, please read [this excellent post
-### Install Laravel from a Docker Container
+## Install Laravel from a Docker Container
1 - First you need to enter the Workspace Container.
@@ -900,7 +460,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:
-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:
@@ -917,7 +477,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
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.
@@ -926,7 +486,7 @@ cd my-cool-app
-### Run Artisan Commands
+## Run Artisan Commands
You can run artisan commands and many other Terminal commands from the Workspace container.
@@ -970,7 +530,7 @@ phpunit
-### Run Laravel Queue Worker
+## Run Laravel Queue Worker
1 - First add `php-worker` container. It will be similar as like PHP-FPM Container.
@@ -981,11 +541,18 @@ b) add a new service container by simply copy-paste this section below PHP-FPM c
```yaml
php-worker:
build:
- context: ./php-fpm
- dockerfile: Dockerfile-70 # or Dockerfile-56, choose your PHP-FPM container setting
+ context: ./php-worker
+ dockerfile: "Dockerfile-${PHP_VERSION}" #Dockerfile-71 or #Dockerfile-70 available
+ args:
+ - INSTALL_PGSQL=${PHP_WORKER_INSTALL_PGSQL} #Optionally install PGSQL PHP drivers
volumes_from:
- applications
- command: php artisan queue:work
+ depends_on:
+ - workspace
+ extra_hosts:
+ - "dockerhost:${DOCKER_HOST_IP}"
+ networks:
+ - backend
```
2 - Start everything up
@@ -993,9 +560,13 @@ b) add a new service container by simply copy-paste this section below PHP-FPM c
docker-compose up -d php-worker
```
+
+
+
+
-### Use Redis
+## Use Redis
1 - First make sure you run the Redis Container (`redis`) with the `docker-compose up` command.
@@ -1003,13 +574,15 @@ docker-compose up -d php-worker
docker-compose up -d redis
```
+> To execute redis commands, enter the redis container first `docker-compose exec redis bash` then enter the `redis-cli`.
+
2 - Open your Laravel's `.env` file and set the `REDIS_HOST` to `redis`
```env
REDIS_HOST=redis
```
-If you don't find the `REDIS_HOST` variable in your `.env` file. Go to the database configuration file `config/database.php` and replace the default `127.0.0.1` IP with `redis` for Redis like this:
+If you're using Laravel, and you don't find the `REDIS_HOST` variable in your `.env` file. Go to the database configuration file `config/database.php` and replace the default `127.0.0.1` IP with `redis` for Redis like this:
```php
'redis' => [
@@ -1038,7 +611,7 @@ composer require predis/predis:^1.0
5 - You can manually test it from Laravel with this code:
```php
-\Cache::store('redis')->put('LaraDock', 'Awesome', 10);
+\Cache::store('redis')->put('Laradock', 'Awesome', 10);
```
@@ -1048,7 +621,7 @@ composer require predis/predis:^1.0
-### Use Mongo
+## Use Mongo
1 - First install `mongo` in the Workspace and the PHP-FPM Containers:
@@ -1139,7 +712,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-### Use PhpMyAdmin
+## Use PhpMyAdmin
1 - Run the phpMyAdmin Container (`phpmyadmin`) with the `docker-compose up` command. Example:
@@ -1151,6 +724,8 @@ docker-compose up -d mysql 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`
@@ -1158,9 +733,27 @@ docker-compose up -d mariadb phpmyadmin
+
+
+## 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`
+
+
+
+
+
-### Use PgAdmin
+## Use PgAdmin
1 - Run the pgAdmin Container (`pgadmin`) with the `docker-compose up` command. Example:
@@ -1177,7 +770,7 @@ docker-compose up -d postgres pgadmin
-### Use Beanstalkd
+## Use Beanstalkd
1 - Run the Beanstalkd Container:
@@ -1219,7 +812,7 @@ docker-compose up -d beanstalkd-console
-### Use ElasticSearch
+## Use ElasticSearch
1 - Run the ElasticSearch Container (`elasticsearch`) with the `docker-compose up` command:
@@ -1229,19 +822,20 @@ docker-compose up -d elasticsearch
2 - Open your browser and visit the localhost on port **9200**: `http://localhost:9200`
+> The default username is `user` and the default password is `changeme`.
-#### Install ElasticSearch Plugin
+### Install ElasticSearch Plugin
-1 - Install the ElasticSearch plugin like [delete-by-query](https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugins-delete-by-query.html).
+1 - Install an ElasticSearch plugin.
```bash
-docker exec {container-name} /usr/share/elasticsearch/bin/plugin install delete-by-query
+docker-compose exec elasticsearch /usr/share/elasticsearch/bin/plugin install {plugin-name}
```
2 - Restart elasticsearch container
```bash
-docker restart {container-name}
+docker-compose restart elasticsearch
```
@@ -1251,7 +845,7 @@ docker restart {container-name}
-### Use Selenium
+## Use Selenium
1 - Run the Selenium Container (`selenium`) with the `docker-compose up` command. Example:
@@ -1268,7 +862,7 @@ docker-compose up -d selenium
-### Use RethinkDB
+## Use RethinkDB
The RethinkDB is an open-source Database for Real-time Web ([RethinkDB](https://rethinkdb.com/)).
A package ([Laravel RethinkDB](https://github.com/duxet/laravel-rethinkdb)) is being developed and was released a version for Laravel 5.2 (experimental).
@@ -1307,7 +901,72 @@ docker-compose up -d rethinkdb
- set the `DB_DATABASE` to `database`.
+
+
+## Use Minio
+1 - Configure Minio:
+ - On the workspace container, change `INSTALL_MC` to true to get the client
+ - Set `MINIO_ACCESS_KEY` and `MINIO_ACCESS_SECRET` if you wish to set proper keys
+
+2 - Run the Minio Container (`minio`) with the `docker-compose up` command. Example:
+
+```bash
+docker-compose up -d minio
+```
+
+3 - Open your browser and visit the localhost on port **9000** at the following URL: `http://localhost:9000`
+
+4 - Create a bucket either through the webui or using the mc client:
+ ```bash
+ mc mb minio/bucket
+ ```
+
+5 - When configuring your other clients use the following details:
+ ```
+ S3_HOST=http://minio
+ S3_KEY=access
+ S3_SECRET=secretkey
+ S3_REGION=us-east-1
+ S3_BUCKET=bucket
+ ```
+
+
+
+
+
+## Use AWS
+
+1 - Configure AWS:
+ - make sure to add your SSH keys in aws/ssh_keys folder
+
+2 - Run the Aws Container (`aws`) with the `docker-compose up` command. Example:
+
+```bash
+docker-compose up -d aws
+```
+
+3 - Access the aws container with `docker-compose exec aws bash`
+
+4 - To start using eb cli inside the container, initiaze your project first by doing 'eb init'. Read the [aws eb cli](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-configuration.html) docs for more details.
+
+
+
+
+
+## Use Grafana
+
+1 - Configure Grafana: Change Port using `GRAFANA_PORT` if you wish to. Default is port 3000.
+
+2 - Run the Grafana Container (`grafana`) with the `docker-compose up`command:
+
+```bash
+docker-compose up -d grafana
+```
+
+3 - Open your browser and visit the localhost on port **3000** at the following URL: `http://localhost:3000`
+
+4 - Login using the credentials User = `admin` Passwort = `admin`. Change the password in the webinterface if you want to.
@@ -1321,9 +980,9 @@ docker-compose up -d rethinkdb
-### 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.
@@ -1332,9 +991,18 @@ To install CodeIgniter 3 on LaraDock all you have to do is the following simple
3 - Re-build your PHP-FPM Container `docker-compose build php-fpm`.
+
+## Install Symfony
+1 - Open the `.env` file and set `WORKSPACE_INSTALL_SYMFONY` to `true`.
+2 - Run `docker-compose build workspace`, after the step above.
+3 - The NGINX sites include a default config file for your Symfony project `symfony.conf.example`, so edit it and make sure the `root` is pointing to your project `web` directory.
+
+4 - Run `docker-compose restart` if the container was already running, before the step above.
+
+5 - Visit `symfony.dev`
@@ -1347,7 +1015,7 @@ To install CodeIgniter 3 on LaraDock all you have to do is the following simple
-### Change the timezone
+## Change the timezone
To change the timezone for the `workspace` container, modify the `TZ` build argument in the Docker Compose file to one in the [TZ database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
@@ -1371,7 +1039,7 @@ We also recommend [setting the timezone in Laravel](http://www.camroncade.com/ma
-### Adding cron jobs
+## Adding cron jobs
You can add your cron jobs to `workspace/crontab/root` after the `php artisan` line.
@@ -1391,7 +1059,7 @@ Make sure you [change the timezone](#Change-the-timezone) if you don't want to u
-### Access workspace via ssh
+## Access workspace via ssh
You can access the `workspace` container through `localhost:2222` by setting the `INSTALL_WORKSPACE_SSH` build argument to `true`.
@@ -1409,9 +1077,29 @@ To change the default forwarded port for ssh:
+
+
+## Change the (MySQL) Version
+By default **MySQL 8.0** is running.
+
+MySQL 8.0 is a development release. You may prefer to use the latest stable version, or an even older release. If you wish, you can change the MySQL image that is used.
+
+Open up your .env file and set the `MYSQL_VERSION` variable to the version you would like to install.
+
+```
+MYSQL_VERSION=5.7
+```
+
+Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See https://store.docker.com/images/mysql for more information.
+
+
+
+
+
+
-### MySQL access from host
+## MySQL access from host
You can forward the MySQL/MariaDB port to your host by making sure these lines are added to the `mysql` or `mariadb` section of the `docker-compose.yml` or in your [environment specific Compose](https://docs.docker.com/compose/extends/) file.
@@ -1427,7 +1115,7 @@ ports:
-### MySQL root access
+## MySQL root access
The default username and password for the root MySQL user are `root` and `root `.
@@ -1443,10 +1131,23 @@ The default username and password for the root MySQL user are `root` and `root `
+
+
+## Create Multiple Databases (MySQL)
+
+Create `createdb.sql` from `mysql/docker-entrypoint-initdb.d/createdb.sql.example` in `mysql/docker-entrypoint-initdb.d/*` and add your SQL syntax as follow:
+
+```sql
+CREATE DATABASE IF NOT EXISTS `your_db_1` COLLATE 'utf8_general_ci' ;
+GRANT ALL ON `your_db_1`.* TO 'mysql_user'@'%' ;
+```
+
+
+
-### Change MySQL port
+## Change MySQL port
Modify the `mysql/my.cnf` file to set your port number, `1234` is used as an example.
@@ -1464,7 +1165,7 @@ If you need MySQL access from your host, d
-### Use custom Domain (instead of the Docker IP)
+## Use custom Domain (instead of the Docker IP)
Assuming your custom domain is `laravel.dev`
@@ -1490,7 +1191,7 @@ server_name laravel.dev;
-### Enable Global Composer Build Install
+## Enable Global Composer Build Install
Enabling Global Composer Install during the build for the container allows you to get your composer requirements installed and available in the container after the build is done.
@@ -1519,7 +1220,7 @@ It should be like this:
-### Install Prestissimo
+## Install Prestissimo
[Prestissimo](https://github.com/hirak/prestissimo) is a plugin for composer which enables parallel install functionality.
@@ -1542,7 +1243,7 @@ c - Re-build the Workspace Container `docker-compose build workspace`
-### Install Node + NVM
+## Install Node + NVM
To install NVM and NodeJS in the Workspace container
@@ -1570,7 +1271,7 @@ It should be like this:
-### Install Node + YARN
+## Install Node + YARN
Yarn is a new package manager for JavaScript. It is so faster than npm, which you can find [here](http://yarnpkg.com/en/compare).To install NodeJS and [Yarn](https://yarnpkg.com/) in the Workspace container:
@@ -1599,7 +1300,7 @@ It should be like this:
-### Install Linuxbrew
+## Install Linuxbrew
Linuxbrew is a package manager for Linux. It is the Linux version of MacOS Homebrew and can be found [here](http://linuxbrew.sh). To install Linuxbrew in the Workspace container:
@@ -1627,8 +1328,8 @@ It should be like this:
-### 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.
+## 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.
You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements.
@@ -1638,17 +1339,17 @@ You are free to modify the `aliases.sh` as you see fit, adding your own aliases
-### Install Aerospike extension
+## Install Aerospike extension
1 - First install `aerospike` in the Workspace and the PHP-FPM Containers:
a) open the `docker-compose.yml` file
-b) search for the `INSTALL_AEROSPIKE_EXTENSION` argument under the Workspace Container
+b) search for the `INSTALL_AEROSPIKE` argument under the Workspace Container
c) set it to `true`
-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
e) set it to `true`
@@ -1659,13 +1360,13 @@ It should be like this:
build:
context: ./workspace
args:
- - INSTALL_AEROSPIKE_EXTENSION=true
+ - INSTALL_AEROSPIKE=true
...
php-fpm:
build:
context: ./php-fpm
args:
- - INSTALL_AEROSPIKE_EXTENSION=true
+ - INSTALL_AEROSPIKE=true
...
```
@@ -1678,7 +1379,7 @@ It should be like this:
-### Install Laravel Envoy (Envoy Task Runner)
+## Install Laravel Envoy (Envoy Task Runner)
1 - Open the `docker-compose.yml` file
@@ -1700,7 +1401,7 @@ It should be like this:
4 - Re-build the containers `docker-compose build workspace`
-######[Laravel Envoy Documentation Here](https://laravel.com/docs/5.3/envoy)
+[**Laravel Envoy Documentation Here**](https://laravel.com/docs/5.3/envoy)
@@ -1710,11 +1411,10 @@ It should be like this:
-### PHPStorm Debugging Guide
+## PHPStorm Debugging Guide
Remote debug Laravel web and phpunit tests.
-######[Debugging Guide Here](https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md)
-
+[**Debugging Guide Here**](https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md)
@@ -1723,10 +1423,10 @@ Remote debug Laravel web and phpunit tests.
-
-### 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.
3. Commit all your changes to your fork.
4. Pull new stuff from the main repository from time to time.
@@ -1736,59 +1436,206 @@ Remote debug Laravel web and phpunit tests.
+
-### 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}`
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`)
-4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`.
+3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
+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
`docker-compose build --no-cache`
"Warning Containers Data might be lost!"
+
+
+
+
+
+
+
+
-### 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.
-
-#### How to share files using NFS (d4m-nfs)
+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.
-[d4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one.
+So since sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:
- 1. Update docker File Sharing preferences. You should have only /tmp.
- 2. Restart docker.
- 3. Clone d4m-nfs repository in your home directory
- ```bash
- $ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
- ```
- 4. Edit/create the file ~/d4m-nfs/etc/d4m-nfs-mounts.txt with this configuration:
- ```
-/Users:/Users
-/Volumes:/Volumes
-/private:/private
- ```
- 5. Empty the file /etc/exports and clean it up if required (there may be collisions if you come from Vagrant or if you already executed the d4m-nfs.sh script)
- 6. Run the d4m-nfs.sh script
- ```bash
- ~/d4m-nfs/d4m-nfs.sh
- ```
-
-That's it! Now you just have to bring your container up with docker compose. For example:
+
+
+### Workaround A: using dinghy
+
+[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
+
+You can use the d4m-nfs solution in 2 ways, one is using the Laradock built it integration, and the other is using the tool separatly. Below is show case of both methods:
+
+
+#### B.1: using the built in d4m-nfs integration
+
+In simple terms, docker-sync creates a docker container with a copy of all the application files that can be accessed very quickly from the other containers.
+On the other hand, docker-sync runs a process on the host machine that continuously tracks and updates files changes from the host to this intermediate container.
+
+Out of the box, it comes pre-configured for OS X, but using it on Windows is very easy to set-up by modifying the `DOCKER_SYNC_STRATEGY` on the `.env`
+
+##### Usage
+
+Laradock comes with `sync.sh`, an optional bash script, that automates installing, running and stopping docker-sync. Note that to run the bash script you may need to change the permissions `chmod 755 sync.sh`
+
+1) Configure your Laradock environment as you would normally do and test your application to make sure that your sites are running correctly.
+
+2) Make sure to set `DOCKER_SYNC_STRATEGY` on the `.env`. Read the [syncing strategies](https://github.com/EugenMayer/docker-sync/wiki/8.-Strategies) for details.
+```
+# osx: 'native_osx' (default)
+# windows: 'unison'
+# linux: docker-sync not required
+
+DOCKER_SYNC_STRATEGY=native_osx
+```
+
+2) Install the docker-sync gem on the host-machine:
+```bash
+./sync.sh install
+```
+3) Start docker-sync and the Laradock environment.
+Specify the services you want to run, as you would normally do with `docker-compose up`
+```bash
+./sync.sh up nginx mysql
+```
+Please note that the first time docker-sync runs, it will copy all the files to the intermediate container and that may take a very long time (15min+).
+4) To stop the environment and docker-sync do:
+```bash
+./sync.sh down
+```
+
+##### Setting up Aliases (optional)
+
+You may create bash profile aliases to avoid having to remember and type these commands for everyday development.
+Add the following lines to your `~/.bash_profile`:
```bash
-docker-compose up -d nginx mysql
+alias devup="cd /PATH_TO_LARADOCK/laradock; ./sync.sh up nginx mysql" #add your services
+alias devbash="cd /PATH_TO_LARADOCK/laradock; ./sync.sh bash"
+alias devdown="cd /PATH_TO_LARADOCK/laradock; ./sync.sh down"
```
+Now from any location on your machine, you can simply run `devup`, `devbash` and `devdown`.
+
+
+##### Additional Commands
+
+Opening bash on the workspace container (to run artisan for example):
+ ```bash
+ ./sync.sh bash
+ ```
+Manually triggering the synchronization of the files:
+```bash
+./sync.sh sync
+```
+Removing and cleaning up the files and the docker-sync container. Use only if you want to rebuild or remove docker-sync completely. The files on the host will be kept untouched.
+```bash
+./sync.sh clean
+```
+
+
+##### Additional Notes
+
+- You may run laradock with or without docker-sync at any time using with the same `.env` and `docker-compose.yml`, because the configuration is overridden automatically when docker-sync is used.
+- You may inspect the `sync.sh` script to learn each of the commands and even add custom ones.
+- If a container cannot access the files on docker-sync, you may need to set a user on the Dockerfile of that container with an id of 1000 (this is the UID that nginx and php-fpm have configured on laradock). Alternatively, you may change the permissions to 777, but this is **not** recommended.
+
+Visit the [docker-sync documentation](https://github.com/EugenMayer/docker-sync/wiki) for more details.
+
+
+
+
+
+
+
+
+
+
+#### B.2: using the d4m-nfs tool
+
+[D4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one.
+
+1) Update the Docker [File Sharing] preferences:
+
+Click on the Docker Icon > Preferences > (remove everything form the list except `/tmp`).
+
+2) Restart Docker.
+
+3) Clone the [d4m-nfs](https://github.com/IFSight/d4m-nfs) repository to your `home` directory.
+
+```bash
+git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
+```
+
+4) Create (or edit) the file `~/d4m-nfs/etc/d4m-nfs-mounts.txt`, and write the follwing configuration in it:
+
+```txt
+/Users:/Users
+```
+
+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 (might need Sudo):
+
+```bash
+~/d4m-nfs/d4m-nfs.sh
+```
+
+That's it! Run your containers.. Example:
+
+```bash
+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.*
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-## Common Problems
+## Common Problems
*Here's a list of the common problems you might face, and the possible solutions.*
@@ -1797,8 +1644,9 @@ docker-compose up -d nginx mysql
+
-#### I see a blank (white) page instead of the Laravel 'Welcome' page!
+## I see a blank (white) page instead of the Laravel 'Welcome' page!
Run the following command from the Laravel root directory:
@@ -1811,7 +1659,7 @@ sudo chmod -R 777 storage bootstrap/cache
-#### I see "Welcome to nginx" instead of the Laravel App!
+## I see "Welcome to nginx" instead of the Laravel App!
Use `http://127.0.0.1` instead of `http://localhost` in your browser.
@@ -1820,7 +1668,7 @@ Use `http://127.0.0.1` instead of `http://localhost` in your browser.
-#### I see an error message containing `address already in use` or `port is already allocated`
+## I see an error message containing `address already in use` or `port is already allocated`
Make sure the ports for the services that you are trying to run (22, 80, 443, 3306, etc.) are not being used already by other programs on the host, such as a built in `apache`/`httpd` service or other development tools you have installed.
@@ -1829,7 +1677,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
-#### I get NGINX error 404 Not Found on Windows.
+## I get NGINX error 404 Not Found on Windows.
1. Go to docker Settings on your Windows machine.
2. Click on the `Shared Drives` tab and check the drive that contains your project files.
@@ -1839,16 +1687,19 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
+
-#### The time in my services does not match the current time
+## The time in my services does not match the current time
1. Make sure you've [changed the timezone](#Change-the-timezone).
2. Stop and rebuild the containers (`docker-compose up -d --build `)
+
+
-#### I get MySQL connection refused
+## I get MySQL connection refused
This error sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:
@@ -1856,82 +1707,8 @@ 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.
2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
* 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`
+## I get stuck when building nginx on `fetch http://mirrors.aliyun.com/alpine/v3.5/main/x86_64/APKINDEX.tar.gz`
-
-
-
-
-
-
-## Contributing
-
-This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else, do not hesitate to contribute, you are more than welcome :)
-
-#### Read the [Contribution Guidelines](https://github.com/laradock/laradock/blob/master/CONTRIBUTING.md).
-
-
-
-
-
-
-
-
-## Related Projects
-
-LaraDock related projects:
-* [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)
-* [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)
-
-These Docker Compose projects have piqued our interest:
-* [MageDock](https://github.com/ojhaujjwal/magedock) by [Ujjwal Ojha](https://github.com/ojhaujjwal)
-* [RubyDev-Dock](https://github.com/scudelletti/rubydev-dock) by [Diogo Scudelletti](https://github.com/scudelletti)
-* [NoDock](https://github.com/Osedea/nodock) by [Osedea](https://github.com/Osedea)
-
-If you want your project listed here, please open an issue.
-
-
-
-
-
-
-
-
-## Help & Questions
-
-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).
-
-For special help with Docker and/or Laravel, you can schedule a live call with the creator of this project at [Codementor.io](https://www.codementor.io/mahmoudz).
-
-
-
-
-
-
-## Credits
-
-**Super Admins:**
-
-- [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) ]
-- [Bo-Yi Wu](https://github.com/appleboy) (appleboy)
-- [Philippe Trépanier](https://github.com/philtrep) (philtrep)
-- [Mike Erickson](https://github.com/mikeerickson) (mikeerickson)
-- Join Us!
-
-**Amazing Contributors:**
-
-- [Contributors](https://github.com/laradock/laradock/graphs/contributors)
-
-
-
-
-
-
-## License
-
-[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT)
+As stated on [#749](https://github.com/laradock/laradock/issues/749#issuecomment-293296687), removing the line `RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.aliyun.com/' /etc/apk/repositories` from `nginx/Dockerfile` solves the problem.
diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md
new file mode 100644
index 0000000..cbbdfb6
--- /dev/null
+++ b/DOCUMENTATION/content/getting-started/index.md
@@ -0,0 +1,215 @@
+---
+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) Setup for Single Project
+> (Follow these steps if you want a separate Docker environment for each project)
+
+
+
+### 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.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.**
+
+
+
+### 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 `app.conf.example`, `laravel.conf.example` and `symfony.conf.example` as working samples.
+
+3 - change the default names `*.conf`:
+
+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.**
+
+
+
+
+
+
+
+
+## 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)*
+
+
+
+We recommend using a Docker version which is newer than 1.13.
+
+
+
+>**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.
+
+
+
+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).*
+
+
+
+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)*
+
+
+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).*
+
+
+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/`.
diff --git a/DOCUMENTATION/content/guides/index.md b/DOCUMENTATION/content/guides/index.md
new file mode 100644
index 0000000..ab74475
--- /dev/null
+++ b/DOCUMENTATION/content/guides/index.md
@@ -0,0 +1,885 @@
+---
+title: Guides
+type: index
+weight: 4
+---
+
+
+
+* [Production Setup on Digital Ocean](#Digital-Ocean)
+* [PHPStorm XDebug Setup](#PHPStorm-Debugging)
+* [Running Laravel Dusk Test](#Laravel-Dusk)
+
+
+
+
+# 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)
+
+
+
+
+
+
+
+
+
+
+
+
+# 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)
+
+
+## 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.
+
+
+## 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`.
+
+
+## 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).
+
+
+
+## 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
+```
+
+
+
+### 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
+```
+
+
+## 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
+```
+
+
+## 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.
+
+
+
+## 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)
+
+
+
+
+## Usage
+
+
+### 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!
+
+
+### 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)
+
+
+
+### 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)
+
+
+
+## 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`
+
+
+
+### 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)
+
+
+
+
+
+
+
+
+# Running Laravel Dusk Tests
+
+- [Option 1: Without Selenium](#option1-dusk)
+- [Option 2: With Selenium](#option2-dusk)
+
+
+## Option 1: Without Selenium
+
+- [Intro](#option1-dusk-intro)
+- [Workspace Setup](#option1-workspace-setup)
+- [Application Setup](#option1-application-setup)
+- [Choose Chrome Driver Version (Optional)](#option1-choose-chrome-driver-version)
+- [Run Dusk Tests](#option1-run-dusk-tests)
+
+
+### Intro
+
+This is a guide to run Dusk tests in your `workspace` container with headless
+google-chrome and chromedriver. It has been tested with Laravel 5.4 and 5.5.
+
+
+### Workspace Setup
+
+Update your .env with following entries:
+
+```
+...
+# Install Laravel installer bin to setup demo app
+WORKSPACE_INSTALL_LARAVEL_INSTALLER=true
+...
+# Install all the necessary dependencies for running Dusk tests
+WORKSPACE_INSTALL_DUSK_DEPS=true
+...
+```
+
+Then run below to build your workspace.
+
+```
+docker-compose build workspace
+```
+
+
+### Application Setup
+
+Run a `workspace` container and you will be inside the container at `/var/www` directory.
+
+```
+docker-compose run workspace bash
+
+/var/www#> _
+```
+
+Create new Laravel application named `dusk-test` and install Laravel Dusk package.
+
+```
+/var/www> laravel new dusk-test
+/var/www> cd dusk-test
+/var/www/dusk-test> composer require --dev laravel/dusk
+/var/www/dusk-test> php artisan dusk:install
+```
+
+Create `.env.dusk.local` by copying from `.env` file.
+
+```
+/var/www/dusk-test> cp .env .env.dusk.local
+```
+
+Update the `APP_URL` entry in `.env.dusk.local` to local Laravel server.
+
+```
+APP_URL=http://localhost:8000
+```
+
+You will need to run chromedriver with `headless` and `no-sandbox` flag. In Laravel Dusk 2.x it is
+already set `headless` so you just need to add `no-sandbox` flag. If you on previous version 1.x,
+you will need to update your `DustTestCase#driver` as shown below.
+
+
+```
+addArguments([
+ '--disable-gpu',
+ '--headless',
+ '--no-sandbox'
+ ]);
+
+ return RemoteWebDriver::create(
+ 'http://localhost:9515', DesiredCapabilities::chrome()->setCapability(
+ ChromeOptions::CAPABILITY, $options
+ )
+ );
+ }
+}
+```
+
+
+### Choose Chrome Driver Version (Optional)
+
+You could choose to use either:
+
+1. Chrome Driver shipped with Laravel Dusk. (Default)
+2. Chrome Driver installed in `workspace` container. (Required tweak on DuskTestCase class)
+
+For Laravel 2.x, you need to update `DuskTestCase#prepare` method if you wish to go with option #2.
+
+```
+
+setPrefix('chromedriver')
+ ->getProcess()
+ ->setEnv(static::chromeEnvironment());
+ }
+
+ ...
+}
+```
+
+
+### Run Dusk Tests
+
+Run local server in `workspace` container and run Dusk tests.
+
+```
+# alias to run Laravel server in the background (php artisan serve --quiet &)
+/var/www/dusk-test> serve
+# alias to run Dusk tests (php artisan dusk)
+/var/www/dusk-test> dusk
+
+PHPUnit 6.4.0 by Sebastian Bergmann and contributors.
+
+. 1 / 1 (100%)
+
+Time: 837 ms, Memory: 6.00MB
+```
+
+
+## Option 2: With Selenium
+
+- [Intro](#dusk-intro)
+- [DNS Setup](#dns-setup)
+- [Docker Compose Setup](#docker-compose)
+- [Laravel Dusk Setup](#laravel-dusk-setup)
+- [Running Laravel Dusk Tests](#running-tests)
+
+
+### Intro
+Setting up Laravel Dusk tests to run with Laradock appears be something that
+eludes most Laradock users. This guide is designed to show you how to wire them
+up to work together. This guide is written with macOS and Linux in mind. As such,
+it's only been tested on macOS. Feel free to create pull requests to update the guide
+for Windows-specific instructions.
+
+This guide assumes you know how to use a DNS forwarder such as `dnsmasq` or are comfortable
+with editing the `/etc/hosts` file for one-off DNS changes.
+
+
+### DNS Setup
+According to RFC-2606, only four TLDs are reserved for local testing[^1]:
+
+- `.test`
+- `.example`
+- `.invalid`
+- `.localhost`
+
+A common TLD used for local development is `.dev`, but newer versions of Google
+Chrome (such as the one bundled with the Selenium Docker image), will fail to
+resolve that DNS as there will appear to be a name collision.
+
+The recommended extension is `.test` for your Laravel web apps because you're
+running tests. Using a DNS forwarder such as `dnsmasq` or by editing the `/etc/hosts`
+file, configure the host to point to `localhost`.
+
+For example, in your `/etc/hosts` file:
+```
+##
+# Host Database
+#
+# localhost is used to configure the loopback interface
+# when the system is booting. Do not change this entry.
+##
+127.0.0.1 localhost
+255.255.255.255 broadcasthost
+::1 localhost
+127.0.0.1 myapp.test
+```
+
+This will ensure that when navigating to `myapp.test`, it will route the
+request to `127.0.0.1` which will be handled by Nginx in Laradock.
+
+
+### Docker Compose setup
+In order to make the Selenium container talk to the Nginx container appropriately,
+the `docker-compose.yml` needs to be edited to accommodate this. Make the following
+changes:
+
+```yaml
+...
+selenium:
+ ...
+ depends_on:
+ - nginx
+ links:
+ - nginx:
+```
+
+This allows network communication between the Nginx and Selenium containers
+and it also ensures that when starting the Selenium container, the Nginx
+container starts up first unless it's already running. This allows
+the Selenium container to make requests to the Nginx container, which is
+necessary for running Dusk tests. These changes also link the `nginx` environment
+variable to the domain you wired up in your hosts file.
+
+
+### Laravel Dusk Setup
+
+In order to make Laravel Dusk make the proper request to the Selenium container,
+you have to edit the `DuskTestCase.php` file that's provided on the initial
+installation of Laravel Dusk. The change you have to make deals with the URL the
+Remote Web Driver attempts to use to set up the Selenium session.
+
+One recommendation for this is to add a separate config option in your `.env.dusk.local`
+so it's still possible to run your Dusk tests locally should you want to.
+
+#### .env.dusk.local
+```
+...
+USE_SELENIUM=true
+```
+
+#### DuskTestCase.php
+```php
+abstract class DuskTestCase extends BaseTestCase
+{
+...
+ protected function driver()
+ {
+ if (env('USE_SELENIUM', 'false') == 'true') {
+ return RemoteWebDriver::create(
+ 'http://selenium:4444/wd/hub', DesiredCapabilities::chrome()
+ );
+ } else {
+ return RemoteWebDriver::create(
+ 'http://localhost:9515', DesiredCapabilities::chrome()
+ );
+ }
+ }
+}
+```
+
+
+### Running Laravel Dusk Tests
+
+Now that you have everything set up, to run your Dusk tests, you have to SSH
+into the workspace container as you normally would:
+```docker-compose exec --user=laradock workspace bash```
+
+Once inside, you can change directory to your application and run:
+
+```php artisan dusk```
+
+One way to make this easier from your project is to create a helper script. Here's one such example:
+```bash
+#!/usr/bin/env sh
+
+LARADOCK_HOME="path/to/laradock"
+
+pushd ${LARADOCK_HOME}
+
+docker-compose exec --user=laradock workspace bash -c "cd my-project && php artisan dusk && exit"
+```
+
+This invokes the Dusk command from inside the workspace container but when the script completes
+execution, it returns your session to your project directory.
+
+[^1]: [Don't Use .dev for Development](https://iyware.com/dont-use-dev-for-development/)
diff --git a/DOCUMENTATION/content/help/index.md b/DOCUMENTATION/content/help/index.md
new file mode 100644
index 0000000..3f2342d
--- /dev/null
+++ b/DOCUMENTATION/content/help/index.md
@@ -0,0 +1,9 @@
+---
+title: Help & Questions
+type: index
+weight: 5
+---
+
+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).
diff --git a/DOCUMENTATION/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md
new file mode 100644
index 0000000..eda748c
--- /dev/null
+++ b/DOCUMENTATION/content/introduction/index.md
@@ -0,0 +1,195 @@
+---
+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 :)
+```
+
+
+
+
+
+## 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..
+
+
+
+
+
+## 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.
+- **Database Management:**
+PhpMyAdmin - Adminer - PgAdmin
+- **Cache Engines:**
+Redis - Memcached - Aerospike
+- **PHP Servers:**
+NGINX - Apache2 - Caddy
+- **PHP Compilers:**
+PHP FPM - HHVM
+- **Message Queueing:**
+Beanstalkd - RabbitMQ - PHP Worker
+- **Queueing Management:**
+Beanstalkd Console - RabbitMQ Console
+- **Random Tools:**
+HAProxy - Certbot - Blackfire - Selenium - Jenkins - ElasticSearch - Kibana - Grafana - Mailhog - MailDev - Minio - Varnish - Swoole - Laravel Echo...
+
+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 :)
+
+
+
+## Sponsors
+
+
+
+
+
+
+
+
+## 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 Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.
+
+
+
+
+
+
+## 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).
+
+
+
+
+
+
+
+## Demo Video
+
+What's better than a **Demo Video**:
+
+- Laradock v5.* (should be next!)
+- 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)
+
+
+
+
+
+
+
+
+## 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)
+
+
+
+
+
+
+## Donations
+
+> Help keeping the project development going, by [contributing](http://laradock.io/contributing) or donating a little.
+> Thanks in advance.
+
+Donate directly via [Paypal](https://www.paypal.me/mzalt)
+
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/mzalt)
+
+or show your support via [Beerpay](https://beerpay.io/laradock/laradock)
+
+[![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock)
diff --git a/DOCUMENTATION/content/license/index.md b/DOCUMENTATION/content/license/index.md
new file mode 100644
index 0000000..795d4c8
--- /dev/null
+++ b/DOCUMENTATION/content/license/index.md
@@ -0,0 +1,7 @@
+---
+title: License
+type: index
+weight: 8
+---
+
+[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT)
diff --git a/DOCUMENTATION/content/related-projects/index.md b/DOCUMENTATION/content/related-projects/index.md
new file mode 100644
index 0000000..de7d0cd
--- /dev/null
+++ b/DOCUMENTATION/content/related-projects/index.md
@@ -0,0 +1,18 @@
+---
+title: Related Projects
+type: index
+weight: 6
+---
+
+Laradock related projects:
+
+* [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)
+* [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)
+These Docker Compose projects have piqued our interest:
+* [MageDock](https://github.com/ojhaujjwal/magedock) by [Ujjwal Ojha](https://github.com/ojhaujjwal)
+* [RubyDev-Dock](https://github.com/scudelletti/rubydev-dock) by [Diogo Scudelletti](https://github.com/scudelletti)
+* [NoDock](https://github.com/Osedea/nodock) by [Osedea](https://github.com/Osedea)
+
+If you want your project listed here, please open an issue.
diff --git a/DOCUMENTATION/static/CNAME b/DOCUMENTATION/static/CNAME
new file mode 100644
index 0000000..df75fb6
--- /dev/null
+++ b/DOCUMENTATION/static/CNAME
@@ -0,0 +1 @@
+laradock.io
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md b/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md
new file mode 100644
index 0000000..04cec42
--- /dev/null
+++ b/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md
@@ -0,0 +1,29 @@
+# Changelog
+
+
+### 11th May 2016
+
+#### Add templates for section lists
+
+Sections such as www.example.com/foo/ will now be rendered with a list of all pages that are part of this section. The list shows the pages' title and a summary of their content.
+
+[Show me the diff](https://github.com/digitalcraftsman/hugo-material-docs/commit/1f8393a8d4ce1b8ee3fc7d87be05895c12810494)
+
+### 22nd March 2016
+
+#### Changing setup for Google Analytics
+
+Formerly, the tracking id for Google Analytics was set like below:
+
+```toml
+[params]
+ google_analytics = ["UA-XXXXXXXX-X", "auto"]
+```
+
+Now the theme uses Hugo's own Google Analytics config option. The variable moved outside the scope of `params` and the setup requires only the tracking id as a string:
+
+```toml
+googleAnalytics = "UA-XXXXXXXX-X"
+```
+
+[Show me the diff](https://github.com/digitalcraftsman/hugo-material-docs/commit/fa10c8eef935932426d46b662a51f29a5e0d48e2)
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md b/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md
new file mode 100644
index 0000000..1a5879b
--- /dev/null
+++ b/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md
@@ -0,0 +1,20 @@
+Copyright (c) 2016 Digitalcraftsman
+Copyright (c) 2016 Martin Donath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/README.md b/DOCUMENTATION/themes/hugo-material-docs/README.md
new file mode 100644
index 0000000..efcc807
--- /dev/null
+++ b/DOCUMENTATION/themes/hugo-material-docs/README.md
@@ -0,0 +1,40 @@
+# Material Docs
+
+A material design theme for [Hugo](https://gohugo.io).
+
+[![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-material-docs/master/static/images/screen.png)](https://digitalcraftsman.github.io/hugo-material-docs/)
+
+## Quick start
+
+Install with `git`:
+
+
+ git clone https://github.com/digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs
+
+
+Next, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.
+
+Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
+
+Hugo includes a development server, so you can view your changes as you go -
+very handy. Spin it up with the following command:
+
+``` sh
+hugo server
+```
+
+Now you can go to [localhost:1313](http://localhost:1313) and the Material
+theme should be visible. For detailed installation instructions visit the [demo](http://themes.gohugo.io/theme/material-docs/).
+
+Noteworthy changes of this theme are listed in the [changelog](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/CHANGELOG.md).
+
+## Acknowledgements
+
+A big thank you to [Martin Donath](https://github.com/squidfunk). He created the original [Material theme](https://github.com/squidfunk/mkdocs-material) for Hugo's companion [MkDocs](http://www.mkdocs.org/). This port wouldn't be possible without him.
+
+Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project.
+
+## License
+
+The theme is released under the MIT license. Read the [license](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/LICENSE.md) for more information.
+
diff --git a/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md b/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md
new file mode 100644
index 0000000..a49ba48
--- /dev/null
+++ b/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md
@@ -0,0 +1,2 @@
+---
+---
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/404.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/404.html
new file mode 100644
index 0000000..e69de29
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html
new file mode 100644
index 0000000..54c2b78
--- /dev/null
+++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html
@@ -0,0 +1,57 @@
+{{ partial "head" . }}
+
+