ykxiao/laradock
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update the docs

Browse Source
This commit is contained in:
Mahmoud Zalt
2017-02-22 15:58:06 -05:00
parent 8e8020e8b0
commit e5fa629a64
20 changed files with 3406 additions and 3261 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/getting-started/index.html
View File

@ -9,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Getting started - Laradock Docs</title>
<title>Getting Started - Laradock Docs</title>
<meta name="generator" content="Hugo 0.18.1" />
@ -97,7 +97,7 @@
</div>
<div class="stretch">
<div class="title">
Getting started
Getting Started
</div>
</div>
@ -180,9 +180,9 @@
<a title="Introduction" href="http://laradock.io/">
<a title="Overview" href="http://laradock.io/">
Introduction
Overview
</a>
@ -198,9 +198,9 @@
<a class="current" title="Getting started" href="http://laradock.io/getting-started/">
<a class="current" title="Getting Started" href="http://laradock.io/getting-started/">
Getting started
Getting Started
</a>
@ -332,30 +332,26 @@
<article class="article">
<div class="wrapper">
<h1>Getting started </h1>
<h1>Getting Started </h1>
<p><a name="Requirements"></a></p>
<h2 id="requirements:d680e8a854a7cbad6d490c445cba2eba">Requirements</h2>
<h2 id="requirements">Requirements</h2>
<ul>
<li><a href="https://git-scm.com/downloads">Git</a></li>
<li><a href="https://www.docker.com/products/docker/">Docker</a> <code>&gt;= 1.12</code></li>
</ul>
<p><a name="Installation"></a></p>
<h2 id="installation:d680e8a854a7cbad6d490c445cba2eba">Installation</h2>
<h2 id="installation">Installation</h2>
<p>Choose the setup the best suits your needs.</p>
<h4 id="a-setup-for-single-project:d680e8a854a7cbad6d490c445cba2eba">A) Setup for Single Project:</h4>
<h4 id="a-setup-for-single-project">A) Setup for Single Project:</h4>
<p><em>(In case you want a Docker environment for each project)</em></p>
<h5 id="a-1-setup-environment-in-existing-project:d680e8a854a7cbad6d490c445cba2eba">A.1) Setup environment in existing Project:</h5>
<h5 id="a-1-setup-environment-in-existing-project">A.1) Setup environment in existing Project:</h5>
<p><em>(In case you already have a project, and you want to setup an environment to run it)</em></p>
@ -376,9 +372,9 @@
- laradock
</code></pre>
<h5 id="a-2-setup-environment-first-then-create-project:d680e8a854a7cbad6d490c445cba2eba">A.2) Setup environment first then create project:</h5>
<h5 id="a-2-setup-environment-first-then-create-project">A.2) Setup environment first then create project:</h5>
<p><em>(In case you don't have a project, and you want to create your project inside the Docker environment)</em></p>
<p><em>(In case you don&rsquo;t have a project, and you want to create your project inside the Docker environment)</em></p>
<p>1 - Clone this repository anywhere on your machine:</p>
@ -399,7 +395,7 @@
<pre><code>docker-compose stop &amp;&amp; docker-compose up -d XXXX YYYY ZZZZ ....
</code></pre>
<h4 id="b-setup-for-multiple-projects:d680e8a854a7cbad6d490c445cba2eba">B) Setup for Multiple Projects:</h4>
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
<p>1 - Clone this repository anywhere on your machine:</p>
@ -415,7 +411,7 @@
- ../project2/:/var/www/project2
</code></pre>
<p>3 - You can access all sites by visiting <code>http://localhost/project1/public</code> and <code>http://localhost/project2/public</code> but of course that's not very useful so let's setup NGINX quickly.</p>
<p>3 - You can access all sites by visiting <code>http://localhost/project1/public</code> and <code>http://localhost/project2/public</code> but of course that&rsquo;s not very useful so let&rsquo;s setup NGINX quickly.</p>
<p>4 - Go to <code>nginx/sites</code> and copy <code>sample.conf.example</code> to <code>project1.conf</code> then to <code>project2.conf</code></p>
@ -425,7 +421,7 @@
root /var/www/project1/public;
</code></pre>
<p>Do the same for each project <code>project2.conf</code>, <code>project3.conf</code>,...</p>
<p>Do the same for each project <code>project2.conf</code>, <code>project3.conf</code>,&hellip;</p>
<p>6 - Add the domains to the <strong>hosts</strong> files.</p>
@ -434,9 +430,7 @@
<p>7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.</p>
<p><a name="Usage"></a></p>
<h2 id="usage:d680e8a854a7cbad6d490c445cba2eba">Usage</h2>
<h2 id="usage">Usage</h2>
<p><strong>Read Before starting:</strong></p>
@ -450,7 +444,7 @@
<p><br></p>
<blockquote>
<p><strong>Warning:</strong> If you used an older version of LaraDock it's highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent errors as much as possible.</p>
<p><strong>Warning:</strong> If you used an older version of LaraDock it&rsquo;s highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent errors as much as possible.</p>
</blockquote>
<p><br></p>
@ -462,14 +456,14 @@
<pre><code class="language-bash">docker-compose up -d nginx mysql
</code></pre>
<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn't find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>
<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn&rsquo;t find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>
<p>You can select your own combination of Containers form the list below:</p>
<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>.</p>
<p><br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...).</p>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &hellip;).</p>
<pre><code class="language-bash">docker-compose exec workspace bash
</code></pre>
@ -479,7 +473,7 @@
<pre><code class="language-bash">docker exec -it {workspace-container-id} bash
</code></pre>
<p><strong>Note:</strong> You can add <code>--user=laradock</code> (example <code>docker-compose exec --user=laradock workspace bash</code>) to have files created as your host's user. (you can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code>).</p>
<p><strong>Note:</strong> You can add <code>--user=laradock</code> (example <code>docker-compose exec --user=laradock workspace bash</code>) to have files created as your host&rsquo;s user. (you can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code>).</p>
<p><br>
3 - Edit your project configurations.</p>
@ -489,7 +483,7 @@
<pre><code class="language-env">DB_HOST=mysql
</code></pre>
<p><em>If you want to use Laravel and you don't have it installed yet, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>
<p><em>If you want to use Laravel and you don&rsquo;t have it installed yet, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>
<p><br>
4 - Open your browser and visit your localhost address (<code>http://localhost/</code>).</p>
@ -514,6 +508,22 @@
<nav class="pagination" aria-label="Footer">
<div class="previous">
<a href="http://laradock.io/" title="Overview">
<span class="direction">
Previous
</span>
<div class="page">
<div class="button button-previous" role="button" aria-label="Previous">
<i class="icon icon-back"></i>
</div>
<div class="stretch">
<div class="title">
Overview
</div>
</div>
</div>
</a>
</div>
<div class="next">