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

update installation steps in the docs (.env)

Browse Source
This commit is contained in:
Mahmoud Zalt
2017-03-16 17:03:05 -04:00
parent c00fe5d7e0
commit e0e4616ae0
22 changed files with 519 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/documentation/index.html
View File

@ -577,7 +577,7 @@ xdebug.remote_connect_back=1
<p>By installing xDebug, you are enabling it to run on startup by default.</p>
<p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):</p>
<p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):</p>
<ul>
<li>Stop xDebug from running by default: <code>./xdebugPhpFpm stop</code>.</li>
@ -617,11 +617,11 @@ xdebug.remote_connect_back=1
<a name="Production"></a></p>
<p><br>
<a name="LaraDock-for-Production"></a></p>
<a name="Laradock-for-Production"></a></p>
<h2 id="prepare-laradock-for-production">Prepare LaraDock for Production</h2>
<h2 id="prepare-laradock-for-production">Prepare Laradock for Production</h2>
<p>It&rsquo;s recommended for production to create a custom <code>docker-compose.yml</code> file. For that reason, LaraDock is shipped with <code>production-docker-compose.yml</code> which should contain only the containers you are planning to run on production (usage example: <code>docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...</code>).</p>
<p>It&rsquo;s recommended for production to create a custom <code>docker-compose.yml</code> file. For that reason, Laradock is shipped with <code>production-docker-compose.yml</code> which should contain only the containers you are planning to run on production (usage example: <code>docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...</code>).</p>
<p>Note: The Database (MySQL/MariaDB/&hellip;) 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:</p>
@ -662,7 +662,7 @@ xdebug.remote_connect_back=1
<p>3 - Edit <code>docker-compose.yml</code> to Map the new application path:</p>
<p>By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.</p>
<p>By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.</p>
<p>Since the new Laravel application is in the <code>my-cool-app</code> folder, we need to replace <code>../:/var/www</code> with <code>../my-cool-app/:/var/www</code>, as follow:</p>
@ -678,7 +678,7 @@ xdebug.remote_connect_back=1
<pre><code class="language-bash">cd my-cool-app
</code></pre>
<p>5 - Go back to the LaraDock installation steps to see how to edit the <code>.env</code> file.</p>
<p>5 - Go back to the Laradock installation steps to see how to edit the <code>.env</code> file.</p>
<p><br>
<a name="Run-Artisan-Commands"></a></p>
@ -780,7 +780,7 @@ SESSION_DRIVER=redis
<p>5 - You can manually test it from Laravel with this code:</p>
<pre><code class="language-php">\Cache::store('redis')-&gt;put('LaraDock', 'Awesome', 10);
<pre><code class="language-php">\Cache::store('redis')-&gt;put('Laradock', 'Awesome', 10);
</code></pre>
<p><br>
@ -1047,7 +1047,7 @@ A package (<a href="https://github.com/duxet/laravel-rethinkdb">Laravel RethinkD
<h2 id="install-codeigniter">Install CodeIgniter</h2>
<p>To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:</p>
<p>To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:</p>
<p>1 - Open the <code>docker-compose.yml</code> file.</p>
@ -1287,7 +1287,7 @@ port=1234
<h2 id="common-terminal-aliases">Common Terminal Aliases</h2>
<p>When you start your docker container, LaraDock will copy the <code>aliases.sh</code> file located in the <code>laradock/workspace</code> directory and add sourcing to the container <code>~/.bashrc</code> file.</p>
<p>When you start your docker container, Laradock will copy the <code>aliases.sh</code> file located in the <code>laradock/workspace</code> directory and add sourcing to the container <code>~/.bashrc</code> file.</p>
<p>You are free to modify the <code>aliases.sh</code> as you see fit, adding your own aliases (or function macros) to suit your requirements.</p>
@ -1362,12 +1362,12 @@ e) set it to <code>true</code></p>
<p><a href="https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md"><strong>Debugging Guide Here</strong></a></p>
<p><br>
<a name="keep-tracking-LaraDock"></a></p>
<a name="keep-tracking-Laradock"></a></p>
<h2 id="keep-track-of-your-laradock-changes">Keep track of your LaraDock changes</h2>
<h2 id="keep-track-of-your-laradock-changes">Keep track of your Laradock changes</h2>
<ol>
<li>Fork the LaraDock repository.</li>
<li>Fork the Laradock repository.</li>
<li>Use that fork as a submodule.</li>
<li>Commit all your changes to your fork.</li>
<li>Pull new stuff from the main repository from time to time.</li>
@ -1376,15 +1376,15 @@ e) set it to <code>true</code></p>
<p><br>
<a name="upgrading-laradock"></a></p>
<h2 id="upgrading-laradock">Upgrading LaraDock</h2>
<h2 id="upgrading-laradock">Upgrading Laradock</h2>
<p>Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:</p>
<p>Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:</p>
<ol>
<li>Stop the docker VM <code>docker-machine stop {default}</code></li>
<li>Install Docker for <a href="https://docs.docker.com/docker-for-mac/">Mac</a> or <a href="https://docs.docker.com/docker-for-windows/">Windows</a>.</li>
<li>Upgrade LaraDock to <code>v4.*.*</code> (<code>git pull origin master</code>)</li>
<li>Use LaraDock as you used to do: <code>docker-compose up -d nginx mysql</code>.</li>
<li>Upgrade Laradock to <code>v4.*.*</code> (<code>git pull origin master</code>)</li>
<li>Use Laradock as you used to do: <code>docker-compose up -d nginx mysql</code>.</li>
</ol>
<p><strong>Note:</strong> If you face any problem with the last step above: rebuild all your containers
@ -1500,7 +1500,7 @@ e) set it to <code>true</code></p>
<li>Option B
<ol>
<li>Change the <code>DB_HOST</code> value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as <code>mysql</code></li>
<li>Change the <code>DB_HOST</code> value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as <code>mysql</code></li>
</ol></li>
</ul>

34
docs/documentation/index.xml
View File

@ -280,7 +280,7 @@ xdebug.remote_connect_back=1
&lt;p&gt;By installing xDebug, you are enabling it to run on startup by default.&lt;/p&gt;
&lt;p&gt;To control the behavior of xDebug (in the &lt;code&gt;php-fpm&lt;/code&gt; Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):&lt;/p&gt;
&lt;p&gt;To control the behavior of xDebug (in the &lt;code&gt;php-fpm&lt;/code&gt; Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Stop xDebug from running by default: &lt;code&gt;./xdebugPhpFpm stop&lt;/code&gt;.&lt;/li&gt;
@ -320,11 +320,11 @@ xdebug.remote_connect_back=1
&lt;a name=&#34;Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;LaraDock-for-Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;a name=&#34;Laradock-for-Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;prepare-laradock-for-production&#34;&gt;Prepare LaraDock for Production&lt;/h2&gt;
&lt;h2 id=&#34;prepare-laradock-for-production&#34;&gt;Prepare Laradock for Production&lt;/h2&gt;
&lt;p&gt;It&amp;rsquo;s recommended for production to create a custom &lt;code&gt;docker-compose.yml&lt;/code&gt; file. For that reason, LaraDock is shipped with &lt;code&gt;production-docker-compose.yml&lt;/code&gt; which should contain only the containers you are planning to run on production (usage example: &lt;code&gt;docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;It&amp;rsquo;s recommended for production to create a custom &lt;code&gt;docker-compose.yml&lt;/code&gt; file. For that reason, Laradock is shipped with &lt;code&gt;production-docker-compose.yml&lt;/code&gt; which should contain only the containers you are planning to run on production (usage example: &lt;code&gt;docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;Note: The Database (MySQL/MariaDB/&amp;hellip;) 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:&lt;/p&gt;
@ -365,7 +365,7 @@ xdebug.remote_connect_back=1
&lt;p&gt;3 - Edit &lt;code&gt;docker-compose.yml&lt;/code&gt; to Map the new application path:&lt;/p&gt;
&lt;p&gt;By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.&lt;/p&gt;
&lt;p&gt;By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.&lt;/p&gt;
&lt;p&gt;Since the new Laravel application is in the &lt;code&gt;my-cool-app&lt;/code&gt; folder, we need to replace &lt;code&gt;../:/var/www&lt;/code&gt; with &lt;code&gt;../my-cool-app/:/var/www&lt;/code&gt;, as follow:&lt;/p&gt;
@ -381,7 +381,7 @@ xdebug.remote_connect_back=1
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;cd my-cool-app
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;5 - Go back to the LaraDock installation steps to see how to edit the &lt;code&gt;.env&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;5 - Go back to the Laradock installation steps to see how to edit the &lt;code&gt;.env&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Run-Artisan-Commands&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -483,7 +483,7 @@ SESSION_DRIVER=redis
&lt;p&gt;5 - You can manually test it from Laravel with this code:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-php&#34;&gt;\Cache::store(&#39;redis&#39;)-&amp;gt;put(&#39;LaraDock&#39;, &#39;Awesome&#39;, 10);
&lt;pre&gt;&lt;code class=&#34;language-php&#34;&gt;\Cache::store(&#39;redis&#39;)-&amp;gt;put(&#39;Laradock&#39;, &#39;Awesome&#39;, 10);
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;br&gt;
@ -750,7 +750,7 @@ A package (&lt;a href=&#34;https://github.com/duxet/laravel-rethinkdb&#34;&gt;La
&lt;h2 id=&#34;install-codeigniter&#34;&gt;Install CodeIgniter&lt;/h2&gt;
&lt;p&gt;To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:&lt;/p&gt;
&lt;p&gt;To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:&lt;/p&gt;
&lt;p&gt;1 - Open the &lt;code&gt;docker-compose.yml&lt;/code&gt; file.&lt;/p&gt;
@ -990,7 +990,7 @@ port=1234
&lt;h2 id=&#34;common-terminal-aliases&#34;&gt;Common Terminal Aliases&lt;/h2&gt;
&lt;p&gt;When you start your docker container, LaraDock will copy the &lt;code&gt;aliases.sh&lt;/code&gt; file located in the &lt;code&gt;laradock/workspace&lt;/code&gt; directory and add sourcing to the container &lt;code&gt;~/.bashrc&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;When you start your docker container, Laradock will copy the &lt;code&gt;aliases.sh&lt;/code&gt; file located in the &lt;code&gt;laradock/workspace&lt;/code&gt; directory and add sourcing to the container &lt;code&gt;~/.bashrc&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;You are free to modify the &lt;code&gt;aliases.sh&lt;/code&gt; as you see fit, adding your own aliases (or function macros) to suit your requirements.&lt;/p&gt;
@ -1065,12 +1065,12 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md&#34;&gt;&lt;strong&gt;Debugging Guide Here&lt;/strong&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;keep-tracking-LaraDock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;a name=&#34;keep-tracking-Laradock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;keep-track-of-your-laradock-changes&#34;&gt;Keep track of your LaraDock changes&lt;/h2&gt;
&lt;h2 id=&#34;keep-track-of-your-laradock-changes&#34;&gt;Keep track of your Laradock changes&lt;/h2&gt;
&lt;ol&gt;
&lt;li&gt;Fork the LaraDock repository.&lt;/li&gt;
&lt;li&gt;Fork the Laradock repository.&lt;/li&gt;
&lt;li&gt;Use that fork as a submodule.&lt;/li&gt;
&lt;li&gt;Commit all your changes to your fork.&lt;/li&gt;
&lt;li&gt;Pull new stuff from the main repository from time to time.&lt;/li&gt;
@ -1079,15 +1079,15 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;upgrading-laradock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;upgrading-laradock&#34;&gt;Upgrading LaraDock&lt;/h2&gt;
&lt;h2 id=&#34;upgrading-laradock&#34;&gt;Upgrading Laradock&lt;/h2&gt;
&lt;p&gt;Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:&lt;/p&gt;
&lt;p&gt;Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Stop the docker VM &lt;code&gt;docker-machine stop {default}&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Install Docker for &lt;a href=&#34;https://docs.docker.com/docker-for-mac/&#34;&gt;Mac&lt;/a&gt; or &lt;a href=&#34;https://docs.docker.com/docker-for-windows/&#34;&gt;Windows&lt;/a&gt;.&lt;/li&gt;
&lt;li&gt;Upgrade LaraDock to &lt;code&gt;v4.*.*&lt;/code&gt; (&lt;code&gt;git pull origin master&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;Use LaraDock as you used to do: &lt;code&gt;docker-compose up -d nginx mysql&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Upgrade Laradock to &lt;code&gt;v4.*.*&lt;/code&gt; (&lt;code&gt;git pull origin master&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;Use Laradock as you used to do: &lt;code&gt;docker-compose up -d nginx mysql&lt;/code&gt;.&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you face any problem with the last step above: rebuild all your containers
@ -1203,7 +1203,7 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;li&gt;Option B
&lt;ol&gt;
&lt;li&gt;Change the &lt;code&gt;DB_HOST&lt;/code&gt; value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as &lt;code&gt;mysql&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Change the &lt;code&gt;DB_HOST&lt;/code&gt; value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as &lt;code&gt;mysql&lt;/code&gt;&lt;/li&gt;
&lt;/ol&gt;&lt;/li&gt;
&lt;/ul&gt;
</description>