<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[8832] sites/trunk/wordcamp.org/.docker/readme.md: WC Docker: Changes in `readme.md` file for clear and easy instructions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/8832">8832</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/8832","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>vedjain</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-05-20 11:53:47 +0000 (Mon, 20 May 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>WC Docker: Changes in `readme.md` file for clear and easy instructions.
This patch documents multiple `docker-compose` shortcuts that will be frequently used.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgdockerreadmemd">sites/trunk/wordcamp.org/.docker/readme.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgdockerreadmemd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/.docker/readme.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/.docker/readme.md 2019-05-20 11:53:41 UTC (rev 8831)
+++ sites/trunk/wordcamp.org/.docker/readme.md 2019-05-20 11:53:47 UTC (rev 8832)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,10 +11,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> 1. Change into the directory, and run docker compose command. This could take some time depending upon the internet speed.
</span><span class="cx" style="display: block; padding: 0 10px"> ```
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- cd wordcamp.org && docker-compose up --build
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ cd wordcamp.org && docker-compose up --build -d
</ins><span class="cx" style="display: block; padding: 0 10px"> ```
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- This will also start the docker environment for WordCamp.org development.
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ This will also start the docker environment for WordCamp.org development. At the end of the process, you should see these messages:
+ ```bash
+ Creating wordcamporg_wordcamp.db_1 ... done
+ Creating wordcamporg_wordcamp.test_1 ... done
+ ```
+
</ins><span class="cx" style="display: block; padding: 0 10px"> 1. Add the following resolutions to your host file:
</span><span class="cx" style="display: block; padding: 0 10px"> ```
</span><span class="cx" style="display: block; padding: 0 10px"> 127.0.0.1 central.wordcamp.test
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,19 +28,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 127.0.0.1 2014.new-site.wordcamp.test
</span><span class="cx" style="display: block; padding: 0 10px"> ```
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- `/wp-admin` pages for these sites should now be accessible. Use `admin` as username and `password` as password to login.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ `/wp-admin` pages for these sites should now be accessible. Use `admin` as username and `password` as password to login. Front end pages will not be accessible until you complete the remaining steps.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> **Note:** `https` URL scheme must be used to visit these sites. Security exception will be required in first time run.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-1. Basic installation comes without themes and with only very basic plugins. Add plugins and themes which are installed in wordcamp.org if needed like so:
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+1. The installation doesn't have any 3rd-party plugins or themes yet, you must add them like so:
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 1. Find the docker which is running WordCamp. It will start with `wordcamporg_wordcamp.test` and will most likely be `wordcamporg_wordcamp.test_1`
-
- 1. Go inside this docker:
-
- **Note:** You might need to change `wordcamporg_wordcamp.test_1` to whatever is docker name in your setup.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 1. From the project directory, run this command to get inside the docker
</ins><span class="cx" style="display: block; padding: 0 10px"> ```bash
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- docker exec -it wordcamporg_wordcamp.test_1 bash
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ docker-compose exec wordcamp.test bash
</ins><span class="cx" style="display: block; padding: 0 10px"> ```
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> 1. Run predefined command for installing plugins and themes. This could take some time depending on your internet connection:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,13 +43,69 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ```bash
</span><span class="cx" style="display: block; padding: 0 10px"> sh install-plugin-theme.sh
</span><span class="cx" style="display: block; padding: 0 10px"> ```
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- 1. Activate plugin or apply theme as needed.
-
-1. By default, docker will start with data defined in `.docker/wordcamp_dev.sql` and changes to data will be persisted across runs in `.docker/database`. To start with different database, delete `.docker/database` directory and replace the `.docker/wordcamp_dev.sql` file and run `docker-compose up --build` again.
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+1. By default, docker will start with data defined in `.docker/wordcamp_dev.sql` and changes to data will be persisted across runs in `.docker/database`. To start with different database, delete `.docker/database` directory and replace the `.docker/wordcamp_dev.sql` file and run `docker-compose up --build -d` again.
+
</ins><span class="cx" style="display: block; padding: 0 10px"> 1. Note that if you want to work on WordCamp blocks, [you would have to install all the node dependencies](../public_html/wp-content/mu-plugins/blocks/readme.md). This can be done either inside, or even from outside the Docker.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-After first time provisioning, docker can be started by using `docker-compose up` command from inside the directory.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+#### Useful Docker Commands:
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+Note: All of these commands are meant to be executed from project directory.
+
+1. To start WordCamp docker containers, use:
+ ```bash
+ docker-compose up -d
+ ```
+
+ here `-d` flags directs docker to run in background.
+
+1. To view `nginx` and `php-logs` use:
+ ```bash
+ docker-compose logs -f --tail=100 wordcamp.test
+ ```
+
+ here
+
+ `-f` flag is used for consistently following the logs. Omit this to only dump the logs in terminal.
+
+ `--tail=100` flag is used to view only last `100` lines of log. Omit this if you'd like to see the entire log since docker started.
+
+ `wordcamp.test` is the name of the docker service which is running `nginx` and `php`
+
+ Similarly, to view MySQL server logs (note: this does not show MySQL queries made by application, these are just server logs), use:
+
+ ```bash
+ docker-compose logs -f --tail=100 wordcamp.db
+ ```
+
+ here
+
+ `wordcamp.db` is the name of docker service which is running MySQL server.
+
+1. To execute a command inside docker running `nginx` and `php`, use:
+
+ ```bash
+ docker-compose exec wordcamp.test bash
+ ```
+
+ here
+ `wordcamp.test` is the name of docker service running `nginx` and `php`
+ `bash` is the name of command that we want to execute. This particular command will give us shell access inside the docker.
+
+ Similarly, for MySQL, you can use:
+
+ ```bash
+ docker-compose exec wordcamp.db bash
+ ```
+
+ here
+ `wordcamp.db` is the name of docker service running MySQL server
+
+1. To stop the running docker containers, use the command like so:
+
+ ```bash
+ docker-compose stop
+ ```
+
+
</ins><span class="cx" style="display: block; padding: 0 10px"> Once the Docker instance has started, you can visit [2014.content.wordcamp.org](2014.content.wordcamp.org) to view a sample WordCamp site. WordCamp central would be [central.wordcamp.test](central.wordcamp.test). You can also visit [localhost:1080](localhost:1080) to view the MailCatcher dashboard.
</span></span></pre>
</div>
</div>
</body>
</html>