<!DOCTYPE html>
<html>
<head>
- <meta content="text/html; charset=windows-1252" http-equiv="content-type">
+ <meta http-equiv="content-type" content="text/html; charset=windows-1252">
<title>Cake LAMP VM Documentation</title>
</head>
<body>
<h1 style="text-align: center;">The cakelampvm VM:<br>
Configuration and Usage</h1>
- <h2 style=" text-align: center;">By Chris Koeritz</h2>
+ <div style="text-align: center;"><span style="font-weight: bold;">By Chris
+ Koeritz</span><span style="font-family: Comic Sans MS;"></span><span style="font-family: Comic Sans MS;"></span><br>
+ <span style="font-family: Comic Sans MS;">feisty meow® concerns ltd</span>.</div>
<h3 style=" text-align: center;"> Vintage: cakelampvm v002
- Updated: 2017-11-16 (rev D)</h3>
+ Updated: 2018-2-7 (rev. j)</h3>
<p>The cakelampvm project provides a Virtualbox VM that acts as an "internet
- in a bottle". The virtual machine provides DNS services (<a title="dns server"
- href="http://www.bind9.net/">bind9</a>), a Web server (<a title="patchy"
- href="https://httpd.apache.org/">Apache2</a>), a full <a title="ubuntu means compassion and humanity"
- href="https://www.ubuntu.com/">Ubuntu</a> <a title="it's pronounced leenoox"
- href="https://www.linuxfoundation.org/">Linux</a> desktop environment,
- the <a title="flux is change" href="http://fluxbox.org/">Fluxbox</a> <a
- title="a better windows" href="https://www.x.org/">X window manager</a>,
- and a suite of tools called the <a title="feisty meow® concerns ltd. website"
- href="https://feistymeow.org/">Feisty Meow® codebase</a> .
- Together, these services provide you with a very flexible and powerful
- testbed for web development, especially suited for <a title="it's cake" href="https://cakephp.org/">CakePHP</a>.</p>
- <p>Commands preceded by an octothorpe ('#') below are intended to be typed
- into a bash shell running on the cakelampvm virtual machine. The
- bash shell can be obtained either by logging into the VM through ssh or by
- logging in directly to the Virtualbox VM console. You may find the
- ssh session more convenient, because copy & paste features work as
- expected.</p>
+ in a bottle", serving up your web sites securely and only to your local
+ host. The virtual machine provides DNS services (<a target="_blank"
+ title="dns server" href="http://www.bind9.net/">bind9</a>), a Web server
+ (<a target="_blank" title="patchy" href="https://httpd.apache.org/">Apache2</a>),
+ a full <a target="_blank" title="ubuntu means compassion and humanity" href="https://www.ubuntu.com/">Ubuntu</a>
+ <a target="_blank" title="it's pronounced leenoox" href="https://www.linuxfoundation.org/">Linux</a>
+ desktop environment, the <a target="_blank" title="flux is change" href="http://fluxbox.org/">Fluxbox</a>
+ <a target="_blank" title="x11 -- best windowing system" href="https://www.x.org/">X
+ window manager</a>, and a suite of tools called the <a target="_blank"
+ title="feisty meow® concerns ltd. website" href="https://feistymeow.org/">Feisty
+ Meow® codebase</a> . Together, these services provide you with a
+ very flexible and powerful testbed for web development, especially suited
+ for <a target="_blank" title="it's cake" href="https://cakephp.org/">CakePHP</a>.
+ This VM was built with the assistance of and was partially funded by <a target="_blank"
+ title="saco design" href="http://sacodesign.com">Saco Design</a> of <a
+ target="_blank" title="winterport" href="http://www.winterportmaine.gov/">Winterport,
+ Maine</a>.</p>
+ <p>Commands in fixed-width bold below are intended to be typed into a bash
+ shell running on the cakelampvm virtual machine. The bash shell can
+ be obtained either by logging into the VM through ssh or by logging in
+ directly to the Virtualbox VM console. You may find the ssh session
+ more convenient, because copy & paste features work as expected.</p>
<p>Commands preceded by a greater-than symbol ('>') 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>
+ <li>Hostname: <a target="_blank" title="the vm's website, when configured properly"
+ href="https://cakelampvm.com/">cakelampvm.com</a></li>
<li>Local IP Address: 10.28.42.20</li>
<li>Services Included: DNS (bind9), apache2, fluxbox X windowing system, <a
- title="not just in the garden" href="https://www.gnome.org/">gnome
+ target="_blank" title="not just in the garden" href="https://www.gnome.org/">gnome
display manager</a></li>
<li>Main VM User: developer (password distributed separately)</li>
- <li>Database Access: mysql root account, password: (password distributed
- separately)</li>
+ <li>Database Access: mysql root account (password distributed separately)</li>
</ul>
- <h2>Powering up with the Feisty Meow® scripts<a id="#powerup" name="#powerup"></a></h2>
- The feisty meow scripts are a cohesive bash scripting environment for
- getting a variety of tasks done. The feisty meow scripts recently
- incorporated the "avbash" collection from Saco Designs and added those
- scripts to a new "site_avenger" collection of scripts. The site
- avenger scripts provide tools for bringing up CakePHP web sites and managing
- the collection of repositories for those sites. Each website is
- considered an "application", and the application name itself (e.g.
- "winterportlibrary") can often provide all the details for "powering up" the
- site. The feisty meow team has added additional scripts for managing
- DNS domains and Apache websites that provide the capability to "stand up" an
- entire website around an application, with an accompanying DNS domain and
- Apache2 site definition.
- <p>The site avenger scripts are documented separately within the feisty meow
- codebase. Consult the <span style="text-decoration: underline;">f</span><a
- title="quickstart" href="https://feistymeow.org/feisty_meow/readme.txt">eisty
-meow
- readme</a> file first, as it provides some valuable information on
- configuring the codebase initially. The site avenger script commands
- are documented in the <a title="useful commands" href="https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt">feisty
- meow command reference</a> file.</p>
- <p>(The feisty meow codebase is already configured for the developer account
- on the cakelampvm virtual machine.)</p>
<h2>How to set up virtualbox for your host PC<a id="#virtualbox-setup" name="#virtualbox-setup"></a></h2>
<ol>
- <li>Download and install virtualbox:
- https://www.virtualbox.org/wiki/Downloads</li>
+ <li>Download and install virtualbox: <a target="_blank" href="https://www.virtualbox.org/wiki/Downloads">https://www.virtualbox.org/wiki/Downloads</a></li>
<li>Install the extension pack for Virtualbox: This provides USB drivers
and other features. This is installed on Virtualbox itself (on the
Host PC), not on the guests.</li>
<ol>
- <li>Download the extension pack at
- https://www.virtualbox.org/wiki/Downloads</li>
+ <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>
<li>Stop any running Virtualbox VMs.</li>
<li>Close the Virtualbox control panel.</li>
<li>Double-click on the downloaded extensions package (in a file
<h3>Configure the Host-Only network on Virtualbox<a id="#host-only" name="#host-only"></a></h3>
<p>Configuring host-only networking for the VM makes the VM completely local
to your machine. The cakelampvm will not be accessible on the
- internet or from the LAN, and can only be accessed by your host PC.</p>
+ internet or from the LAN, and can only be accessed by your host PC.
+ This is a key component of security for your VM and your host PC, and is
+ considered a crucial configuration step.</p>
<p>Note: If the host-only or NAT network exist ahead of time, Virtualbox may
complain about them even if they have the correct configuration.
- This can be corrected simply by opening the VM settings and selecting the
- appropriate network names again.</p>
+ This can be corrected simply by opening the cakelampvm settings and
+ selecting the appropriate network names again.</p>
<p>To configure the host-only network, follow these steps:</p>
<ol>
<li> Go to virtual box "Preferences" (global preferences, not for a
IPv4 Network Mask: 255.255.255.0<br>
IPv6 Address: (leave blank)<br>
IPv6 Prefix Length: 0<br>
- Virtualbox will fill in the other details like so:<br>
+ Virtualbox will fill in the other details like so (this dialog may
+ differ between versions of virtualbox):<br>
<p><img alt="host only network adapter" src="images/host_only_network_adapter.png"></p>
</li>
<li>Set the "DHCP Server Settings" to disabled, e.g.<br>
<h3>Configure the NAT Network on Virtualbox<a id="#nat-network" name="#nat-network"></a></h3>
<p>The NAT (Network Address Translation) network allows the VM to get off of
the machine and onto the internet safely. It will use this interface
- for any communication off of the host machine. Since the real IP
- address of the VM is hidden behind the NAT firewall on Virtualbox, this
- keeps the VM safe from attackers, and hence your machine stays safe as
- well.</p>
+ for any communication off of the host machine. This is another
+ crucial component for the security of the VM and your host PC. Since
+ the real IP address of the VM is hidden behind the NAT firewall on
+ Virtualbox, this keeps the VM safe from attackers, and hence your machine
+ stays safe as well.</p>
<p>To set up the NAT network, follow these steps:</p>
<ol>
<li> Go to virtual box "Preferences" (global preferences, not for a
Network CIDR: 10.0.2.0/24<br>
Supports DHCP: checked<br>
Supports IPv6: optionally checked<br>
- These are my settings, with IPv6 left disabled:<br>
+ These are my settings, with IPv6 left disabled (this dialog may differ
+ between versions of virtualbox):<br>
<img alt="nat net config" src="images/nat_network_config.png"></li>
</ol>
- <h2>Starting up the VM<a id="#start-vm" name="#start-vm"></a></h2>
+ <h2>Starting up the VM and Connecting to It<a id="#start-vm" name="#start-vm"></a></h2>
+ <p>★ This section requires that the VM is already configured properly for
+ Host-Only and NAT networks.</p>
<p>Using the Virtualbox interface, you should now be able to start your
virtual machine. Virtualbox will complain if it detects any
- remaining configuration problems in the VM, but it should start
- normally. The Linux boot sequence will show many lines of text,
- before bringing up a black console window with a login dialog.</p>
+ remaining configuration problems in the VM. The Linux boot sequence
+ will show many lines of text, 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. 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>
- <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.
- If the networking has been established properly, you should be able to do
- this with:</p>
- <pre>ssh developer@cakelampvm.com (or equivalent with your ssh client)</pre>
+ 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. (Cortana can find the firewall
+ settings if you ask her about 'firewall'. Within the firewall
+ configuration dialog, look for "Allow an app or feature through..." on the
+ left and configure Virtualbox from within that list.)</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. If the
+ networking has been established properly, you should be able to do this
+ with:
+ <pre><span style="font-weight: bold;">ssh developer@10.28.42.20<br># or perform the equivalent connection with your ssh client.</span></pre>
<p>And then provide the password to log in.</p>
- <p>If a feature called "X forwarding" is enabled in your ssh client, then
- you can start graphical applications on the VM and display them on your
- local machine. This works right away on most Linux hosts, but can
- also work on PCs with X window system installed. The section below
- describes how to set up Cygwin to run X server, which enable X forwarding
- to your local display.</p>
- <p>...{insert that info}...</p>
+ <p>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8">
+ </p>
+ <p>
+ <meta charset="utf-8">
+ ★ It is very important that the ssh connection is working properly before
+ proceeding to other configuration steps. If ssh is not working, try
+ pinging the host:</p>
+ <pre><b>ping 10.28.42.20</b></pre>
+ <p>If the ping is also failing, then please re-check the two network
+ configuration sections above (for Host-Only networking and NAT
+ networking). These are both required for the VM's network to
+ function as designed.</p>
+ <p>Optional: Once the DNS services are set up (discussed in detail below),
+ you will be able to run the much friendlier command:</p>
+ <pre><span style="font-weight: bold;">ssh developer@cakelampvm.com</span></pre>
+ <h4>Key Forwarding to the VM</h4>
+ <p>It is important to set up ssh key forwarding to enable your use of git
+ repositories while logged into the VM. Key forwarding should be
+ enabled for the VM's two fake host identities:</p>
+ <pre><span style="font-weight: bold;">cakelampvm.com<br>10.28.42.20</span></pre>
+ <p>The details of configuring ssh key forwarding vary for each ssh
+ client. For Linux ssh, the <b>~/.ssh/config</b> file might contain
+ this information:</p>
+ <pre><b>Host cakelampvm.com 10.28.42.20<br> ForwardAgent yes<br></b></pre>
+ <pre><span style="font-weight: bold;"></span></pre>
<h2>Updating cakelampvm to the Latest Model<a id="#update-vm" name="#update-vm"></a></h2>
- <p>The cakelampvm is released with the intention to not be released
- again. Version 001 was not built with that explicit intention, which
- then required the release of Version 002. We hope to not need a v003
- release.</p>
+ <p>★ This section requires that the VM is already configured and is
+ accessible via ssh.</p>
+ <p>The cakelampvm v002 is released with the intention that it not need to be
+ released again. Version 001 was not built with that explicit
+ intention, which then required the release of Version 002. But we
+ hope to not need a v003 release...</p>
<p>There is an update feature built into the VM that is quite easy to
use. The updates are driven by the feisty meow script repository in
conjunction with a local scripted command. To activate the "update
- process" for your VM, run the following commands (without the initial '#'
- symbol):</p>
- <p># rpuffer $FEISTY_MEOW_APEX # updates to the latest version
- of feisty meow<br>
- # revamp_cakelampvm # enacts any configuration changes
- needed, plus fixes web folder and other permissions.</p>
+ process" for your VM, run the following commands on the VM, logged in as
+ the <i>developer</i> user:</p>
+ <pre><span style="font-weight: bold;"># update to the latest version of feisty meow.<br>rpuffer $FEISTY_MEOW_APEX; regenerate<br># enact any configuration changes needed, such as permissions and account setup.
+revamp_cakelampvm</span></pre>
+ <span style="font-weight: bold;"> </span>
<p>These two commands can be run at any time to patch up your VM to the
- latest.</p>
- <p>The first command ("rpuffer ...") is also useful on its own for getting
- the latest version of the feisty meow code. If there are bug fixes
- you need for the scripts or you want updated cakelampvm documentation,
- that is the command to use.</p>
+ latest configuration.</p>
+ <p>Recent versions of feisty meow support a new "<span style="font-weight: bold; font-family: monospace;">get_feisty</span>"
+ command, which will behave the same as the first line above. Once
+ you have run the "puffer..." command above for the first time (on
+ cakelampvm v002), this new command becomes available.</p>
+ <ul>
+ <li>The "<span style="font-weight: bold; font-family: monospace;">get_feisty</span>"
+ command is useful in its own right for getting the latest version of the
+ feisty meow code; run it again if you need bug fixes or if you want the
+ most recent cakelampvm documentation.</li>
+ <li>The "<span style="font-weight: bold; font-family: monospace;">revamp_cakelampvm</span>"
+ command can be used to repair many situations when the cakelampvm has
+ gone astray, especially for problems with permissions.</li>
+ </ul>
+ <h2>First Tasks as the Developer User</h2>
+ <p>★ This section requires that the VM is already configured and is
+ accessible via ssh.</p>
+ <p>Here are some first steps that will make the vm your own.</p>
+ <ol>
+ <li>Change your password for the developer account. (This may
+ eventually be required and automatic.) First, log into the VM with
+ ssh. Then type this command:<br>
+ <pre><span style="font-weight: bold;">passwd</span></pre>
+ The 'passwd' command will ask for your current password, and then for a
+ new password plus a verification of that new password.<br>
+ You will probably want to change your samba password as well, which is
+ used when accessing the virtual machine over the network. This is
+ a different, but very similar, command on Linux:<br>
+ <pre><span style="font-weight: bold;">smbpasswd</span></pre>
+ </li>
+ <li>Change your git configuration for the user and email address.
+ This is how we've configured it so far:<br>
+ <ul>
+ <li>
+ <pre><span style="font-weight: bold;">git config --global user.email "developer@cakelampvm.com"</span></pre>
+ </li>
+ <li>
+ <pre><span style="font-weight: bold;">git config --global user.name "Developer J. Cakemo"</span></pre>
+ </li>
+ </ul>
+ 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. Just run the two commands again but with proper values.</li>
+ </ol>
+ <h2>Powering up with the Feisty Meow® scripts<a id="#powerup" name="#powerup"></a></h2>
+ The feisty meow scripts are a cohesive bash scripting environment for
+ getting a variety of tasks done. The feisty meow scripts recently
+ incorporated the "avbash" collection from Saco Design and added those
+ scripts to a new "site_avenger" collection of scripts. The site
+ avenger scripts provide tools for bringing up CakePHP web sites and managing
+ the collection of repositories for those sites. Each website is
+ considered an "application", and the application name itself (e.g.
+ "winterportlibrary") can often provide all the details for "powering up" the
+ site. The feisty meow team has added additional scripts for managing
+ DNS domains and Apache websites that provide the capability to "stand up" an
+ entire website around an application, with an accompanying DNS domain and an
+ Apache2 site definition.
+ <p>The site avenger scripts are documented separately within the feisty meow
+ codebase. Consult the <span style="text-decoration: underline;">f</span><a
+ target="_blank" title="quickstart" href="https://feistymeow.org/feisty_meow/readme.txt">eisty
+meow
+ readme</a> file first, as it provides some valuable information on
+ configuring the codebase initially. The site avenger script commands
+ are documented in the <a target="_blank" title="useful commands" href="https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt">feisty
+ meow command reference</a> file.</p>
+ <p>(The feisty meow codebase is already configured for the developer account
+ on the cakelampvm virtual machine.)</p>
<h2>Using the guest VM's DNS services<a id="#dns-from-vm" name="#dns-from-vm"></a></h2>
+ <p>★ This section requires that the VM is already configured and is
+ accessible via ssh.</p>
<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
for you. It will also serve as a general DNS server for any other
10.28.42.20. (The DNS server can be tested with nslookup, dig and
other tools.)</p>
<p>Note that the cakelampvm DNS should be listed first, if one intends to
- override any DNS names that actually exist out on the internet. We
- have also found it most effective to have only the cakelampvm as your DNS
- server, because a secondary DNS server can "take over" providing the name
- lookups, and thus foul up DNS requests that should succeed for your
- VM-hosted sites.</p>
+ override any DNS names that actually exist out on the internet.
+ Further, we have found it most effective to have *only* the cakelampvm as
+ your DNS server, because a secondary DNS server can "take over" providing
+ the name lookups, and thus foul up DNS requests that should succeed for
+ your VM-hosted sites.</p>
<p>If your Host PC is running Windows, see the DNS configuration section
below that is tailored to that operating system.</p>
<p>Important Note: It behooves you to remember to switch back to a normal
DNS server configuration when you shut off the cakelampvm, or your machine
- will not know the names of any sites on the internet any more!</p>
+ will not know the names of any sites on the internet any more! The
+ official Google DNS servers are 8.8.8.8 and 8.8.4.4.</p>
<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. Note: ping on Linux
- 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>
+ keeps going forever, so hit control-C when you are tired of seeing the
+ pings:</p>
+ <pre><span style="font-weight: bold;">ping cakelampvm.com</span></pre>
+ <span style="font-weight: bold;"> </span>
+ <pre><span style="font-weight: bold;">ping www.cakelampvm.com</span></pre>
<p>Note that any other answer than 10.28.42.20 for the address is *bzzzt*
wrong, and means something needs to be fixed.</p>
<p>If these pings succeed (which hopefully they will!), then try accessing
the websites of each domain:</p>
- <pre>(browse to) http://cakelampvm.com</pre>
- <pre>(browse to) http://mapsdemo.cakelampvm.com</pre>
+ <pre>(browse to) <a target="_blank" title="vm website if dns working" href="http://cakelampvm.com">http://cakelampvm.com</a></pre>
+ <pre>(browse to) <a target="_blank" title="mapsdemo app, hopefully functional"
+href="http://mapsdemo.cakelampvm.com">http://mapsdemo.cakelampvm.com</a></pre>
<p>These should show local sites on the VM rather than sites on the
internet. If you instead get failures to find the domains, or if the
"real internet" site comes up for cakelampvm.com (the page covered with
red X marks and complaining), then the DNS is not hooked up properly yet.</p>
+ <h4>Setting up DNS on Windows<a id="#windoze-dns" name="#windoze-dns"></a></h4>
+ <p>The ipconfig tool will provide helpful information about your current
+ networking and DNS configuration:</p>
+ <pre><span style="font-weight: bold;">> ipconfig /all</span></pre>
+ <p>The DNS configuration on Windows is somewhat byzantine. The pipe
+ characters ('|') below are used to separate the menus or tabs or dialogs
+ to traverse. Follow this path to get to the DNS config:</p>
+ <pre>Control Panel | Network & Internet | Network & Sharing | click WiFI or Ethernet link near top right | click Adapter Settings button...<br> | click on the specific network device to modify | select Properties</pre>
+ <p>Once the properties dialog is displayed, find "internet protocol version
+ 4" in the list and double click it.</p>
+ <p>Change the DNS setting from "obtain...automatically" to "use the
+ following dns addresses".</p>
+ <p>Enter 10.28.42.20 as the first DNS address and clear the second address
+ (all blanks).</p>
+ <p>Hit okay, then okay, then close, etc to back out of adapter
+ configuration.</p>
<h4>Troubleshooting the DNS</h4>
<p>If your pings are getting the wrong answers and you're certain the DNS
settings on your Host PC are right, then you may need to flush your DNS
- cache, and that might be sufficient. On Windows, the command for
- flushing DNS is:</p>
- <pre>> ipconfig /flushdns</pre>
+ cache, and that might be sufficient to start getting the right IP
+ address. On Windows, the command for flushing DNS is:</p>
+ <pre><span style="font-weight: bold;">> ipconfig /flushdns</span></pre>
<p>and on Linux the flush DNS command can be many different things, but try
these two most common options:</p>
- <pre># sudo service dns-clean restart # restarts the client side DNS cache.</pre>
+ <pre><span style="font-weight: bold;"># restarts the client side DNS cache.<br>sudo service dns-clean restart</span></pre>
<p>or</p>
- <pre># sudo service nscd restart # restarts the nscd caching server.</pre>
+ <pre><span style="font-weight: bold;"># restarts the nscd caching server.<br>sudo service nscd restart</span></pre>
After, this try the pings again. If they still fail, please go back
over your DNS configuration very carefully. The cakelampvm's DNS
feature *does* actually work, but operating systems sometimes do their best
to deny this.<br>
+ <h4>Host Key Issues for ssh</h4>
+ <p>There is one caveat to be aware of when connecting to the cakelampvm.com
+ domain. If you have accidentally added the "real" cakelampvm.com
+ domain from the internet to your ssh known_keys at some point, then ssh
+ will complain about connecting to the VM on the cakelampvm.com
+ domain. This complaint will look like:</p>
+ <pre>The authenticity of host 'cakelampvm.com (104.236.56.82)' can't be established.</pre>
+ <p>Note that the IP address shown is not our beloved 10.28.42.20 local IP
+ address.</p>
+ <p>To fix this, remove the entry pointing at the "real" site from the
+ known_hosts file (ssh will print out the line number of the offending
+ entry). The DNS configuration needs to be configured before you will
+ get the warning about the cakelampvm.com domain. Up until then, the
+ domain name is always referring to the site out on the internet with the
+ red X's and warnings. See the DNS configuration section below to
+ configure DNS the first time.</p>
+ <p>Once you connect to the VM and the ssh client records the VM's host key
+ in your known_hosts, then you're in good shape. This state also
+ gives you a "canary in a coal mine" warning system... Once the VM is
+ registered as a known host, then any attempt to connect back to the "real"
+ internet version of cakelampvm.com will garner a complaint from ssh.
+ This version of the ssh warning should be heeded; you do not want to
+ connect to the real internet site, and the warning indicates that the host
+ PC is no longer using the DNS on the VM (since it reached the real
+ internet site instead of the VM). That situation needs to be
+ corrected by running through the DNS configuration section again (and
+ testing the DNS until it is working).</p>
<h4>Troubleshooting the Apache Sites</h4>
<p>If your DNS pings and lookups are functioning properly, but you're just
not getting the right websites, then try clearing your browser's cache and
and try the address again. Often this cache dumping is enough to fix
the browser so that you start seeing the local website versions on
cakelampvm.com.</p>
- <h3>Setting up DNS on Windows<a id="#windoze-dns" name="#windoze-dns"></a></h3>
- <p>The ipconfig tool will provide helpful information about your current
- networking and DNS configuration:</p>
- <pre>ipconfig --all</pre>
- <p>The DNS configuration on Windows is somewhat byzantine. The pipe
- characters ('|') below are used to separate the menus or tabs or dialogs
- to traverse. Follow this path to get to the DNS config:</p>
- <pre>Control Panel | Network & Sharing | click WiFI or Ethernet link near top right | click Adapter Settings on left | click on specific network device to modify | select Properties</pre>
- <p><br>
- </p>
- <p>{fill in rest}<br>
- </p>
- <p><br>
- </p>
<h2>Editing files on the guest VM from the host<a id="#editing-files-on-vm"
name="#editing-files-on-vm"></a></h2>
<p>On the host computer, look for the guest vm as a networked computer
developer's home folder also ("/home/developer").</p>
<p>If you run into any permission problems that prevent file access, either
remotely or within the VM itself, then try running this command to fix
- them:</p>
- <pre># revamp_cakelampvm</pre>
+ them (repeated from the section above about updating the cakelampvm):</p>
+ <pre><span style="font-weight: bold;">revamp_cakelampvm</span></pre>
<p>Afterwards, the www folder and others should allow the developer user to
create new folders at will.</p>
- <p>The revamp command above is also used to deliver new configuration to the
- VM from the feisty meow script environment; running it after any update of
- the feisty meow codebase is a good idea.</p>
<h2>Accessing files on the host PC from the guest VM<a id="#samba-shares" name="#samba-shares"></a></h2>
<p>If you want to share a folder from the host to the guest, perhaps for
driver updates or other conveniences, then make the share with these
shared, and give it a name for the guest. We assume the folder
name will be "myshare".</li>
<li>On the guest vm, run the following commands to mount the share:<br>
- <pre># mkdir ~/shared # for the guest's version of the shared folder<br># sudo mount -t vboxsf myshare ~/shared # mount the vm's share name onto the folder on the vm.</pre>
+ <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>
+ </li>
+ </ol>
+ <h2>X11 applications launched from the VM</h2>
+ <p>[incomplete section]</p>
+ <p>If a feature called "X forwarding" is enabled in your ssh client, then
+ you can start graphical applications on the VM and display them on your
+ local machine. This works right away on most Linux hosts, but can
+ also work on PCs with X window system installed. This section
+ describes how to set up Cygwin to run X server, which enables X11
+ forwarding to your local display.</p>
+ <p>...{insert that info}...</p>
+ <h2>Handy Techniques for Using cakelampvm</h2>
+ <h3>Assorted Guides and Cheat-Sheets</h3>
+ <p>A Cheat sheet for the Vim editor (there are many of these available): <a
+ target="_blank" 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 target="_blank" 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>
+ <p>This is a basic guide to the Google Developer Console and API Key
+ 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
+ API Docs</a> </p>
+ <h3>Using the "meld" Tool to Compare Files & Directories</h3>
+ <p>Meld is a great comparison tool that displays differences between two
+ files or directories or directory trees in a graphical view. Meld is
+ pre-installed on the VM. This tool can be launched either in the
+ VM's X Windowing System (on the console) or if X11 forwarding is enabled.</p>
+ <p>To run meld, just type this command:</p>
+ <pre><span style="font-weight: bold;">meld A B</span></pre>
+ <p>where A and B are either both file names or they are both directory
+ names. If A and B are directories, meld will compare the entire tree
+ structure between the two directories. It allows one to copy from
+ one side to the other, even if the item that needs to be copied is an
+ entire subdirectory.</p>
+ <h3>Get the network address on the guest vm</h3>
+ <p>Run this command:</p>
+ <pre><span style="font-weight: bold;">ifconfig</span></pre>
+ <p>In the results, look for "<span style="font-family: monospace;">inet addr</span>".
+ 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:</p>
+ <pre><span style="font-weight: bold;">ssh developer@cakelampvm.com</span></pre>
+ <p>Then, to reboot the guest VM:</p>
+ <pre><span style="font-weight: bold;">sudo reboot</span></pre>
+ <p>Or, to halt the guest VM:</p>
+ <pre><span style="font-weight: bold;">sudo shutdown -h now</span></pre>
+ <p>Using these commands is kinder to the VM than just cycling the power from
+ the Virtualbox control panel.</p>
+ <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. Hopefully you
+ will not need to engage with this section. The most useful doc
+ section here is the one below about the "Virtualbox guest additions",
+ which you will probably need at some future point. 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. These steps
+ are provided for reference and updates.</p>
+ <h3>Set up Virtualbox guest additions for the VM</h3>
+ This procedure is needed if the guest provides an older or incompatible
+ version of the guest additions (which have already been installed on the
+ guest vm). It may also be necessary when a new version of the guest
+ additions becomes available.
+ <ol>
+ <li>To install the guest additions, open the guest VM and have its window
+ in focus.</li>
+ <li>Choose the "Devices" menu and select "Insert Guest Additions CD
+ Image". This will mount the CD's ISO image on the VM.</li>
+ <li>On the guest VM, it may be necessary to mount the CD image that's now
+ available:<br>
+ <pre><span style="font-weight: bold;">sudo mount /dev/sr0 /media/cdrom</span></pre>
+ <p>Linux will mention that the device is mounted "read-only".</p>
+ </li>
+ <li>Since the VM currently has no windowing system installed, one must
+ start the Guest Additions install manually:<br>
+ <pre><span style="font-weight: bold;">cd /media/cdrom<br>sudo sh VBoxLinuxAdditions.run</span></pre>
</li>
+ <li>The latest Virtualbox guest additions should now be installed.</li>
</ol>
+ <h3>Set up network adapters on guest VM</h3>
+ <p>The network interfaces should already be configured on the guest within
+ the Virtualbox configuration. This is available by clicking on the
+ VM in the Virtualbox manager and selecting "Settings". These are the
+ configuration settings used:</p>
+ Adapter 1:<br>
+ Attached to: Host-only Adapter<br>
+ Name: vboxnet0 <br>
+ <p>Adapter 2:<br>
+ Attached to: Nat Network<br>
+ Name: NatNetwork</p>
+ <p>On the guest VM itself, the network settings are specified in a file
+ called /etc/network/interfaces. Here are the current contents of
+ that file:</p>
+ <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> address 10.28.42.20<br> netmask 255.255.255.0<br> network 10.28.42.0<br> broadcast 10.28.42.255<br> dns-domain cakelampvm.com<br> dns-search cakelampvm.com<br> dns-nameservers 127.0.0.1 8.8.8.8</pre>
+ <pre>auto enp0s8</pre>
+ <pre>iface enp0s8 inet dhcp</pre>
+ <p> </p>
+ <h3>Compacting the VM Disk Image</h3>
+ <p>To minimize the size used for the disk image, there are three major
+ steps.</p>
+ <p>1. While running the VM, run this command:</p>
+ <pre><span style="font-weight: bold;">sudo apt clean</span></pre>
+ <p>This throws away any cached data from the apt tool, which can be
+ substantial.</p>
+ <p>If there are other junk files you know of that can be removed, delete
+ those now also.</p>
+ <p>2. Reboot the VM to the gparted ISO image (available at the <a target="_blank"
+ title="great free partition editor" href="https://gparted.org/livecd.php">gparted
+ site</a>) and run the following command:</p>
+ <pre><span style="font-weight: bold;">sudo zerofree /dev/sda</span></pre>
+ <p>This sets all free space to the zero byte, enabling Virtualbox to free
+ that space in the next step.</p>
+ <p>3. Shut the vm down after zerofree is complete and run this command on
+ the host PC (this is the Linux version of the command):</p>
+ <pre><span style="font-weight: bold;">VBoxManage modifyhd --compact ~/cake_lamp_vm/cake-lamp-vm-hd.vdi</span></pre>
+ <p>Replace the <span style="font-family: monospace;">~/cake_lamp_vm</span>
+ path with the real VM storage path. This command compacts the root
+ (and only) partition of the VM.</p>
+ <p>After these steps are complete, the VM should be its minimal size.</p>
<h2>Adding a new website and domain on the guest VM</h2>
<p>Note: these instructions, even the quick approaches below, pale in
comparison to the ease of use of the "standup" command in feisty meow's
site avenger scripts. The standup command is detailed in the <a
- title="useful commands" href="https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt">feisty
+ target="_blank" title="useful commands" href="https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt">feisty
meow command reference</a> document. These instructions are for
situations when the domain or site is idiosyncratic in some way that
standup doesn't support.</p>
details on how to add a containing domain for the first time.
<h4>Quick approach: Use the feisty meow "add_domain" command.</h4>
<p>Run this command in a bash shell on the VM:</p>
- <pre># add_domain excalibur.cakelampvm.com</pre>
+ <pre><span style="font-weight: bold;">add_domain excalibur.cakelampvm.com</span></pre>
<p>Done.</p>
<h4>Manual approach: Edit the bind9 configuration.</h4>
<p>Note: the manual approach is not compatible with later use of feisty
meow's "remove_domain".</p>
Execute the following command to edit the DNS file for the cakelampvm
domain:
- <pre># sudo vi /etc/bind/cakelampvm.com.conf</pre>
+ <pre><span style="font-weight: bold;">sudo vi /etc/bind/cakelampvm.com.conf</span></pre>
<p>Add a stanza for the new site at the end of this file:</p>
<pre>excalibur.cakelampvm.com. IN A 10.28.42.20<br> IN HINFO "linux server" "ubuntu"</pre>
<p>Restart the DNS server:</p>
- <pre># sudo service bind9 restart</pre>
+ <pre><span style="font-weight: bold;">sudo service bind9 restart</span></pre>
<p>Afterwards, pinging excalibur.cakelampvm.com should work from both the
guest VM and the host PC.</p>
<h3>DNS Option B: Using an entirely new domain for the site</h3>
this example, we need to add the site "excalibur.tv" into the DNS.</p>
<h4>Quick approach: Use the feisty meow "add_domain" command.</h4>
Run this command in a bash shell on the VM:
- <pre># add_domain excalibur.tv</pre>
+ <pre><span style="font-weight: bold;">add_domain excalibur.tv</span></pre>
<p>Done.</p>
<h4>Manual approach: Edit a new DNS config file</h4>
<p>Note: the manual approach is not compatible with later use of feisty
to add the new file by adding this bit of configuration at the end:</p>
<pre>zone "excalibur.tv" in {<br> file "/etc/bind/excalibur.tv.conf";<br> type master;<br> allow-query { any; };<br>};</pre>
<p>Restart the DNS server:</p>
- <pre># sudo service bind9 restart</pre>
+ <pre><span style="font-weight: bold;">sudo service bind9 restart</span></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>
<p>Run this command in a bash shell on the VM:</p>
- <pre># add_apache_site excalibur excalibur.tv</pre>
+ <pre><span style="font-weight: bold;">add_apache_site excalibur excalibur.tv</span></pre>
<p>(The first parameter is the application name, the second is the domain
name.)</p>
<p>Done.</p>
<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. 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><VirtualHost *:80><br> ServerName excalibur.tv
DocumentRoot /home/apps/excalibur<br> ErrorLog ${APACHE_LOG_DIR}/excalibur.tv-error.log<br> CustomLog ${APACHE_LOG_DIR}/excalibur.tv-access.log combined<br> Include /etc/apache2/conf-library/basic-options.conf<br> Include /etc/apache2/conf-library/rewrite-enabling.conf<br></VirtualHost></pre>
<p>The above example is appropriate for our excalibur app in the
excalibur.tv domain (using DNS Option B). 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. We will
call our config file "excalibur.tv.conf". If you developed the file
in your home folder, this would be the command to move it up to Apache:</p>
- <pre># sudo cp ~/excalibur.tv.conf /etc/apache2/sites-available</pre>
+ <pre><span style="font-weight: bold;">sudo cp ~/excalibur.tv.conf /etc/apache2/sites-available</span></pre>
<p>Then tell apache to use the new file:</p>
- <pre># sudo a2ensite excalibur.tv # the '.conf' portion of the filename is unnecessary for this command.
+ <pre><span style="font-weight: bold;">sudo a2ensite excalibur.tv<br># the '.conf' portion of the filename is unnecessary for this command.</span>
</pre>
<p>Finally, restart apache to get it to begin serving the site:</p>
- <pre># sudo service apache2 restart</pre>
+ <pre><span style="font-weight: bold;">sudo service apache2 restart</span></pre>
<h3>Test the new web site</h3>
<p>Given the configuration above, your host PC should now be able to access
the new website on the domain "excalibur.tv".</p>
<p>To test this, first try pinging the new DNS name:</p>
- <pre># ping excalibur.tv</pre>
- <p>If there are responses to the ping *and* the answer is 10.28.42.20, then
- it means the DNS is working. 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".
- That should at least bring up the configured site storage path, even if
- nothing is being served from that folder yet.</p>
+ <pre><span style="font-weight: bold;">ping excalibur.tv</span></pre>
+ <p>If there are responses to the ping <span style="font-weight: bold;">*and*</span>
+ the answer is 10.28.42.20, then it means the DNS is working.</p>
+ <p>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 "<a title="it's excalibur, wilbur!"
+ href="http://excalibur.tv">http://excalibur.tv</a>". 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. 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>
- <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"
- 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". There may be more than one,
- if there are multiple network interfaces.</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><br>
- </p>
- <h1>Gritty Details</h1>
- <p>This is the lowest level of plumbing for your VM. Hopefully you
- will not need to engage with this section. The most useful area here
- is the one below about the "Virtualbox guest additions", which you will
- probably need at some future point. 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. These steps
- are provided for reference and updates.</p>
- <h3>Set up Virtualbox guest additions for the VM</h3>
- This procedure is needed if the guest provides an older or incompatible
- version of the guest additions (which have already been installed on the
- guest vm). It may also be necessary when a new version of the guest
- additions becomes available.
- <ol>
- <li>To install the guest additions, open the guest VM and have its window
- in focus.</li>
- <li>Choose the "Devices" menu and select "Insert Guest Additions CD
- Image". This will mount the CD's ISO image on the VM.</li>
- <li>On the guest VM, it may be necessary to mount the CD image that's now
- available:<br>
- <pre># sudo mount /dev/sr0 /media/cdrom</pre>
- <p>Linux will mention that the device is mounted "read-only".</p>
- </li>
- <li>Since the VM currently has no windowing system installed, one must
- start the Guest Additions install manually:<br>
- <pre># cd /media/cdrom<br># sudo sh VBoxLinuxAdditions.run</pre>
- </li>
- <li>The latest Virtualbox guest additions should now be installed.</li>
- </ol>
- <h3>Set up network adapters on guest VM</h3>
- <p>The network interfaces should already be configured on the guest within
- the Virtualbox configuration. This is available by clicking on the
- VM in the Virtualbox manager and selecting "Settings". These are the
- configuration settings used:</p>
- Adapter 1:<br>
- Attached to: Host-only Adapter<br>
- Name: vboxnet0 <br>
- <p>Adapter 2:<br>
- Attached to: Nat Network<br>
- Name: NatNetwork</p>
- <p>On the guest VM itself, the network settings are specified in a file
- called /etc/network/interfaces. Here are the current contents of
- that file:</p>
- <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> address 10.28.42.20<br> netmask 255.255.255.0<br> network 10.28.42.0<br> broadcast 10.28.42.255<br> dns-domain cakelampvm.com<br> dns-search cakelampvm.com<br> dns-nameservers 127.0.0.1 8.8.8.8</pre>
- <pre>auto enp0s8</pre>
- <pre>iface enp0s8 inet dhcp</pre>
- <p> </p>
+ for any error messages that can be corrected. The log files are
+ stored in "/var/log/apache2" and are named after the website (if
+ configured through the above process).</p>
<h2>Notes on building the Cake Lamp VM</h2>
<p>This is all work that should already have been done. It is
mentioned here just as breadcrumbs for a future vm builder.</p>
<ul>
<li>Downloaded and installed Virtualbox for host computer (where the vm
image will be built).</li>
- <li>Downloaded ubuntu server 16.04 iso.
- (https://www.ubuntu.com/download/server)</li>
+ <li>Downloaded ubuntu server 16.04 iso. (<a target="_blank" title="ubuntu server"
+ href="https://www.ubuntu.com/download/server">https://www.ubuntu.com/download/server</a>)</li>
<li>Created a new vm in Virtualbox, telling it to start from the ubuntu
server iso.</li>
- <li>Installed LAMP stack on guest VM. Some help here:
- http://howtoubuntu.org/how-to-install-lamp-on-ubuntu</li>
- <li>Configured CAKE on the guest VM. Useful link:
- https://askubuntu.com/questions/628938/how-to-install-cakephp-in-ubuntu-14-04</li>
+ <li>Installed LAMP stack on guest VM. Some help here: <a target="_blank"
+ title="lamplighter" href="http://howtoubuntu.org/how-to-install-lamp-on-ubuntu">http://howtoubuntu.org/how-to-install-lamp-on-ubuntu</a></li>
+ <li>Configured CAKE on the guest VM. Useful link: <a target="_blank"
+ 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>
<li>Configured the two network adapters as needed (one for host-only
network and one for nat network). Here's some info about
- Virtualbox networking with two adapters similar to our setup:
-https://askubuntu.com/questions/293816/in-virtualbox-how-do-i-set-up-host-only-virtual-machines-that-can-access-the-in<br>
+ Virtualbox networking with two adapters similar to our setup: <a target="_blank"
+ 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>
</li>
<li>Installed and configured Samba service for the guest VM. The
main config file lives in "/etc/samba/smb.conf". Some pointers
- here:
-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</li>
+ 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>
</ul>
<p><br>
</p>
projects / feisty_meow.git / blobdiff