updated guide to include old hello.txt steps
[feisty_meow.git] / production / sites / cakelampvm.com / docs / manual / cakelampvm_guide_v002.html
index bf50c20e3468a752fab02f29a6cfeffb68949964..b324be4cb435056428d219846d6b11d7ba232390 100644 (file)
@@ -9,7 +9,7 @@
       Configuration and Usage</h1>
     <h2 style=" text-align: center;">By Chris Koeritz</h2>
     <h3 style="   text-align: center;"> Vintage: cakelampvm v002 &nbsp;&nbsp;
-      Updated: 2017-11-16 (rev D)</h3>
+      Updated: 2017-11-20 (rev F)</h3>
     <p>The cakelampvm project provides a Virtualbox VM that acts as an "internet
       in a bottle".&nbsp; The virtual machine provides DNS services (<a title="dns server"
         href="http://www.bind9.net/">bind9</a>), a Web server (<a title="patchy"
@@ -29,8 +29,8 @@
       ssh session more convenient, because copy &amp; paste features work as
       expected.</p>
     <p>Commands preceded by a greater-than symbol ('&gt;') are intended to be
-      run on the Host PC in a Windows command prompt (or in a bash prompt running
-      on the Host PC).</p>
+      run on the Host PC in a Windows command prompt (or in a bash prompt
+      running on the Host PC).</p>
     <h2> Guest VM Configuration<a id="#config" name="#config"></a></h2>
     <ul>
       <li>Hostname: <a title="the vm's website, when configured properly" href="https://cakelampvm.com/">cakelampvm.com</a></li>
@@ -153,9 +153,9 @@ meow
       before bringing up a black console window with a login dialog.</p>
     <p>If Windows complains about the Virtualbox application slamming into its
       firewall, then allow the Virtualbox to get through.&nbsp; Usually, telling
-      Windows that once is enough, but if any odd network access problems result,
-      edit the Windows firewall settings and allow Virtualbox to use both
-      "Public" and "Private" networks.</p>
+      Windows that once is enough, but if any odd network access problems
+      result, edit the Windows firewall settings and allow Virtualbox to use
+      both "Public" and "Private" networks.</p>
     <p>You can log in directly on the VM console with the developer account, but
       it is generally more useful to connect to the cakelampvm over ssh.&nbsp;
       If the networking has been established properly, you should be able to do
@@ -177,8 +177,8 @@ meow
     <p>There is an update feature built into the VM that is quite easy to
       use.&nbsp; The updates are driven by the feisty meow script repository in
       conjunction with a local scripted command.&nbsp; To activate the "update
-      process" for your VM, run the following commands (without the initial '#'
-      symbol):</p>
+      process" for your VM, run the following commands on the VM (without the
+      initial '#' symbol):</p>
     <p># rpuffer $FEISTY_MEOW_APEX&nbsp;&nbsp; # updates to the latest version
       of feisty meow<br>
       # revamp_cakelampvm&nbsp;&nbsp;&nbsp; # enacts any configuration changes
@@ -189,6 +189,24 @@ meow
       the latest version of the feisty meow code.&nbsp; If there are bug fixes
       you need for the scripts or you want updated cakelampvm documentation,
       that is the command to use.</p>
+    <h2>First Tasks as the Developer User</h2>
+    <p>Here are some first steps that will make the vm your own:</p>
+    <ol>
+      <li>Change your password for the developer account.&nbsp; (This may
+        eventually be required and automatic.)&nbsp; First, log into the VM with
+        ssh.&nbsp; Then type this command:<br>
+        <pre># passwd</pre>
+        The 'passwd' command will ask for your current password, and then for a
+        new password plus a verification of that new password.<br>
+        &nbsp;</li>
+      <li>Change your git configuration for the user and email address.&nbsp; This
+        is how we've configured it so far:<br>
+        <pre># git config --global user.email "developer@cakelampvm.com"</pre>
+        <pre># git config --global user.name "Developer J. Cakemo"</pre>
+        If you're developing on a real project, you probably don't want the
+        bogus email and even more bogus name above attached to your
+        commits.&nbsp; Just run the two commands again but with proper values.</li>
+    </ol>
     <h2>Using the guest VM's DNS services<a id="#dns-from-vm" name="#dns-from-vm"></a></h2>
     <p>The cakelampvm has been set up to provide a DNS server which will answer
       name lookup requests on any of the sites that the cakelampvm is hosting
@@ -213,7 +231,8 @@ meow
     <p>Once the DNS server is properly set up (by whatever means necessary),
       these ping commands should get answering responses (from 10.28.42.20) on
       both the cakelampvm VM and on your host PC.&nbsp; Note: ping on Linux
-      keeps going forever, so hit control-C when you are tired of seeing the pings:</p>
+      keeps going forever, so hit control-C when you are tired of seeing the
+      pings:</p>
     <pre># ping cakelampvm.com</pre>
     <pre># ping mapsdemo.cakelampvm.com</pre>
     <p>Note that any other answer than 10.28.42.20 for the address is *bzzzt*
@@ -376,7 +395,7 @@ meow
     <pre># sudo service bind9 restart</pre>
     <p>Afterwards, pinging excalibur.tv should work from both the guest and the
       host.</p>
-    <h3>Creating a New Apache site</h3>
+    <h3>Creating a New Apache Site</h3>
     <p>First, connect to the cakelampvm via ssh as the developer user, e.g.: ssh
       developer@cakelampvm.com </p>
     <h4>Quick approach: Use the feisty meow "add_apache_site" command.</h4>
@@ -388,16 +407,17 @@ meow
     <h4>Manual approach: Edit an Apache config file</h4>
     <p>Note: the manual approach is not compatible with later use of feisty
       meow's "remove_apache_site".</p>
-    <p>For Apache, the choice of DNS Option A or B, subdomain or SLD does not
+    <p>For Apache, the choice of DNS Option A or B, subdomain or SLD, does not
       matter.&nbsp; The site configuration file just has to accurately specify
       the domain in question.</p>
     <p>Start with the following template file for the new website, and modify it
-      for the appropriate host name:</p>
+      for the appropriate host name and "DocumentRoot" path:</p>
     <pre>&lt;VirtualHost *:80&gt;<br>&nbsp;&nbsp;&nbsp; ServerName excalibur.tv
 &nbsp;&nbsp;&nbsp; DocumentRoot /home/apps/excalibur<br>&nbsp;&nbsp;&nbsp; ErrorLog ${APACHE_LOG_DIR}/excalibur.tv-error.log<br>&nbsp;&nbsp;&nbsp; CustomLog ${APACHE_LOG_DIR}/excalibur.tv-access.log combined<br>&nbsp;&nbsp;&nbsp; Include /etc/apache2/conf-library/basic-options.conf<br>&nbsp;&nbsp;&nbsp; Include /etc/apache2/conf-library/rewrite-enabling.conf<br>&lt;/VirtualHost&gt;</pre>
     <p>The above example is appropriate for our excalibur app in the
       excalibur.tv domain (using DNS Option B).&nbsp; Modifying the excalibur.tv
-      references in it is sufficient to retarget it for any domain you want.</p>
+      references in it (and the path in the DocumentRoot) is sufficient to
+      re-target it for any domain you want.</p>
     <p>Copy the new site config file into "/etc/apache2/sites-available" with an
       appropriate file name that includes the site's domain name.&nbsp; We will
       call our config file "excalibur.tv.conf".&nbsp; If you developed the file
@@ -417,42 +437,43 @@ meow
       it means the DNS is working.&nbsp; If there are no responses or it's some
       other IP address talking back, check the instructions in the above DNS
       sections.</p>
-    <p>Once the DNS is working, try browsing to the site at "http://excalibur.tv".&nbsp;
-      That should at least bring up the configured site storage path, even if
-      nothing is being served from that folder yet.</p>
+    <p>Once the DNS is working, try browsing to the site at
+      "http://excalibur.tv".&nbsp; That should at least bring up the configured
+      site storage path, even if nothing is being served from that folder yet.</p>
     <p>If the new site is not showing up properly, try examining the apache logs
-      for error messages that can be corrected.&nbsp; The log files are stored
-      in "/var/log/apache2" and are named after the website (if configured as
-      shown above).</p>
-    <h2>Handy Techniques</h2>
+      for any error messages that can be corrected.&nbsp; The log files are
+      stored in "/var/log/apache2" and are named after the website (if
+      configured through the above process).</p>
+    <h2>Handy Techniques for Using cakelampvm</h2>
     <h3>Assorted Guides and Cheat-Sheets</h3>
-    <p>Cheat sheet for Vim: <a title="vim commands" href="https://vim.rtorr.com/">https://vim.rtorr.com/</a></p>
-    <p>Git branching model that seems to work well: <a title="release and patch process"
+    <p>A Cheat sheet for the Vim editor (there are many of these available): <a
+        title="vim commands" href="https://vim.rtorr.com/">https://vim.rtorr.com/</a></p>
+    <p>A git branching model that seems to work well: <a title="release and patch process"
         href="http://nvie.com/posts/a-successful-git-branching-model/">http://nvie.com/posts/a-successful-git-branching-model/</a></p>
     <h3>Get the network address on the guest vm</h3>
     <p>Run this command: ifconfig</p>
     <p>In the results, look for "inet addr".&nbsp; There may be more than one,
       if there are multiple network interfaces.</p>
+    <p>The standard IP address is 10.28.42.20 for the cakelampvm.</p>
     <h3>How to cleanly reboot or shut down the guest VM</h3>
     <p>When you've got the DNS and everything integrated, these commands will
       manage the vm's state:</p>
-    <p>First, log into the guest VM: ssh developer@cakelampvm.com</p>
-    <p>Then, reboot the guest VM: sudo reboot</p>
-    <p>Or, halt the guest VM: sudo shutdown -h now</p>
-    <p>Using these commands is better than just cycling the power from the
-      Virtualbox control panel.</p>
-    <p><br>
-    </p>
-    <p><br>
-    </p>
+    <p>First, log into the guest VM:</p>
+    <pre># ssh developer@cakelampvm.com</pre>
+    <p>Then, to reboot the guest VM:</p>
+    <pre># sudo reboot</pre>
+    <p>Or, to halt the guest VM:</p>
+    <pre># sudo shutdown -h now</pre>
+    <p>Using these commands is kinder to the VM than just cycling the power from
+      the Virtualbox control panel.</p>
     <p><br>
     </p>
-    <h1>Gritty Details</h1>
+    <h1>Gritty Details of the Nitty Variety<a id="#nitty-gritty" name="#nitty-gritty"></a></h1>
     <p>This is the lowest level of plumbing for your VM.&nbsp; Hopefully you
-      will not need to engage with this section.&nbsp; The most useful area here
-      is the one below about the "Virtualbox guest additions", which you will
-      probably need at some future point.&nbsp; Oracle releases updates to the
-      guest additions fairly regularly.</p>
+      will not need to engage with this section.&nbsp; The most useful doc
+      section here is the one below about the "Virtualbox guest additions",
+      which you will probably need at some future point.&nbsp; Oracle releases
+      updates to the guest additions fairly regularly.</p>
     <h2>Configuring the guest VM</h2>
     <p>The guest VM should already be set up appropriately.&nbsp; These steps
       are provided for reference and updates.</p>