forked from laradock/laradock
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
2163 lines (1371 loc) · 70.6 KB
/
Copy pathindex.html
File metadata and controls
2163 lines (1371 loc) · 70.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="no-js">
<head lang="en-us">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Laradock Docs</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="description" content="Laradock documentations.">
<link rel="canonical" href="http://laradock.io/">
<meta name="author" content="Mahmoud Zalt">
<meta property="og:url" content="http://laradock.io/">
<meta property="og:title" content="Laradock Docs">
<meta property="og:image" content="http://laradock.io/images/logo.png">
<meta name="apple-mobile-web-app-title" content="Laradock Docs">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="shortcut icon" type="image/x-icon" href="http://laradock.io/images/favicon.ico">
<link rel="icon" type="image/x-icon" href="http://laradock.io/images/favicon.ico">
<style>
@font-face {
font-family: 'Icon';
src: url('http://laradock.io/fonts/icon.eot');
src: url('http://laradock.io/fonts/icon.eot')
format('embedded-opentype'),
url('http://laradock.io/fonts/icon.woff')
format('woff'),
url('http://laradock.io/fonts/icon.ttf')
format('truetype'),
url('http://laradock.io/fonts/icon.svg')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="http://laradock.io/stylesheets/application.css">
<link rel="stylesheet" href="http://laradock.io/stylesheets/temporary.css">
<link rel="stylesheet" href="http://laradock.io/stylesheets/palettes.css">
<link rel="stylesheet" href="http://laradock.io/stylesheets/highlight/highlight.css">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu+Mono">
<style>
body, input {
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
}
</style>
<script src="http://laradock.io/javascripts/modernizr.js"></script>
<link href="http://laradock.io/index.xml" rel="alternate" type="application/rss+xml" title="Laradock Docs" />
<link href="http://laradock.io/index.xml" rel="feed" type="application/rss+xml" title="Laradock Docs" />
</head>
<body class="palette-primary-purple palette-accent-deep-purple">
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>
<header class="header">
<nav aria-label="Header">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
<span></span>
</label>
</div>
<div class="stretch">
<div class="title">
Laradock Docs
</div>
</div>
<div class="button button-github" role="button" aria-label="GitHub">
<a href="https://github.com/laradock" title="@laradock on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
</div>
</div>
<div class="bar search">
<div class="button button-close" role="button" aria-label="Close">
<label class="toggle-button icon icon-back" for="toggle-search"></label>
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>
</header>
<main class="main">
<div class="drawer">
<nav aria-label="Navigation">
<a href="https://github.com/laradock/laradock" class="project">
<div class="banner">
<div class="logo">
<img src="http://laradock.io/images/logo.png">
</div>
<div class="name">
<strong>Laradock Docs </strong>
<br>
laradock/laradock
</div>
</div>
</a>
<div class="scrollable">
<div class="wrapper">
<ul class="repo">
<li class="repo-download">
<a href="https://github.com/laradock/laradock/archive/master.zip" target="_blank" title="Download" data-action="download">
<i class="icon icon-download"></i> Download
</a>
</li>
<li class="repo-stars">
<a href="https://github.com/laradock/laradock/stargazers" target="_blank" title="Stargazers" data-action="star">
<i class="icon icon-star"></i> Stars
<span class="count">–</span>
</a>
</li>
</ul>
<hr>
<div class="toc">
<ul>
<li>
<a class="current" title="Overview" href="http://laradock.io/">
Overview
</a>
<ul id="scrollspy">
</ul>
</li>
<li>
<a title="Getting Started" href="http://laradock.io/getting-started/">
Getting Started
</a>
</li>
<li>
<a title="Documentation" href="http://laradock.io/documentation/">
Documentation
</a>
</li>
<li>
<a title="Related Projects" href="http://laradock.io/related-projects/">
Related Projects
</a>
</li>
<li>
<a title="Help & Questions" href="http://laradock.io/help/">
Help & Questions
</a>
</li>
<li>
<a title="Contributing" href="http://laradock.io/contributing/">
Contributing
</a>
</li>
<li>
<a title="License" href="http://laradock.io/license/">
License
</a>
</li>
</ul>
<hr>
<span class="section">The author</span>
<ul>
<li>
<a href="https://github.com/laradock" target="_blank" title="@laradock on GitHub">
@laradock on GitHub
</a>
</li>
</ul>
</div>
</div>
</div>
</nav>
</div>
<article class="article">
<div class="wrapper">
<h1>Overview </h1>
<p>LaraDock strives to make the PHP development experience easier and faster.</p>
<p>It contains pre-packaged Docker Images that provides you a wonderful <em>development</em> environment without requiring you to install PHP, NGINX, MySQL, Redis, and any other software on your machines.</p>
<p>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…).</p>
<h2 id="quick-overview">Quick Overview:</h2>
<p>Let’s see how easy it is to install <code>NGINX</code>, <code>PHP</code>, <code>Composer</code>, <code>MySQL</code>, <code>Redis</code> and <code>beanstalkd</code>:</p>
<p>1 - Clone LaraDock inside your PHP project:</p>
<pre><code class="language-shell">git clone https://github.com/Laradock/laradock.git
</code></pre>
<p>2 - Enter the laradock folder and run this command:</p>
<pre><code class="language-shell">docker-compose up -d nginx mysql redis beanstalkd
</code></pre>
<p>3 - Open your <code>.env</code> file and set the following:</p>
<pre><code class="language-shell">DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd
</code></pre>
<p>4 - Open your browser and visit localhost: <code>http://localhost</code>.</p>
<pre><code class="language-shell">That's it! enjoy :)
</code></pre>
<p><a name="what-is-docker"></a></p>
<h2 id="what-is-docker">What is Docker?</h2>
<p><a href="https://www.docker.com">Docker</a> is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of <a href="https://en.wikipedia.org/wiki/Operating-system-level_virtualization">operating-system-level virtualization</a> on Linux, Mac OS and Windows.</p>
<p><a name="why-docker-not-vagrant"></a></p>
<h2 id="why-docker-not-vagrant">Why Docker not Vagrant!?</h2>
<p><a href="https://www.vagrantup.com">Vagrant</a> creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.</p>
<p>Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you <strong>lightweight</strong> Virtual Containers, that share the same kernel and allow to safely execute independent processes.</p>
<p>In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.</p>
<p>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).</p>
<p><a name="laradock-vs-homestead"></a></p>
<h2 id="laradock-vs-homestead-for-laravel-developers">LaraDock VS Homestead (For Laravel Developers)</h2>
<blockquote>
<p>LaraDock It’s like Laravel Homestead but for Docker instead of Vagrant.</p>
</blockquote>
<p>LaraDock and <a href="https://laravel.com/docs/master/homestead">Homestead</a> both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).</p>
<ul>
<li><p>Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.</p></li>
<li><p>LaraDock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.</p></li>
</ul>
<p>Running a virtual container is much faster than running a full virtual Machine. Thus <strong>LaraDock is much faster than Homestead</strong>.</p>
<p><a name="Demo"></a></p>
<h2 id="demo-video">Demo Video</h2>
<p>What’s better than a <strong>Demo Video</strong>:</p>
<ul>
<li>LaraDock <a href="https://www.youtube.com/watch?v=TQii1jDa96Y">v4.*</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=-DamFMczwDA">v2.*</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=jGkyO6Is_aI">v0.3</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=3YQsHe6oF80">v0.1</a></li>
</ul>
<p><a name="features"></a></p>
<h2 id="features">Features</h2>
<ul>
<li>Easy switch between PHP versions: 7.0, 5.6, 5.5…</li>
<li>Choose your favorite database engine: MySQL, Postgres, MariaDB…</li>
<li>Run your own combination of software: Memcached, HHVM, Beanstalkd…</li>
<li>Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI…</li>
<li>Easy to customize any container, with simple edit to the <code>Dockerfile</code>.</li>
<li>All Images extends from an official base Image. (Trusted base Images).</li>
<li>Pre-configured NGINX for Laravel.</li>
<li>Easy to apply configurations inside containers.</li>
<li>Clean and well structured Dockerfiles (<code>Dockerfile</code>).</li>
<li>Latest version of the Docker Compose file (<code>docker-compose</code>).</li>
<li>Everything is visible and editable.</li>
<li>Fast Images Builds.</li>
<li>More to come every week..</li>
</ul>
<p><a name="Supported-Containers"></a></p>
<h2 id="supported-software-containers">Supported Software (Containers)</h2>
<ul>
<li><strong>Database Engines:</strong>
<ul>
<li>MySQL</li>
<li>PostgreSQL</li>
<li>MariaDB</li>
<li>MongoDB</li>
<li>Neo4j</li>
<li>RethinkDB</li>
</ul></li>
<li><strong>Cache Engines:</strong>
<ul>
<li>Redis</li>
<li>Memcached</li>
<li>Aerospike</li>
</ul></li>
<li><strong>PHP Servers:</strong>
<ul>
<li>NGINX</li>
<li>Apache2</li>
<li>Caddy</li>
</ul></li>
<li><strong>PHP Compilers:</strong>
<ul>
<li>PHP-FPM</li>
<li>HHVM</li>
</ul></li>
<li><strong>Message Queuing Systems:</strong>
<ul>
<li>Beanstalkd</li>
<li>Beanstalkd Console</li>
<li>RabbitMQ</li>
<li>RabbitMQ Console</li>
</ul></li>
<li><strong>Tools:</strong>
<ul>
<li>PhpMyAdmin</li>
<li>PgAdmin</li>
<li>ElasticSearch</li>
<li>Selenium</li>
<li>Workspace
<ul>
<li>PHP7-CLI</li>
<li>Composer</li>
<li>Git</li>
<li>Linuxbrew</li>
<li>Node</li>
<li>Gulp</li>
<li>SQLite</li>
<li>xDebug</li>
<li>Envoy</li>
<li>Deployer</li>
<li>Vim</li>
<li>Yarn</li>
<li>… Many other supported tools are not documented. (Will be updated soon)</li>
</ul></li>
</ul></li>
</ul>
<blockquote>
<p>If you can’t find your Software, build it yourself and add it to this list. Contributions are welcomed :)</p>
</blockquote>
<p><a name="Chat"></a></p>
<h2 id="chat-with-us">Chat with us</h2>
<p>You are welcome to join our chat room on Gitter.</p>
<p><a href="https://gitter.im/LaraDock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img src="https://badges.gitter.im/LaraDock/laradock.svg" alt="Gitter" /></a></p>
<h1>Getting Started </h1>
<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>>= 1.12</code></li>
</ul>
<h2 id="installation">Installation</h2>
<p>Choose the setup the best suits your needs.</p>
<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">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>
<p>1 - Clone this repository on your project root directory:</p>
<pre><code class="language-bash">git submodule add https://github.com/Laradock/laradock.git
</code></pre>
<p><em>Note 1: If you are not yet using Git for your PHP project, you can use <code>git clone https://github.com/Laradock/laradock.git</code> instead.</em></p>
<p><em>Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. <a href="#keep-tracking-LaraDock">Check this</a></em></p>
<p><em>Note 3: In this case the folder structure will be like this:</em></p>
<pre><code>- project1
- laradock
- project2
- laradock
</code></pre>
<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>1 - Clone this repository anywhere on your machine:</p>
<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>
<p>Note: In this case the folder structure will be like this:</p>
<pre><code>- projects
- laradock
- myProject
</code></pre>
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../myProject:/var/www</code>).</p>
<p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
<pre><code>docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ ....
</code></pre>
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
<p>1 - Clone this repository anywhere on your machine:</p>
<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your projects directories:</p>
<pre><code> applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../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>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>
<p>5 - Open the <code>project1.conf</code> file and edit the <code>server_name</code> and the <code>root</code> as follow:</p>
<pre><code> server_name project1.dev;
root /var/www/project1/public;
</code></pre>
<p>Do the same for each project <code>project2.conf</code>, <code>project3.conf</code>,…</p>
<p>6 - Add the domains to the <strong>hosts</strong> files.</p>
<pre><code>127.0.0.1 project1.dev
</code></pre>
<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>
<h2 id="usage">Usage</h2>
<p><strong>Read Before starting:</strong></p>
<p>If you are using <strong>Docker Toolbox</strong> (VM), do one of the following:</p>
<ul>
<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="#upgrading-laradock">Upgrading LaraDock</a></li>
<li>Use LaraDock v3.* (Visit the <code>LaraDock-ToolBox</code> <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">Branch</a>).</li>
</ul>
<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>
</blockquote>
<p><br></p>
<p>1 - Run Containers: <em>(Make sure you are in the <code>laradock</code> folder before running the <code>docker-compose</code> commands).</em></p>
<p><strong>Example:</strong> Running NGINX and MySQL:</p>
<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>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>
<pre><code class="language-bash">docker-compose exec workspace bash
</code></pre>
<p>Alternatively, for Windows PowerShell users: execute the following command to enter any running container:</p>
<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><br>
3 - Edit your project configurations.</p>
<p>Open your <code>.env</code> file and set the <code>DB_HOST</code> to <code>mysql</code>:</p>
<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><br>
4 - Open your browser and visit your localhost address (<code>http://localhost/</code>).</p>
<p><br>
<strong>Debugging</strong>: if you are facing any problem here check the <a href="#debugging">Debugging</a> section.</p>
<p>If you need a special support. Contact me, more details in the <a href="#Help">Help & Questions</a> section.</p>
<h1>Documentation </h1>
<p><a name="List-current-running-Containers"></a></p>
<h2 id="list-current-running-containers">List current running Containers</h2>
<pre><code class="language-bash">docker ps
</code></pre>
<p>You can also use the following command if you want to see only this project containers:</p>
<pre><code class="language-bash">docker-compose ps
</code></pre>
<p><br>
<a name="Close-all-running-Containers"></a></p>
<h2 id="close-all-running-containers">Close all running Containers</h2>
<pre><code class="language-bash">docker-compose stop
</code></pre>
<p>To stop single container do:</p>
<pre><code class="language-bash">docker-compose stop {container-name}
</code></pre>
<p><br>
<a name="Delete-all-existing-Containers"></a></p>
<h2 id="delete-all-existing-containers">Delete all existing Containers</h2>
<pre><code class="language-bash">docker-compose down
</code></pre>
<p><br>
<a name="Enter-Container"></a></p>
<h2 id="enter-a-container-run-commands-in-a-running-container">Enter a Container (run commands in a running Container)</h2>
<p>1 - First list the current running containers with <code>docker ps</code></p>
<p>2 - Enter any container using:</p>
<pre><code class="language-bash">docker-compose exec {container-name} bash
</code></pre>
<p><em>Example: enter MySQL container</em></p>
<pre><code class="language-bash">docker-compose exec mysql bash
</code></pre>
<p><em>Example: enter to MySQL prompt within MySQL container</em></p>
<pre><code class="language-bash">docker-compose exec mysql mysql -u homestead -psecret
</code></pre>
<p>3 - To exit a container, type <code>exit</code>.</p>
<p><br>
<a name="Edit-Container"></a></p>
<h2 id="edit-default-container-configuration">Edit default container configuration</h2>
<p>Open the <code>docker-compose.yml</code> and change anything you want.</p>
<p>Examples:</p>
<p>Change MySQL Database Name:</p>
<pre><code class="language-yml"> environment:
MYSQL_DATABASE: laradock
...
</code></pre>
<p>Change Redis default port to 1111:</p>
<pre><code class="language-yml"> ports:
- "1111:6379"
...
</code></pre>
<p><br>
<a name="Edit-a-Docker-Image"></a></p>
<h2 id="edit-a-docker-image">Edit a Docker Image</h2>
<p>1 - Find the <code>Dockerfile</code> of the image you want to edit,
<br>
example for <code>mysql</code> it will be <code>mysql/Dockerfile</code>.</p>
<p>2 - Edit the file the way you want.</p>
<p>3 - Re-build the container:</p>
<pre><code class="language-bash">docker-compose build mysql
</code></pre>
<p>More info on Containers rebuilding <a href="#Build-Re-build-Containers">here</a>.</p>
<p><br>
<a name="Build-Re-build-Containers"></a></p>
<h2 id="build-re-build-containers">Build/Re-build Containers</h2>
<p>If you do any change to any <code>Dockerfile</code> make sure you run this command, for the changes to take effect:</p>
<pre><code class="language-bash">docker-compose build
</code></pre>
<p>Optionally you can specify which container to rebuild (instead of rebuilding all the containers):</p>
<pre><code class="language-bash">docker-compose build {container-name}
</code></pre>
<p>You might use the <code>--no-cache</code> option if you want full rebuilding (<code>docker-compose build --no-cache {container-name}</code>).</p>
<p><br>
<a name="Add-Docker-Images"></a></p>
<h2 id="add-more-software-docker-images">Add more Software (Docker Images)</h2>
<p>To add an image (software), just edit the <code>docker-compose.yml</code> and add your container details, to do so you need to be familiar with the <a href="https://docs.docker.com/compose/compose-file/">docker compose file syntax</a>.</p>
<p><br>
<a name="View-the-Log-files"></a></p>
<h2 id="view-the-log-files">View the Log files</h2>
<p>The NGINX Log file is stored in the <code>logs/nginx</code> directory.</p>
<p>However to view the logs of all the other containers (MySQL, PHP-FPM,…) you can run this:</p>
<pre><code class="language-bash">docker logs {container-name}
</code></pre>
<p><br>
<a name="PHP"></a></p>
<p><a name="Install-PHP-Extensions"></a></p>
<h2 id="install-php-extensions">Install PHP Extensions</h2>
<p>Before installing PHP extensions, you have to decide whether you need for the <code>FPM</code> or <code>CLI</code> because each lives on a different container, if you need it for both you have to edit both containers.</p>
<p>The PHP-FPM extensions should be installed in <code>php-fpm/Dockerfile-XX</code>. <em>(replace XX with your default PHP version number)</em>.
<br>
The PHP-CLI extensions should be installed in <code>workspace/Dockerfile</code>.</p>
<p><br>
<a name="Change-the-PHP-FPM-Version"></a></p>
<h2 id="change-the-php-fpm-version">Change the (PHP-FPM) Version</h2>
<p>By default <strong>PHP-FPM 7.0</strong> is running.</p>
<blockquote>
<p>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.</p>
</blockquote>
<h3 id="a-switch-from-php-7-0-to-php-5-6">A) Switch from PHP <code>7.0</code> to PHP <code>5.6</code></h3>
<p>1 - Open the <code>docker-compose.yml</code>.</p>
<p>2 - Search for <code>Dockerfile-70</code> in the PHP container section.</p>
<p>3 - Change the version number, by replacing <code>Dockerfile-70</code> with <code>Dockerfile-56</code>, like this:</p>
<pre><code class="language-yml"> php-fpm:
build:
context: ./php-fpm
dockerfile: Dockerfile-70
...
</code></pre>
<p>4 - Finally rebuild the container</p>
<pre><code class="language-bash">docker-compose build php-fpm
</code></pre>
<blockquote>
<p>For more details about the PHP base image, visit the <a href="https://hub.docker.com/_/php/">official PHP docker images</a>.</p>
</blockquote>
<h3 id="b-switch-from-php-7-0-or-5-6-to-php-5-5">B) Switch from PHP <code>7.0</code> or <code>5.6</code> to PHP <code>5.5</code></h3>
<p>We do not natively support PHP 5.5 anymore, but you can get it in few steps:</p>
<p>1 - Clone <code>https://github.com/laradock/php-fpm</code>.</p>
<p>3 - Rename <code>Dockerfile-56</code> to <code>Dockerfile-55</code>.</p>
<p>3 - Edit the file <code>FROM php:5.6-fpm</code> to <code>FROM php:5.5-fpm</code>.</p>
<p>4 - Build an image from <code>Dockerfile-55</code>.</p>
<p>5 - Open the <code>docker-compose.yml</code> file.</p>
<p>6 - Point <code>php-fpm</code> to your <code>Dockerfile-55</code> file.</p>
<p><br>
<a name="Change-the-PHP-CLI-Version"></a></p>
<h2 id="change-the-php-cli-version">Change the PHP-CLI Version</h2>
<p>By default <strong>PHP-CLI 7.0</strong> is running.</p>
<blockquote>
<p>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.</p>
</blockquote>
<p>The PHP-CLI is installed in the Workspace container. To change the PHP-CLI version you need to edit the <code>workspace/Dockerfile</code>.</p>
<p>Right now you have to manually edit the <code>Dockerfile</code> or create a new one like it’s done for the PHP-FPM. (consider contributing).</p>
<p><br>
<a name="Install-xDebug"></a></p>
<h2 id="install-xdebug">Install xDebug</h2>
<p>1 - First install <code>xDebug</code> in the Workspace and the PHP-FPM Containers:
<br>
a) open the <code>docker-compose.yml</code> file
<br>
b) search for the <code>INSTALL_XDEBUG</code> argument under the Workspace Container
<br>
c) set it to <code>true</code>
<br>
d) search for the <code>INSTALL_XDEBUG</code> argument under the PHP-FPM Container
<br>
e) set it to <code>true</code></p>
<p>It should be like this:</p>
<pre><code class="language-yml"> workspace:
build:
context: ./workspace
args:
- INSTALL_XDEBUG=true
...
php-fpm:
build:
context: ./php-fpm
args:
- INSTALL_XDEBUG=true
...
</code></pre>
<p>2 - Re-build the containers <code>docker-compose build workspace php-fpm</code></p>
<p>3 - Open <code>laradock/workspace/xdebug.ini</code> and/or <code>laradock/php-fpm/xdebug.ini</code> and enable at least the following configurations:</p>
<pre><code>xdebug.remote_autostart=1
xdebug.remote_enable=1
xdebug.remote_connect_back=1
</code></pre>
<p>For information on how to configure xDebug with your IDE and work it out, check this <a href="https://github.com/LarryEitel/laravel-laradock-phpstorm">Repository</a>.</p>
<p><br>
<a name="Control-xDebug"></a></p>
<h2 id="start-stop-xdebug">Start/Stop xDebug:</h2>
<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>
<ul>
<li>Stop xDebug from running by default: <code>./xdebugPhpFpm stop</code>.</li>
<li>Start xDebug by default: <code>./xdebugPhpFpm start</code>.</li>
<li>See the status: <code>./xdebugPhpFpm status</code>.</li>
</ul>
<p>Note: If <code>./xdebugPhpFpm</code> doesn’t execute and gives <code>Permission Denied</code> error the problem can be that file <code>xdebugPhpFpm</code> doesn’t have execution access. This can be fixed by running <code>chmod</code> command with desired access permissions.</p>
<p><br>
<a name="Install-Deployer"></a></p>
<h2 id="install-deployer-deployment-tool-for-php">Install Deployer (Deployment tool for PHP)</h2>
<p>1 - Open the <code>docker-compose.yml</code> file
<br>
2 - Search for the <code>INSTALL_DEPLOYER</code> argument under the Workspace Container
<br>
3 - Set it to <code>true</code>
<br></p>
<p>It should be like this:</p>
<pre><code class="language-yml"> workspace:
build:
context: ./workspace
args:
- INSTALL_DEPLOYER=true
...
</code></pre>
<p>4 - Re-build the containers <code>docker-compose build workspace</code></p>
<p><a href="https://deployer.org/docs"><strong>Deployer Documentation Here</strong></a></p>
<p><br>
<a name="Production"></a></p>
<p><br>
<a name="LaraDock-for-Production"></a></p>
<h2 id="prepare-laradock-for-production">Prepare LaraDock for Production</h2>