diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 40005024..cc034fc9 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -3,3 +3,4 @@ github: Mahmoudz open_collective: laradock custom: ['paypal.me/mzmmzz'] +patreon: zalt diff --git a/DOCUMENTATION/config.toml b/DOCUMENTATION/config.toml index 56e4fe03..d6c3a732 100644 --- a/DOCUMENTATION/config.toml +++ b/DOCUMENTATION/config.toml @@ -20,8 +20,8 @@ googleAnalytics = "UA-37514928-9" repo_url = "https://github.com/laradock/laradock" version = "" - logo = "images/logo.png" - favicon = "" + logo = "images/favicons/ms-icon-310x310.png" + favicon = "images/favicons/favicon.ico" permalink = "#" @@ -48,40 +48,35 @@ googleAnalytics = "UA-37514928-9" # ------- MENU START ----------------------------------------- [[menu.main]] - name = "1. Introduction" + name = "Introduction" url = "introduction/" weight = 1 [[menu.main]] - name = "2. Getting Started" + name = "Getting Started" url = "getting-started/" weight = 2 [[menu.main]] - name = "3. Documentation" + name = "Documentation" url = "documentation/" weight = 3 [[menu.main]] - name = "4. Help & Questions" + name = "Help & Questions" url = "help/" weight = 4 [[menu.main]] - name = "5. Related Projects" + name = "Related Projects" url = "related-projects/" weight = 5 [[menu.main]] - name = "6. Contributing" + name = "Contributions" url = "contributing/" weight = 6 -[[menu.main]] - name = "7. License" - url = "license/" - weight = 7 - # ------- MENU END ----------------------------------------- [blackfriday] diff --git a/DOCUMENTATION/content/contributing/index.md b/DOCUMENTATION/content/contributing/index.md index dbe3efb8..0b019419 100644 --- a/DOCUMENTATION/content/contributing/index.md +++ b/DOCUMENTATION/content/contributing/index.md @@ -1,7 +1,7 @@ --- -title: 7. Contributing +title: Contributions type: index -weight: 7 +weight: 6 --- @@ -51,12 +51,20 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI ### Host the documentation locally +**Option 1: Use Hugo Docker Image:** + +1. Update the `DOCUMENTATION/content`. +2. Go to `DOCUMENTATION/`. +3. Run `docker run --rm -it -v $PWD:/src -p 1313:1313 -u hugo jguyomard/hugo-builder hugo server -w --bind=0.0.0.0` +4. Visit [http://localhost:1313/](http://localhost:1313/) + +**Option 2: Install Hugo Locally:** + 1. Install [Hugo](https://gohugo.io/) on your machine. -2. Edit the `DOCUMENTATION/content`. +2. Update 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). - - +4. Go to `DOCUMENTATION/`. +5. Run the `hugo` command to generate the HTML docs inside a new `/docs` folder. ## Support new Software (Add new Container) diff --git a/DOCUMENTATION/content/documentation/index.md b/DOCUMENTATION/content/documentation/index.md index f573a651..5eae9a02 100644 --- a/DOCUMENTATION/content/documentation/index.md +++ b/DOCUMENTATION/content/documentation/index.md @@ -1,5 +1,5 @@ --- -title: 3. Documentation +title: Documentation type: index weight: 3 --- @@ -57,7 +57,9 @@ 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` @@ -88,7 +90,8 @@ docker-compose exec mysql mysql -udefault -psecret
-## Edit default container configuration +## Edit default Container config + Open the `docker-compose.yml` and change anything you want. Examples: @@ -161,7 +164,7 @@ You might use the `--no-cache` option if you want full rebuilding (`docker-compo
-## Add more Software (Docker Images) +## Add more 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/). @@ -384,7 +387,9 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.
-## Install Deployer (Deployment tool for PHP) +## Install Deployer + +> A deployment tool for PHP. 1 - Open the `.env` file
@@ -402,7 +407,10 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.
-## Install SonarQube (automatic code review tool) +## Install SonarQube + +> An automatic code review tool. + SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
1 - Open the `.env` file @@ -463,14 +471,6 @@ To learn more about how Docker publishes ports, please read [this excellent post -
- -## Setup Laravel and Docker on Digital Ocean - -### [Full Guide Here](/guides/#Digital-Ocean) - - - @@ -483,7 +483,7 @@ To learn more about how Docker publishes ports, please read [this excellent post -## Install Laravel from a Docker Container +## Install Laravel from Container 1 - First you need to enter the Workspace Container. @@ -619,7 +619,9 @@ docker-compose up -d php-worker
-## Use Browsersync with Laravel Mix +## Use Browsersync + +> Using Use Browsersync with Laravel Mix. 1. Add the following settings to your `webpack.mix.js` file. Please refer to Browsersync [Options](https://browsersync.io/docs/options) page for more options. ``` @@ -1731,7 +1733,9 @@ The default username and password for the root MySQL user are `root` and `root `
-## Create Multiple Databases (MySQL) +## Create Multiple Databases + +> With 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: @@ -1765,7 +1769,9 @@ If you need MySQL access from your host, d
-## Use custom Domain (instead of the Docker IP) +## Use custom Domain + +> How to use a custom domain, instead of the Docker IP. Assuming your custom domain is `laravel.test` @@ -1791,7 +1797,7 @@ server_name laravel.test;
-## Enable Global Composer Build Install +## 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. @@ -1810,7 +1816,9 @@ Enabling Global Composer Install during the build for the container allows you t
-## Add authentication credential for Magento 2 +## Add authentication for Magento + +> Adding authentication credentials for Magento 2. 1 - Open the `.env` file @@ -1902,7 +1910,7 @@ To install NPM GULP toolkit in the Workspace container
-## Install NPM BOWER package manager +## Install NPM BOWER To install NPM BOWER package manager in the Workspace container @@ -2088,7 +2096,9 @@ e) set it to `true`
-## Install Laravel Envoy (Envoy Task Runner) +## Install Laravel Envoy + +> A Tasks Runner. 1 - Open the `.env` file
@@ -2121,7 +2131,8 @@ e) set it to `true`
-## Install libfaketime in the php-fpm container +## Install libfaketime in php-fpm + Libfaketime allows you to control the date and time that is returned from the operating system. It can be used by specifying a special string in the `PHP_FPM_FAKETIME` variable in the `.env` file. For example: @@ -2145,7 +2156,8 @@ will set the clock back 1 day. See (https://github.com/wolfcw/libfaketime) for m
-## Install YAML PHP extension in the php-fpm container +## Install YAML extension in php-fpm + YAML PHP extension allows you to easily parse and create YAML structured data. I like YAML because it's well readable for humans. See http://php.net/manual/en/ref.yaml.php and http://yaml.org/ for more info. 1 - Open the `.env` file @@ -2195,7 +2207,9 @@ For configuration information, visit the [bash-git-prompt repository](https://gi
-## Install Oh My ZSH! with Laravel autocomplete plugin +## Install Oh My ZSH + +> With the Laravel autocomplete plugin. [Zsh](https://en.wikipedia.org/wiki/Z_shell) is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. @@ -2226,7 +2240,9 @@ Remote debug Laravel web and phpunit tests.
-## Setup Google Cloud for docker registry +## Setup Google Cloud + +> Setting up Google Cloud for the docker registry. ``` gcloud auth configure-docker @@ -2242,7 +2258,7 @@ gcloud auth login
-## Keep track of your Laradock changes +## Track your Laradock changes 1. Fork the Laradock repository. 2. Use that fork as a submodule. diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md index df193542..47108aba 100644 --- a/DOCUMENTATION/content/getting-started/index.md +++ b/DOCUMENTATION/content/getting-started/index.md @@ -1,18 +1,18 @@ --- -title: 2. Getting Started +title: Getting Started type: index weight: 2 --- -## 2.1 Requirements +## Requirements - [Git](https://git-scm.com/downloads) -- [Docker](https://www.docker.com/products/docker/) `>= 17.12` +- [Docker](https://www.docker.com/products/docker/) [ >= 17.12 ] -## 2.2 Installation +## Installation Choose the setup the best suits your needs. @@ -44,10 +44,10 @@ Note: If you are not using Git yet for your project, you can use `git clone` ins 2 - Make sure your folder structure should look like this: ``` -+ project-a - + laradock-a -+ project-b - + laradock-b +* 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).* @@ -66,8 +66,8 @@ git clone https://github.com/laradock/laradock.git Your folder structure should look like this: ``` -+ laradock -+ project-z +* laradock +* project-z ``` 2 - Edit your web server sites configuration. @@ -102,9 +102,9 @@ git clone https://github.com/laradock/laradock.git Your folder structure should look like this: ``` -+ laradock -+ project-1 -+ project-2 +* laradock +* project-1 +* project-2 ``` 2 - Go to your web server and create config files to point to different project directory when visiting different domains: @@ -136,7 +136,7 @@ If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https:// -## 2.3 Usage +## Usage **Read Before starting:** diff --git a/DOCUMENTATION/content/help/index.md b/DOCUMENTATION/content/help/index.md index 8267bc5a..dddb80a1 100644 --- a/DOCUMENTATION/content/help/index.md +++ b/DOCUMENTATION/content/help/index.md @@ -1,7 +1,7 @@ --- -title: 5. Help & Questions +title: Help & Questions type: index -weight: 5 +weight: 4 --- Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community. diff --git a/DOCUMENTATION/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md index 5dcc92da..0251c3a0 100644 --- a/DOCUMENTATION/content/introduction/index.md +++ b/DOCUMENTATION/content/introduction/index.md @@ -1,13 +1,18 @@ --- -title: 1. Introduction +title: Introduction type: index weight: 1 --- -Laradock is a full PHP development environment based on Docker. +Laradock is a full PHP development environment for Docker. -Supporting a variety of common services, all pre-configured to provide a full PHP development environment. +It supports a variety of common services, all pre-configured to provide a ready PHP development environment. +
+ +--- +### Use Docker First - Then Learn About It Later! +--- ## Features @@ -26,11 +31,9 @@ Supporting a variety of common services, all pre-configured to provide a full PH - Everything is visible and editable. - Fast Images Builds. -
---- -### Use Docker First - Then Learn About It Later ---- + + ## Quick Overview @@ -73,7 +76,7 @@ That's it! enjoy :) -## Supported Software (Docker Images) +## Supported Services > Laradock, adheres to the 'separation of concerns' principle, thus it runs each software on its own Docker Container. > You can turn On/Off as many instances as you want without worrying about the configurations. @@ -354,6 +357,8 @@ Contribute and help us sustain the project. Option 2: Become a Sponsor via [Github Sponsors](https://github.com/sponsors/Mahmoudz).
Option 3: Become a Sponsor/Backer via [Open Collective](https://opencollective.com/laradock/contribute). +
+Option 4: Become a [Patreon](https://www.patreon.com/zalt). ## Sponsors diff --git a/DOCUMENTATION/content/license/index.md b/DOCUMENTATION/content/license/index.md deleted file mode 100644 index 312b13d1..00000000 --- a/DOCUMENTATION/content/license/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: 8. 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 index c14aa2d5..f7f8f46c 100644 --- a/DOCUMENTATION/content/related-projects/index.md +++ b/DOCUMENTATION/content/related-projects/index.md @@ -1,22 +1,50 @@ --- -title: 10. Related Projects +title: Related Projects type: index -weight: 10 +weight: 5 --- -Laradock 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) -* [Dockery](https://github.com/taufek/dockery) by [Taufek](https://github.com/Taufek) -* [Laradock Multi](https://github.com/bagart/laradock-multi) by [BAGArt](https://github.com/bagart) - Laradock wrapper template -for running multiple related projects with different versions of PHP and Node.js such as Microservice Architecture (MSA) -* [DockerStacks](https://github.com/sfx101/docker-stacks) by [Subhadip Naskar](https://github.com/sfx101) - DockerStacks is a laradock GUI build on top of docker, electron.js, node-pty, xterm.js and the awesome laradock +Laradock CLI is a tool for Laravel projects which automates the docker configuration setup for services, amongst other things. -If you want your project listed here, please open an issue. +* [Docker Stacks](https://github.com/sfx101/docker-stacks): A GUI for managing Laradock. (by [Subhadip Naskar](https://github.com/sfx101)) +* [Laradock CLI](https://github.com/lorinlee/laradock-cli): A CLI for managing Laradock. (by [LorinLee](https://github.com/lorinlee)) +* [Laradock CLI](https://github.com/loonpwn/laradock-cli): A CLI for managing Laradock. (by [Loonpwn](https://github.com/loonpwn)) +* [Ansible Laradock Kubernetes](https://github.com/sifat-rahim/ansible-laradock-kubernetes): Ansible playbook to setup docker containers for Laravel apps using Laradock. (by [Sifat Rahim](https://github.com/sifat-rahim)) +* [Monitor Laradock](https://github.com/zeroc0d3/monitor-laradock): Laradock Monitoring Tools (using Grafana). (by [Zeroc0d3](https://github.com/zeroc0d3)) +* [Laradock Manager](https://github.com/Lyimmi/laradock-manager): A simple app for managing Laradock containers. Made with wails.app (go & vue.js & vuetify). (by [Lyimmi](https://github.com/Lyimmi)) +* [Laradock Env](https://github.com/bagart/laradock_env): A wrapper with commands for managing Laradock. (by [BAGArt](https://github.com/bagart)) +* [Lara Query](https://github.com/TanisukeGoro/laraQuery): Easy Laradock CLI. (by [TanisukeGoro](https://github.com/TanisukeGoro)) +* [Laradock CLI](https://github.com/tonysm/laradock-cli): Laradock CLI helper. (by [Tonysm](https://github.com/Tonysm)) +* [Laradock Lite](https://github.com/yangliuyu/laradock-lite): A Docker based laravel development environment with minimal dependencies. (by [Yangliuyu](https://github.com/yangliuyu)) +* [Laradock Makefile](https://github.com/bazavlukd/laradock-makefile): Makefile with some useful commands for Laradock. (by [Bazavlukd](https://github.com/bazavlukd)) +* [Laradock Build](https://github.com/dockerframework/laradock-build): Docker builder & running script for Laradock. (by [Dockerframework](https://github.com/dockerframework)) +* [Laravel Laradock PHPStorm](https://github.com/LarryEitel/laravel-laradock-phpstorm): Guide for configuring PHPStorm for remote debugging with Laravel & Laradock. (by [LarryEitel](https://github.com/LarryEitel)) +* [Laradock Crudbooster](https://github.com/nutellinoit/laradock-crudbooster): Docker compose & Kubernetes solution to build apps with crudbooster & Laradock. (by [Nutellinoit](https://github.com/nutellinoit)) +* [Laradock Sample](https://github.com/tadaken3/laradock-sample): Install Laravel with Laradock. (by [Tadaken3](https://github.com/tadaken3)) +* [Stylemix's Laradock](https://github.com/stylemix/laradock): Alternate laradock for multiproject purpose. (by [Stylemix](https://github.com/stylemix)) + + + + +## Inspired by Laradock + +* [Dockery](https://github.com/taufek/dockery): Laradock for Ruby. (by [Taufek](https://github.com/Taufek)) +* [RubyDev Dock](https://github.com/scudelletti/rubydev-dock): Laradock for Ruby. (by [Diogo Scudelletti](https://github.com/scudelletti)) +* [NoDock](https://github.com/Osedea/nodock): Laradock for NodeJS. (by [Osedea](https://github.com/Osedea)) +* [Laradock Multi](https://github.com/bagart/laradock-multi): Laradock for PHP & NodeJS. (by [BAGArt](https://github.com/bagart)) +* [Wordpress Laradock](https://github.com/shov/wordpress-laradock): Laradock for Wordpress. (by [Shov](https://github.com/shov)) +* [Yii2 Laradock](https://github.com/ydatech/yii2-laradock): Laradock for Yii2. (by [Ydatech](https://github.com/ydatech)) +* [MageDock](https://github.com/ojhaujjwal/magedock): Laradock for Magento. (by [Ujjwal Ojha](https://github.com/ojhaujjwal)) +* [Docker Codeigniter](https://github.com/sebastianlzy/docker-codeigniter): Laradock for Codeigniter. (by [Sebastianlzy](https://github.com/sebastianlzy)) +* [Klaradock](https://github.com/poyhsiao/Klaradock): A customized Laradock. (by [Kim Hsiao](https://github.com/poyhsiao)) +* [Laravel Boilerplate](https://github.com/casivaagustin/laravel-boilerplate): A boilerplate with support for JWT. (by [Casivaagustin](https://github.com/casivaagustin)) + + + + + +

+ +> Feel free to submit a PR for listing your project here. diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html index 54c2b783..fb1046a4 100644 --- a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html +++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html @@ -36,6 +36,7 @@ {{ with .Site.Params.copyright }} © {{ $.Now.Format "2006" }} {{ . }} – {{ end }} +

Documentation built with Hugo using the diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html index 050f28d2..83cf3ee3 100644 --- a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html +++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html @@ -32,6 +32,7 @@ {{ with .Site.Params.copyright }} © {{ $.Now.Format "2006" }} {{ . }} – {{ end }} +

Documentation built with Hugo using the diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html index 7f14e8b8..c09a68bf 100644 --- a/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html +++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html @@ -39,7 +39,7 @@


- laradock logo + laradock logo {{ range where .Site.Pages "Type" "index" }}





@@ -54,6 +54,7 @@ {{ with .Site.Params.copyright }} © {{ $.Now.Format "2006" }} {{ . }} – {{ end }} +

Documentation built with Hugo using the diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/head.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/head.html index e890c0a2..406f7d2d 100644 --- a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/head.html +++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/head.html @@ -36,6 +36,25 @@ + + + + + + + + + + + + + + + + + + +