doc push
[feisty_meow.git] / production / sites / cakelampvm.com / docs / manual / cakelampvm_guide_v002.html
1 <!DOCTYPE html>
2 <html>
3   <head>
4     <meta content="text/html; charset=windows-1252" http-equiv="content-type">
5     <title>Cake LAMP VM Documentation</title>
6   </head>
7   <body>
8     <h1 style="text-align: center;">The cakelampvm VM:<br>
9       Configuration and Usage</h1>
10     <div style="text-align: center;"><span style="font-weight: bold;">By Chris
11         Koeritz</span><span style="font-family: Comic Sans MS;"></span><span style="font-family: Comic Sans MS;"></span><br>
12       <span style="font-family: Comic Sans MS;">feisty meow® concerns ltd</span>.</div>
13     <h3 style="   text-align: center;"> Vintage: cakelampvm v002 &nbsp;&nbsp;
14       Updated: 2017-12-19 (rev. h)</h3>
15     <p>The cakelampvm project provides a Virtualbox VM that acts as an "internet
16       in a bottle", serving up your web sites securely and only to your local
17       host.&nbsp; The virtual machine provides DNS services (<a target="_blank"
18         title="dns server" href="http://www.bind9.net/">bind9</a>), a Web server
19       (<a target="_blank" title="patchy" href="https://httpd.apache.org/">Apache2</a>),
20       a full <a target="_blank" title="ubuntu means compassion and humanity" href="https://www.ubuntu.com/">Ubuntu</a>
21       <a target="_blank" title="it's pronounced leenoox" href="https://www.linuxfoundation.org/">Linux</a>
22       desktop environment, the <a target="_blank" title="flux is change" href="http://fluxbox.org/">Fluxbox</a>
23       <a target="_blank" title="x11 -- best windowing system" href="https://www.x.org/">X
24         window manager</a>, and a suite of tools called the <a target="_blank"
25         title="feisty meow® concerns ltd. website" href="https://feistymeow.org/">Feisty
26         Meow® codebase</a> .&nbsp; Together, these services provide you with a
27       very flexible and powerful testbed for web development, especially suited
28       for <a target="_blank" title="it's cake" href="https://cakephp.org/">CakePHP</a>.&nbsp;
29       This VM was built with the assistance of and was partially funded by <a target="_blank"
30         title="saco design" href="http://sacodesign.com">Saco Design</a> of <a
31         target="_blank" title="winterport" href="http://www.winterportmaine.gov/">Winterport,
32         Maine</a>.</p>
33     <p>Commands in fixed-width bold below are intended to be typed into a bash
34       shell running on the cakelampvm virtual machine.&nbsp; The bash shell can
35       be obtained either by logging into the VM through ssh or by logging in
36       directly to the Virtualbox VM console.&nbsp; You may find the ssh session
37       more convenient, because copy &amp; paste features work as expected.</p>
38     <p>Commands preceded by a greater-than symbol ('&gt;') are intended to be
39       run on the Host PC in a Windows command prompt (or in a bash prompt
40       running on the Host PC).</p>
41     <h2> Guest VM Configuration<a id="#config" name="#config"></a></h2>
42     <ul>
43       <li>Hostname: <a target="_blank" title="the vm's website, when configured properly"
44           href="https://cakelampvm.com/">cakelampvm.com</a></li>
45       <li>Local IP Address: 10.28.42.20</li>
46       <li>Services Included: DNS (bind9), apache2, fluxbox X windowing system, <a
47           target="_blank" title="not just in the garden" href="https://www.gnome.org/">gnome
48           display manager</a></li>
49       <li>Main VM User: developer (password distributed separately)</li>
50       <li>Database Access: mysql root account, password: (password distributed
51         separately)</li>
52     </ul>
53     <h2>How to set up virtualbox for your host PC<a id="#virtualbox-setup" name="#virtualbox-setup"></a></h2>
54     <ol>
55       <li>Download and install virtualbox: <a target="_blank" href="https://www.virtualbox.org/wiki/Downloads">https://www.virtualbox.org/wiki/Downloads</a></li>
56       <li>Install the extension pack for Virtualbox: This provides USB drivers
57         and other features.&nbsp; This is installed on Virtualbox itself (on the
58         Host PC), not on the guests.</li>
59       <ol>
60         <li>Download the extension pack (also) at <a target="_blank" href="https://www.virtualbox.org/wiki/Downloads">https://www.virtualbox.org/wiki/Downloads</a></li>
61         <li>Stop any running Virtualbox VMs.</li>
62         <li>Close the Virtualbox control panel.</li>
63         <li>Double-click on the downloaded extensions package (in a file
64           explorer) and Virtualbox should be launched to install it.</li>
65       </ol>
66       <li>Run the Virtualbox control panel.</li>
67       <li>Download the cakelampvm guest vm package and unzip it.&nbsp; Store the
68         unzipped version in some appropriate place where you want the virtual
69         machine to reside on your host's hard drive.</li>
70       <li>Add the guest VM to your list of VMs.&nbsp; From the Virtualbox menus,
71         choose the "Machine" menu and select "Add".&nbsp; Point the selector
72         dialog at the cakelampvm folder you created above and open the
73         cakelampvm.vbox file.</li>
74       <li>Now the cakelampvm should show up in the list of virtual
75         machines.&nbsp; Before starting it, perform the following network
76         configuration sections.</li>
77     </ol>
78     <h3>Configure the Host-Only network on Virtualbox<a id="#host-only" name="#host-only"></a></h3>
79     <p>Configuring host-only networking for the VM makes the VM completely local
80       to your machine.&nbsp; The cakelampvm will not be accessible on the
81       internet or from the LAN, and can only be accessed by your host PC.&nbsp;
82       This is a key component of security for your VM and your host PC, and is
83       considered a crucial configuration step.</p>
84     <p>Note: If the host-only or NAT network exist ahead of time, Virtualbox may
85       complain about them even if they have the correct configuration.&nbsp;
86       This can be corrected simply by opening the cakelampvm settings and
87       selecting the appropriate network names again.</p>
88     <p>To configure the host-only network, follow these steps:</p>
89     <ol>
90       <li> Go to virtual box "Preferences" (global preferences, not for a
91         specific vm).</li>
92       <li> Click on the "Network" tab.</li>
93       <li> Choose the "Host-only Networks" tab from within "Network".</li>
94       <li> Click the plus icon to add a new host-only network, or if there is
95         already a Host-only network, then edit it.</li>
96       <li>Set the "Adapter" parameters:<br>
97         IPv4 Address: 10.28.42.1<br>
98         IPv4 Network Mask: 255.255.255.0<br>
99         IPv6 Address: (leave blank)<br>
100         IPv6 Prefix Length: 0<br>
101         Virtualbox will fill in the other details like so (this dialog may
102         differ between versions of virtualbox):<br>
103         <p><img alt="host only network adapter" src="images/host_only_network_adapter.png"></p>
104       </li>
105       <li>Set the "DHCP Server Settings" to disabled, e.g.<br>
106         <img alt="host only dhcp" src="images/host_only_adapter_dhcp_server.png"><br>
107         This is disabled because we will be using statically assigned addresses
108         for convenience and stability.</li>
109     </ol>
110     <p>Additional information on host-only (and other) network adapter types is
111       at: https://www.virtualbox.org/manual/ch06.html#network_nat_service</p>
112     <h3>Configure the NAT Network on Virtualbox<a id="#nat-network" name="#nat-network"></a></h3>
113     <p>The NAT (Network Address Translation) network allows the VM to get off of
114       the machine and onto the internet safely.&nbsp; It will use this interface
115       for any communication off of the host machine.&nbsp; This is another
116       crucial component for the security of the VM and your host PC.&nbsp; Since
117       the real IP address of the VM is hidden behind the NAT firewall on
118       Virtualbox, this keeps the VM safe from attackers, and hence your machine
119       stays safe as well.</p>
120     <p>To set up the NAT network, follow these steps:</p>
121     <ol>
122       <li> Go to virtual box "Preferences" (global preferences, not for a
123         specific vm).</li>
124       <li> Click on the "Network" tab.</li>
125       <li> Choose the "Nat Networks" tab from within "Network".</li>
126       <li> Click the plus icon to add a new host-only network.</li>
127       <li>Set the "NAT Network Details" parameters:<br>
128         Network Name: NatNetwork<br>
129         Network CIDR: 10.0.2.0/24<br>
130         Supports DHCP: checked<br>
131         Supports IPv6: optionally checked<br>
132         These are my settings, with IPv6 left disabled (this dialog may differ
133         between versions of virtualbox):<br>
134         <img alt="nat net config" src="images/nat_network_config.png"></li>
135     </ol>
136     <h2>Starting up the VM and Connecting to It<a id="#start-vm" name="#start-vm"></a></h2>
137     <p>Using the Virtualbox interface, you should now be able to start your
138       virtual machine.&nbsp; Virtualbox will complain if it detects any
139       remaining configuration problems in the VM.&nbsp; The Linux boot sequence
140       will show many lines of text, before bringing up a black console window
141       with a login dialog.</p>
142     <p>If Windows complains about the Virtualbox application slamming into its
143       firewall, then allow the Virtualbox to get through.&nbsp; Usually, telling
144       Windows that once is enough, but if any odd network access problems
145       result, edit the Windows firewall settings and allow Virtualbox to use
146       both "Public" and "Private" networks.&nbsp; (Cortana can find the firewall
147       settings if you ask her about 'firewall'.&nbsp; Within the firewall
148       configuration dialog, look for "Allow an app or feature through..." on the
149       left and configure Virtualbox from within that list.)</p>
150     You can log in directly on the VM console with the developer account, but it
151     is generally more useful to connect to the cakelampvm over ssh.&nbsp; If the
152     networking has been established properly, you should be able to do this
153     with:
154     <pre><span style="font-weight: bold;">ssh developer@10.28.42.20<br># or perform the equivalent connection with your ssh client.</span></pre>
155     <p>And then provide the password to log in.</p>
156     <p>Once the DNS services are set up (discussed in detail below), you will be
157       able to run the much friendlier command:</p>
158     <pre><span style="font-weight: bold;">ssh developer@cakelampvm.com</span></pre>
159     <h4>Key Forwarding to the VM</h4>
160     <p>It is important to set up ssh key forwarding to enable your use of git
161       repositories while logged into the VM.&nbsp; Key forwarding should be
162       enabled for the VM's two fake host identities:</p>
163     <pre><span style="font-weight: bold;">cakelampvm.com<br>10.28.42.20</span></pre>
164     <h2>Updating cakelampvm to the Latest Model<a id="#update-vm" name="#update-vm"></a></h2>
165     <p>The cakelampvm v002 is released with the intention that it not need to be
166       released again.&nbsp; Version 001 was not built with that explicit
167       intention, which then required the release of Version 002.&nbsp; But we
168       hope to not need a v003 release...</p>
169     <p>There is an update feature built into the VM that is quite easy to
170       use.&nbsp; The updates are driven by the feisty meow script repository in
171       conjunction with a local scripted command.&nbsp; To activate the "update
172       process" for your VM, run the following commands on the VM:</p>
173     <pre><span style="font-weight: bold;"># update to the latest version of feisty meow.<br>rpuffer $FEISTY_MEOW_APEX; reconfigure_feisty_meow<br># enact any configuration changes needed, such as permissions and account setup.
174 revamp_cakelampvm</span></pre>
175     <span style="font-weight: bold;"> </span>
176     <p>These two commands can be run at any time to patch up your VM to the
177       latest.</p>
178     <p>Recent versions of feisty meow support a new "<span style="font-weight: bold; font-family: monospace;">get_feisty</span>"
179       command, which will behave the same as the first line above.&nbsp; Once
180       you have run the "puffer..." command above for the first time (on
181       cakelampvm v002), this new command becomes available.</p>
182     <ul>
183       <li>The "<span style="font-weight: bold; font-family: monospace;">get_feisty</span>"
184         command is useful in its own right for getting the latest version of the
185         feisty meow code; run it again if you need bug fixes or if you want the
186         most recent cakelampvm documentation.</li>
187       <li>The "<span style="font-weight: bold; font-family: monospace;">revamp_cakelampvm</span>"
188         command can be used to repair many situations when the cakelampvm has
189         gone astray, especially for problems with permissions.</li>
190     </ul>
191     <h2>First Tasks as the Developer User</h2>
192     <p>Here are some first steps that will make the vm your own:</p>
193     <ol>
194       <li>Change your password for the developer account.&nbsp; (This may
195         eventually be required and automatic.)&nbsp; First, log into the VM with
196         ssh.&nbsp; Then type this command:<br>
197         <pre><span style="font-weight: bold;">passwd</span></pre>
198         The 'passwd' command will ask for your current password, and then for a
199         new password plus a verification of that new password.<br>
200         &nbsp;</li>
201       <li>Change your git configuration for the user and email address.&nbsp;
202         This is how we've configured it so far:<br>
203         <ul>
204           <li>
205             <pre><span style="font-weight: bold;">git config --global user.email "developer@cakelampvm.com"</span></pre>
206           </li>
207           <li>
208             <pre><span style="font-weight: bold;">git config --global user.name "Developer J. Cakemo"</span></pre>
209           </li>
210         </ul>
211         If you're developing on a real project, you probably don't want the
212         bogus email and even more bogus name above attached to your
213         commits.&nbsp; Just run the two commands again but with proper values.</li>
214     </ol>
215     <h2>Powering up with the Feisty Meow® scripts<a id="#powerup" name="#powerup"></a></h2>
216     The feisty meow scripts are a cohesive bash scripting environment for
217     getting a variety of tasks done.&nbsp; The feisty meow scripts recently
218     incorporated the "avbash" collection from Saco Design and added those
219     scripts to a new "site_avenger" collection of scripts.&nbsp; The site
220     avenger scripts provide tools for bringing up CakePHP web sites and managing
221     the collection of repositories for those sites.&nbsp; Each website is
222     considered an "application", and the application name itself (e.g.
223     "winterportlibrary") can often provide all the details for "powering up" the
224     site.&nbsp; The feisty meow team has added additional scripts for managing
225     DNS domains and Apache websites that provide the capability to "stand up" an
226     entire website around an application, with an accompanying DNS domain and an
227     Apache2 site definition.
228     <p>The site avenger scripts are documented separately within the feisty meow
229       codebase.&nbsp; Consult the <span style="text-decoration: underline;">f</span><a
230         target="_blank" title="quickstart" href="https://feistymeow.org/feisty_meow/readme.txt">eisty
231 meow
232         readme</a> file first, as it provides some valuable information on
233       configuring the codebase initially.&nbsp; The site avenger script commands
234       are documented in the <a target="_blank" title="useful commands" href="https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt">feisty
235         meow command reference</a> file.</p>
236     <p>(The feisty meow codebase is already configured for the developer account
237       on the cakelampvm virtual machine.)</p>
238     <h2>Using the guest VM's DNS services<a id="#dns-from-vm" name="#dns-from-vm"></a></h2>
239     <p>The cakelampvm has been set up to provide a DNS server which will answer
240       name lookup requests on any of the sites that the cakelampvm is hosting
241       for you.&nbsp; It will also serve as a general DNS server for any other
242       domains that need to be looked up.</p>
243     <p>To use the cakelampvm DNS, modify your host operating system network
244       configuration by adding or changing the DNS server to use the guest VM's
245       DNS service.&nbsp; The cakelampvm is available at the local IP address
246       10.28.42.20.&nbsp; (The DNS server can be tested with nslookup, dig and
247       other tools.)</p>
248     <p>Note that the cakelampvm DNS should be listed first, if one intends to
249       override any DNS names that actually exist out on the internet.&nbsp;
250       Further, we have found it most effective to have *only* the cakelampvm as
251       your DNS server, because a secondary DNS server can "take over" providing
252       the name lookups, and thus foul up DNS requests that should succeed for
253       your VM-hosted sites.</p>
254     <p>If your Host PC is running Windows, see the DNS configuration section
255       below that is tailored to that operating system.</p>
256     <p>Important Note: It behooves you to remember to switch back to a normal
257       DNS server configuration when you shut off the cakelampvm, or your machine
258       will not know the names of any sites on the internet any more!&nbsp; The
259       official Google DNS servers are 8.8.8.8 and 8.8.4.4.</p>
260     <p>Once the DNS server is properly set up (by whatever means necessary),
261       these ping commands should get answering responses (from 10.28.42.20) on
262       both the cakelampvm VM and on your host PC.&nbsp; Note: ping on Linux
263       keeps going forever, so hit control-C when you are tired of seeing the
264       pings:</p>
265     <pre><span style="font-weight: bold;">ping cakelampvm.com</span></pre>
266     <span style="font-weight: bold;"> </span>
267     <pre><span style="font-weight: bold;">ping www.cakelampvm.com</span></pre>
268     <p>Note that any other answer than 10.28.42.20 for the address is *bzzzt*
269       wrong, and means something needs to be fixed.</p>
270     <p>If these pings succeed (which hopefully they will!), then try accessing
271       the websites of each domain:</p>
272     <pre>(browse to) <a target="_blank" title="vm website if dns working" href="http://cakelampvm.com">http://cakelampvm.com</a></pre>
273     <pre>(browse to) <a target="_blank" title="mapsdemo app, hopefully functional"
274 href="http://mapsdemo.cakelampvm.com">http://mapsdemo.cakelampvm.com</a></pre>
275     <p>These should show local sites on the VM rather than sites on the
276       internet.&nbsp; If you instead get failures to find the domains, or if the
277       "real internet" site comes up for cakelampvm.com (the page covered with
278       red X marks and complaining), then the DNS is not hooked up properly yet.</p>
279     <h4>Setting up DNS on Windows<a id="#windoze-dns" name="#windoze-dns"></a></h4>
280     <p>The ipconfig tool will provide helpful information about your current
281       networking and DNS configuration:</p>
282     <pre>&gt; ipconfig /all</pre>
283     <p>The DNS configuration on Windows is somewhat byzantine.&nbsp; The pipe
284       characters ('|') below are used to separate the menus or tabs or dialogs
285       to traverse.&nbsp; Follow this path to get to the DNS config:</p>
286     <pre>Control Panel | Network &amp; Internet | Network &amp; Sharing | click WiFI or Ethernet link near top right | click Adapter Settings button...<br>  &nbsp;| click on the specific network device to modify | select Properties</pre>
287     <p>Once the properties dialog is displayed, find "internet protocol version
288       4" in the list and double click it.</p>
289     <p>Change the DNS setting from "obtain...automatically" to "use the
290       following dns addresses".</p>
291     <p>Enter 10.28.42.20 as the first DNS address and clear the second address
292       (all blanks).</p>
293     <p>Hit okay, then okay, then close, etc to back out of adapter
294       configuration.</p>
295     <h4>Troubleshooting the DNS</h4>
296     <p>If your pings are getting the wrong answers and you're certain the DNS
297       settings on your Host PC are right, then you may need to flush your DNS
298       cache, and that might be sufficient to start getting the right IP
299       address.&nbsp; On Windows, the command for flushing DNS is:</p>
300     <pre>&gt; ipconfig /flushdns</pre>
301     <p>and on Linux the flush DNS command can be many different things, but try
302       these two most common options:</p>
303     <pre><span style="font-weight: bold;"># restarts the client side DNS cache.<br>sudo service dns-clean restart</span></pre>
304     <p>or</p>
305     <pre><span style="font-weight: bold;"># restarts the nscd caching server.<br>sudo service nscd restart</span></pre>
306     After, this try the pings again.&nbsp; If they still fail, please go back
307     over your DNS configuration very carefully.&nbsp; The cakelampvm's DNS
308     feature *does* actually work, but operating systems sometimes do their best
309     to deny this.<br>
310     <h4>Host Key Issues for ssh</h4>
311     <p>There is one caveat to be aware of when connecting to the cakelampvm.com
312       domain.&nbsp; If you have accidentally added the "real" cakelampvm.com
313       domain from the internet to your ssh known_keys at some point, then ssh
314       will complain about connecting to the VM on the cakelampvm.com
315       domain.&nbsp; This complaint will look like:</p>
316     <pre>The authenticity of host 'cakelampvm.com (104.236.56.82)' can't be established.</pre>
317     <p>Note that the IP address shown is not our beloved 10.28.42.20 local IP
318       address.</p>
319     <p>To fix this, remove the entry pointing at the "real" site from the
320       known_hosts file (ssh will print out the line number of the offending
321       entry).&nbsp; The DNS configuration needs to be configured before you will
322       get the warning about the cakelampvm.com domain.&nbsp; Up until then, the
323       domain name is always referring to the site out on the internet with the
324       red X's and warnings.&nbsp; See the DNS configuration section below to
325       configure DNS the first time.</p>
326     <p>Once you connect to the VM and the ssh client records the VM's host key
327       in your known_hosts, then you're in good shape.&nbsp; This state also
328       gives you a "canary in a coal mine" warning system...&nbsp; Once the VM is
329       registered as a known host, then any attempt to connect back to the "real"
330       internet version of cakelampvm.com will garner a complaint from ssh.&nbsp;
331       This version of the ssh warning should be heeded; you do not want to
332       connect to the real internet site, and the warning indicates that the host
333       PC is no longer using the DNS on the VM (since it reached the real
334       internet site instead of the VM).&nbsp; That situation needs to be
335       corrected by running through the DNS configuration section again (and
336       testing the DNS until it is working).</p>
337     <h4>Troubleshooting the Apache Sites</h4>
338     <p>If your DNS pings and lookups are functioning properly, but you're just
339       not getting the right websites, then try clearing your browser's cache and
340       shutting the browser application down.&nbsp; Then, start the browser up
341       and try the address again.&nbsp; Often this cache dumping is enough to fix
342       the browser so that you start seeing the local website versions on
343       cakelampvm.com.</p>
344     <h2>Editing files on the guest VM from the host<a id="#editing-files-on-vm"
345         name="#editing-files-on-vm"></a></h2>
346     <p>On the host computer, look for the guest vm as a networked computer
347       called cakelampvm.&nbsp; This should provide some network shares using
348       Microsoft SMB protocol, and they can be attached to using the "developer"
349       user and its password.</p>
350     <p>On windows, one may want to mount this network location as a drive letter
351       for easier access.</p>
352     <p>Currently, the root of all web servers is exposed as "www".&nbsp; Editing
353       the files in those folders requires ownership by the developer user.&nbsp;
354       The existing mapsdemo site is owned by a different user ("fred") rather
355       than developer, mostly as a test case.&nbsp; The "fred", "developer", and
356       "www-data" accounts on the VM have all been put into each others Unix
357       "groups" so that they can access each other's files, and thus you may not
358       notice any issues editing fred's files.</p>
359     <p>One should be able to create a new directory over the network also.&nbsp;
360       Try creating a junk folder in the "www" folder, and then deleting it
361       again.&nbsp; That should succeed, and this approach can be used to create
362       folders (from the Host PC) that are owned by the developer user (on the
363       VM).&nbsp; You should be able to create folders or copy files within the
364       developer's home folder also ("/home/developer").</p>
365     <p>If you run into any permission problems that prevent file access, either
366       remotely or within the VM itself, then try running this command to fix
367       them (repeated from the section above about updating the cakelampvm):</p>
368     <pre><span style="font-weight: bold;">revamp_cakelampvm</span></pre>
369     <p>Afterwards, the www folder and others should allow the developer user to
370       create new folders at will.</p>
371     <h2>Accessing files on the host PC from the guest VM<a id="#samba-shares" name="#samba-shares"></a></h2>
372     <p>If you want to share a folder from the host to the guest, perhaps for
373       driver updates or other conveniences, then make the share with these
374       steps:</p>
375     <ol>
376       <li>Create a folder on the host that is to be shared.</li>
377       <li>Right-click on the vm in Virtualbox manager and choose "Settings".</li>
378       <li>In the "Shared Folders" tab of the settings, go to "Machine Folders".</li>
379       <li>Click the folder plus icon to create a new share.</li>
380       <li>Fill in the "Folder Path" on the host PC to the folder that will be
381         shared, and give it a name for the guest.&nbsp; We assume the folder
382         name will be "myshare".</li>
383       <li>On the guest vm, run the following commands to mount the share:<br>
384         <pre><span style="font-weight: bold;"># make the guest's version of the shared folder<br>mkdir ~/shared<br># mount the vm's share name onto the folder on the vm.<br>sudo mount -t vboxsf myshare ~/shared</span></pre>
385       </li>
386     </ol>
387     <h2>X11 applications launched from the VM</h2>
388     <p>[incomplete section]</p>
389     <p>If a feature called "X forwarding" is enabled in your ssh client, then
390       you can start graphical applications on the VM and display them on your
391       local machine.&nbsp; This works right away on most Linux hosts, but can
392       also work on PCs with X window system installed.&nbsp; This section
393       describes how to set up Cygwin to run X server, which enables X11
394       forwarding to your local display.</p>
395     <p>...{insert that info}...</p>
396     <h2>Adding a new website and domain on the guest VM</h2>
397     <p>Note: these instructions, even the quick approaches below, pale in
398       comparison to the ease of use of the "standup" command in feisty meow's
399       site avenger scripts.&nbsp; The standup command is detailed in the&nbsp;<a
400         target="_blank" title="useful commands" href="https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt">feisty
401         meow command reference</a> document.&nbsp; These instructions are for
402       situations when the domain or site is idiosyncratic in some way that
403       standup doesn't support.</p>
404     <p>To add a new website, you will first need to pick one of the DNS options
405       below (A or B) depending on how you want to name the site.&nbsp; If the
406       DNS name of the site is contained within another existing domain (e.g.,
407       "A.B.C" has subdomain A contained in domain B.C), use Option A.&nbsp; If
408       the DNS name is a so-called "Second Level Domain" (SLD), then it stands on
409       its own (e.g., "B.C" is an SLD).</p>
410     <p>Once the DNS option has been picked and implemented, continue to the next
411       section of "Creating a New Apache Site".</p>
412     <p>For either Option A or Option B, first connect to the cakelampvm via ssh
413       as the developer user, e.g.: ssh developer@cakelampvm.com </p>
414     <h3>DNS Option A: Adding a sub-domain in an existing domain</h3>
415     <p>Let us say a customer needs an application called "excalibur".&nbsp; It
416       will be a new subdomain within an existing domain, such as the
417       "cakelampvm.com" domain, meaning we want the VM to start answering
418       requests for "excalibur.cakelampvm.com".</p>
419     Note that this option requires the containing domain "cakelampvm.com" to
420     already exist before adding the subdomain; see DNS Option B below for
421     details on how to add a containing domain for the first time.
422     <h4>Quick approach: Use the feisty meow "add_domain" command.</h4>
423     <p>Run this command in a bash shell on the VM:</p>
424     <pre><span style="font-weight: bold;">add_domain excalibur.cakelampvm.com</span></pre>
425     <p>Done.</p>
426     <h4>Manual approach: Edit the bind9 configuration.</h4>
427     <p>Note: the manual approach is not compatible with later use of feisty
428       meow's "remove_domain".</p>
429     Execute the following command to edit the DNS file for the cakelampvm
430     domain:
431     <pre><span style="font-weight: bold;">sudo vi /etc/bind/cakelampvm.com.conf</span></pre>
432     <p>Add a stanza for the new site at the end of this file:</p>
433     <pre>excalibur.cakelampvm.com.&nbsp;&nbsp;&nbsp; IN A&nbsp;&nbsp;&nbsp; 10.28.42.20<br>&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; IN HINFO "linux server" "ubuntu"</pre>
434     <p>Restart the DNS server:</p>
435     <pre><span style="font-weight: bold;">sudo service bind9 restart</span></pre>
436     <p>Afterwards, pinging excalibur.cakelampvm.com should work from both the
437       guest VM and the host PC.</p>
438     <h3>DNS Option B: Using an entirely new domain for the site</h3>
439     <p>This is a similar procedure to Option A, but we will create a totally new
440       config file for the new domain and add it to the bind directory.&nbsp; For
441       this example, we need to add the site "excalibur.tv" into the DNS.</p>
442     <h4>Quick approach: Use the feisty meow "add_domain" command.</h4>
443     Run this command in a bash shell on the VM:
444     <pre><span style="font-weight: bold;">add_domain excalibur.tv</span></pre>
445     <p>Done.</p>
446     <h4>Manual approach: Edit a new DNS config file</h4>
447     <p>Note: the manual approach is not compatible with later use of feisty
448       meow's "remove_domain".</p>
449     Create a file called /etc/bind/excalibur.tv.conf for our new domain
450     excalibur.tv with these contents:
451     <pre>$TTL 1W<br>@&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; IN SOA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; fred.cakelampvm.com. (<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 2017100801&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ; serial<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 2H&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ; refresh<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 8M&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ; retry<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 14D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ; expiry<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 6H )&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ; minimum<br><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; IN NS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ns.cakelampvm.com.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; IN MX&nbsp;&nbsp; 10&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; mail.cakelampvm.com.<br><br># new SLD for our excalibur site.<br>excalibur.tv.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; IN A&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 10.28.42.20<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; IN HINFO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "linux server" "ubuntu"</pre>
452     The gnarly prefix stuff above the "excalibur.tv." listing establishes
453     configuration info for the new domain.&nbsp; This file relies on the
454     existing cakelampvm.com infrastructure in DNS, such as the "ns" host, which
455     is the domain's name server.&nbsp; However, the new domain does <span style="text-decoration: underline;">not</span>
456     live inside the cakelampvm.com domain.<br>
457     <p>Now that the config file is in place, edit "/etc/bind/named.conf.local"
458       to add the new file by adding this bit of configuration at the end:</p>
459     <pre>zone "excalibur.tv" in {<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; file "/etc/bind/excalibur.tv.conf";<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; type master;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; allow-query { any; };<br>};</pre>
460     <p>Restart the DNS server:</p>
461     <pre><span style="font-weight: bold;">sudo service bind9 restart</span></pre>
462     <p>Afterwards, pinging excalibur.tv should work from both the guest and the
463       host.</p>
464     <h3>Creating a New Apache Site</h3>
465     <p>First, connect to the cakelampvm via ssh as the developer user, e.g.: ssh
466       developer@cakelampvm.com </p>
467     <h4>Quick approach: Use the feisty meow "add_apache_site" command.</h4>
468     <p>Run this command in a bash shell on the VM:</p>
469     <pre><span style="font-weight: bold;">add_apache_site excalibur excalibur.tv</span></pre>
470     <p>(The first parameter is the application name, the second is the domain
471       name.)</p>
472     <p>Done.</p>
473     <h4>Manual approach: Edit an Apache config file</h4>
474     <p>Note: the manual approach is not compatible with later use of feisty
475       meow's "remove_apache_site".</p>
476     <p>For Apache, the choice of DNS Option A or B, subdomain or SLD, does not
477       matter.&nbsp; The site configuration file just has to accurately specify
478       the domain in question.</p>
479     <p>Start with the following template file for the new website, and modify it
480       for the appropriate host name and "DocumentRoot" path:</p>
481     <pre>&lt;VirtualHost *:80&gt;<br>&nbsp;&nbsp;&nbsp; ServerName excalibur.tv
482 &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>
483     <p>The above example is appropriate for our excalibur app in the
484       excalibur.tv domain (using DNS Option B).&nbsp; Modifying the excalibur.tv
485       references in it (and the path in the DocumentRoot) is sufficient to
486       re-target it for any domain you want.</p>
487     <p>Copy the new site config file into "/etc/apache2/sites-available" with an
488       appropriate file name that includes the site's domain name.&nbsp; We will
489       call our config file "excalibur.tv.conf".&nbsp; If you developed the file
490       in your home folder, this would be the command to move it up to Apache:</p>
491     <pre><span style="font-weight: bold;">sudo cp ~/excalibur.tv.conf /etc/apache2/sites-available</span></pre>
492     <p>Then tell apache to use the new file:</p>
493     <pre><span style="font-weight: bold;">sudo a2ensite excalibur.tv<br># the '.conf' portion of the filename is unnecessary for this command.</span>
494 </pre>
495     <p>Finally, restart apache to get it to begin serving the site:</p>
496     <pre><span style="font-weight: bold;">sudo service apache2 restart</span></pre>
497     <h3>Test the new web site</h3>
498     <p>Given the configuration above, your host PC should now be able to access
499       the new website on the domain "excalibur.tv".</p>
500     <p>To test this, first try pinging the new DNS name:</p>
501     <pre><span style="font-weight: bold;">ping excalibur.tv</span></pre>
502     <p>If there are responses to the ping <span style="font-weight: bold;">*and*</span>
503       the answer is 10.28.42.20, then it means the DNS is working.</p>
504     <p>If there are no responses or it's some other IP address talking back,
505       check the instructions in the above DNS sections.</p>
506     <p>Once the DNS is working, try browsing to the site at "<a title="it's excalibur, wilbur!"
507         href="http://excalibur.tv">http://excalibur.tv</a>".&nbsp; That should
508       at least bring up the configured site storage path, even if nothing is
509       being served from that folder yet.</p>
510     <p>If the new site is not showing up properly, try examining the apache logs
511       for any error messages that can be corrected.&nbsp; The log files are
512       stored in "/var/log/apache2" and are named after the website (if
513       configured through the above process).</p>
514     <h2>Handy Techniques for Using cakelampvm</h2>
515     <h3>Assorted Guides and Cheat-Sheets</h3>
516     <p>A Cheat sheet for the Vim editor (there are many of these available): <a
517         target="_blank" title="vim commands" href="https://vim.rtorr.com/">https://vim.rtorr.com/</a></p>
518     <p>A git branching model that seems to work well: <a target="_blank" title="release and patch process"
519         href="http://nvie.com/posts/a-successful-git-branching-model/">http://nvie.com/posts/a-successful-git-branching-model/</a></p>
520     <p>This is a basic guide to the Google Developer Console and API Key
521       management: <a target="_blank" title="apis and creds at google" href="https://feistymeow.org//feisty_meow/documentation/google_apis/google_apis_and_credentials.pdf">Google
522         API Docs</a>&nbsp; </p>
523     <h3>Using the "meld" Tool to Compare Files &amp; Directories</h3>
524     <p>Meld is a great comparison tool that displays differences between two
525       files or directories or directory trees in a graphical view.&nbsp; Meld is
526       pre-installed on the VM.&nbsp; This tool can be launched either in the
527       VM's X Windowing System (on the console) or if X11 forwarding is enabled.</p>
528     <p>To run meld, just type this command:</p>
529     <pre><span style="font-weight: bold;">meld A B</span></pre>
530     <p>where A and B are either both file names or they are both directory
531       names.&nbsp; If A and B are directories, meld will compare the entire tree
532       structure between the two directories.&nbsp; It allows one to copy from
533       one side to the other, even if the item that needs to be copied is an
534       entire subdirectory.</p>
535     <h3>Get the network address on the guest vm</h3>
536     <p>Run this command:</p>
537     <pre><span style="font-weight: bold;">ifconfig</span></pre>
538     <p>In the results, look for "<span style="font-family: monospace;">inet addr</span>".&nbsp;
539       There may be more than one, if there are multiple network interfaces.</p>
540     <p>The standard IP address is 10.28.42.20 for the cakelampvm.</p>
541     <h3>How to cleanly reboot or shut down the guest VM</h3>
542     <p>When you've got the DNS and everything integrated, these commands will
543       manage the vm's state:</p>
544     <p>First, log into the guest VM:</p>
545     <pre><span style="font-weight: bold;">ssh developer@cakelampvm.com</span></pre>
546     <p>Then, to reboot the guest VM:</p>
547     <pre><span style="font-weight: bold;">sudo reboot</span></pre>
548     <p>Or, to halt the guest VM:</p>
549     <pre><span style="font-weight: bold;">sudo shutdown -h now</span></pre>
550     <p>Using these commands is kinder to the VM than just cycling the power from
551       the Virtualbox control panel.</p>
552     <h1>Gritty Details of the Nitty Variety<a id="#nitty-gritty" name="#nitty-gritty"></a></h1>
553     <p>This is the lowest level of plumbing for your VM.&nbsp; Hopefully you
554       will not need to engage with this section.&nbsp; The most useful doc
555       section here is the one below about the "Virtualbox guest additions",
556       which you will probably need at some future point.&nbsp; Oracle releases
557       updates to the guest additions fairly regularly.</p>
558     <h2>Configuring the guest VM</h2>
559     <p>The guest VM should already be set up appropriately.&nbsp; These steps
560       are provided for reference and updates.</p>
561     <h3>Set up Virtualbox guest additions for the VM</h3>
562     This procedure is needed if the guest provides an older or incompatible
563     version of the guest additions (which have already been installed on the
564     guest vm).&nbsp; It may also be necessary when a new version of the guest
565     additions becomes available.
566     <ol>
567       <li>To install the guest additions, open the guest VM and have its window
568         in focus.</li>
569       <li>Choose the "Devices" menu and select "Insert Guest Additions CD
570         Image".&nbsp; This will mount the CD's ISO image on the VM.</li>
571       <li>On the guest VM, it may be necessary to mount the CD image that's now
572         available:<br>
573         <pre><span style="font-weight: bold;">sudo mount /dev/sr0 /media/cdrom</span></pre>
574         <p>Linux will mention that the device is mounted "read-only".</p>
575       </li>
576       <li>Since the VM currently has no windowing system installed, one must
577         start the Guest Additions install manually:<br>
578         <pre><span style="font-weight: bold;">cd /media/cdrom<br>sudo sh VBoxLinuxAdditions.run</span></pre>
579       </li>
580       <li>The latest Virtualbox guest additions should now be installed.</li>
581     </ol>
582     <h3>Set up network adapters on guest VM</h3>
583     <p>The network interfaces should already be configured on the guest within
584       the Virtualbox configuration.&nbsp; This is available by clicking on the
585       VM in the Virtualbox manager and selecting "Settings".&nbsp; These are the
586       configuration settings used:</p>
587     Adapter 1:<br>
588     &nbsp; Attached to: Host-only Adapter<br>
589     &nbsp; Name: vboxnet0&nbsp; <br>
590     <p>Adapter 2:<br>
591       &nbsp; Attached to: Nat Network<br>
592       &nbsp; Name: NatNetwork</p>
593     <p>On the guest VM itself, the network settings are specified in a file
594       called /etc/network/interfaces.&nbsp; Here are the current contents of
595       that file:</p>
596     <pre>source /etc/network/interfaces.d/*<br><br>auto lo<br>iface lo inet loopback<br><br>auto enp0s3<br>iface enp0s3 inet static<br>&nbsp; address 10.28.42.20<br>&nbsp; netmask 255.255.255.0<br>&nbsp; network 10.28.42.0<br>&nbsp; broadcast 10.28.42.255<br>&nbsp; dns-domain cakelampvm.com<br>&nbsp; dns-search cakelampvm.com<br>&nbsp; dns-nameservers 127.0.0.1 8.8.8.8</pre>
597     <pre>auto enp0s8</pre>
598     <pre>iface enp0s8 inet dhcp</pre>
599     <p> </p>
600     <h3>Compacting the VM Disk Image</h3>
601     <p>To minimize the size used for the disk image, there are three major
602       steps.</p>
603     <p>1. While running the VM, run this command:</p>
604     <pre><span style="font-weight: bold;">sudo apt clean</span></pre>
605     <p>This throws away any cached data from the apt tool, which can be
606       substantial.</p>
607     <p>If there are other junk files you know of that can be removed, delete
608       those now also.</p>
609     <p>2. Reboot the VM to the gparted ISO image (available at the <a target="_blank"
610         title="great free partition editor" href="https://gparted.org/livecd.php">gparted
611         site</a>) and run the following command:</p>
612     <pre><span style="font-weight: bold;">sudo zerofree /dev/sda</span></pre>
613     <p>This sets all free space to the zero byte, enabling Virtualbox to free
614       that space in the next step.</p>
615     <p>3. Shut the vm down after zerofree is complete and run this command on
616       the host PC (this is the Linux version of the command):</p>
617     <pre><span style="font-weight: bold;">VBoxManage modifyhd --compact ~/cake_lamp_vm/cake-lamp-vm-hd.vdi</span></pre>
618     <p>Replace the <span style="font-family: monospace;">~/cake_lamp_vm</span>
619       path with the real VM storage path.&nbsp; This command compacts the root
620       (and only) partition of the VM.</p>
621     <p>After these steps are complete, the VM should be its minimal size.</p>
622     <h2>Notes on building the Cake Lamp VM</h2>
623     <p>This is all work that should already have been done.&nbsp; It is
624       mentioned here just as breadcrumbs for a future vm builder.</p>
625     <ul>
626       <li>Downloaded and installed Virtualbox for host computer (where the vm
627         image will be built).</li>
628       <li>Downloaded ubuntu server 16.04 iso. (<a target="_blank" title="ubuntu server"
629           href="https://www.ubuntu.com/download/server">https://www.ubuntu.com/download/server</a>)</li>
630       <li>Created a new vm in Virtualbox, telling it to start from the ubuntu
631         server iso.</li>
632       <li>Installed LAMP stack on guest VM.&nbsp; Some help here: <a target="_blank"
633           title="lamplighter" href="http://howtoubuntu.org/how-to-install-lamp-on-ubuntu">http://howtoubuntu.org/how-to-install-lamp-on-ubuntu</a></li>
634       <li>Configured CAKE on the guest VM.&nbsp; Useful link: <a target="_blank"
635           title="cakebundtu" href="https://askubuntu.com/questions/628938/how-to-install-cakephp-in-ubuntu-14-04">https://askubuntu.com/questions/628938/how-to-install-cakephp-in-ubuntu-14-04</a></li>
636       <li>Configured the two network adapters as needed (one for host-only
637         network and one for nat network).&nbsp; Here's some info about
638         Virtualbox networking with two adapters similar to our setup: <a target="_blank"
639           href="https://askubuntu.com/questions/293816/in-virtualbox-how-do-i-set-up-host-only-virtual-machines-that-can-access-the-in">https://askubuntu.com/questions/293816/in-virtualbox-how-do-i-set-up-host-only-...</a><br>
640       </li>
641       <li>Installed and configured Samba service for the guest VM.&nbsp; The
642         main config file lives in "/etc/samba/smb.conf".&nbsp; Some pointers
643         here: <a target="_blank" href="https://help.ubuntu.com/community/How%20to%20Create%20a%20Network%20Share%20Via%20Samba%20Via%20CLI%20%28Command-line%20interface/Linux%20Terminal%29%20-%20Uncomplicated%2C%20Simple%20and%20Brief%20Way%21">https://help.ubuntu.com/community/How%20to%20Create...</a></li>
644     </ul>
645     <p><br>
646     </p>
647     <ul>
648     </ul>
649     <h6> </h6>
650     <p> </p>
651   </body>
652 </html>