X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=production%2Fsites%2Fcakelampvm.com%2Fdocs%2Fmanual%2Fcakelampvm_guide_v002.html;h=33de228268bc37fc50b355bba5f6768050d2f3f8;hb=20768c094c4fe87ea2400614937fd6e284b075e4;hp=9031f148dae0b160356ce77ab1603d960501d43d;hpb=10175efae90f5cfe3eb806c0e833326cf848f5ec;p=feisty_meow.git diff --git a/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html b/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html index 9031f148..33de2282 100644 --- a/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html +++ b/production/sites/cakelampvm.com/docs/manual/cakelampvm_guide_v002.html @@ -7,77 +7,67 @@

The cakelampvm VM:
Configuration and Usage

-

By Chris Koeritz

+
By Chris + Koeritz
+ feisty meow® concerns ltd.

Vintage: cakelampvm v002    - Updated: 2017-11-16

-

The cakelampvm project provides a virtualbox VM that acts as an "internet - in a bottle".  The virtual machine provides DNS services (bind9), a Web server (Apache2), a full Ubuntu Linux desktop environment, - the Fluxbox X window manager, - and a suite of tools called the Feisty Meow® codebase - - .  Together, these services provide you with a very flexible and - powerful testbed for web development, especially suited for CakePHP.

-

todo: arrange gritty details to back.

-

TOC GOES HERE.

-
-

Guest VM Configuration

+ Updated: 2017-12-19 (rev. h) +

The cakelampvm project provides a Virtualbox VM that acts as an "internet + in a bottle", serving up your web sites securely and only to your local + host.  The virtual machine provides DNS services (bind9), a Web server + (Apache2), + a full Ubuntu + Linux + desktop environment, the Fluxbox + X + window manager, and a suite of tools called the Feisty + Meow® codebase .  Together, these services provide you with a + very flexible and powerful testbed for web development, especially suited + for CakePHP.  + This VM was built with the assistance of and was partially funded by Saco Design of Winterport, + Maine.

+

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.

+

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).

+

Guest VM Configuration

-

Powering up with the Feisty Meow® scripts

-

[First, let me drop the registered trademark symbol from here on - in.  I hope its presence above has been sufficiently clear for legal - purposes, but now it will just get in the way.  Also, capitalization - really bores me, and it's the feisty meow codebase anyhow, so that's how - it will be written henceforth.]

-

The feisty meow scripts are a cohesive bash scripting environment for - getting a variety of tasks done.  The scripts recently incorporated - the 'avbash' collection from Saco Designs, which provides 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 accompanying domain.

-

The scripts for now are documented separately within the Feisty Meow - codebase.  The Feisty - Meow readme file provides some valuable information on configuring - the codebase.  If you have the cakelampvm, then this has already been - done for you on the vm in the developer account.  The script - documentation is available in the UHHHHHH page of something..

-

How to set up virtualbox for your host PC

+

How to set up virtualbox for your host PC

    -
  1. Download and install virtualbox: - https://www.virtualbox.org/wiki/Downloads
  2. -
  3. Install the extension pack for virtualbox: This provides USB drivers - and other features.  This is installed on virtualbox itself, not on - the guests.
  4. +
  5. Download and install virtualbox: https://www.virtualbox.org/wiki/Downloads
  6. +
  7. 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.
    1. -
    2. Download the extension pack at - https://www.virtualbox.org/wiki/Downloads
    3. -
    4. Stop any running virtualbox vms.
    5. -
    6. Close virtualbox control panel.
    7. +
    8. Download the extension pack (also) at https://www.virtualbox.org/wiki/Downloads
    9. +
    10. Stop any running Virtualbox VMs.
    11. +
    12. Close the Virtualbox control panel.
    13. Double-click on the downloaded extensions package (in a file - explorer) and virtualbox should install it.
    14. + explorer) and Virtualbox should be launched to install it.
    -
  8. Run the virtualbox control panel.
  9. +
  10. Run the Virtualbox control panel.
  11. Download the cakelampvm guest vm package and unzip it.  Store the unzipped version in some appropriate place where you want the virtual machine to reside on your host's hard drive.
  12. -
  13. Add the guest VM to your list of VMs.  From the virtualbox menus, +
  14. Add the guest VM to your list of VMs.  From the Virtualbox menus, choose the "Machine" menu and select "Add".  Point the selector dialog at the cakelampvm folder you created above and open the cakelampvm.vbox file.
  15. @@ -85,10 +75,17 @@ machines.  Before starting it, perform the following network configuration sections.
-

Configure the Host-Only network on virtualbox

+

Configure the Host-Only network on Virtualbox

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.

+ 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.

+

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 cakelampvm settings and + selecting the appropriate network names again.

+

To configure the host-only network, follow these steps:

  1. Go to virtual box "Preferences" (global preferences, not for a specific vm).
  2. @@ -101,7 +98,8 @@ IPv4 Network Mask: 255.255.255.0
    IPv6 Address: (leave blank)
    IPv6 Prefix Length: 0
    - Virtualbox will fill in the other details like so:
    + Virtualbox will fill in the other details like so (this dialog may + differ between versions of virtualbox):

    host only network adapter

  3. Set the "DHCP Server Settings" to disabled, e.g.
    @@ -110,9 +108,16 @@ for convenience and stability.

Additional information on host-only (and other) network adapter types is - at: https://www.virtualbox.org/manual/ch06.html#network_nat_service
-

-

Configure the Nat Network on virtualbox

+ at: https://www.virtualbox.org/manual/ch06.html#network_nat_service

+

Configure the NAT Network on Virtualbox

+

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.  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.

+

To set up the NAT network, follow these steps:

  1. Go to virtual box "Preferences" (global preferences, not for a specific vm).
  2. @@ -124,57 +129,220 @@ Network CIDR: 10.0.2.0/24
    Supports DHCP: checked
    Supports IPv6: optionally checked
    - These are my settings, with IPv6 left disabled:
    + These are my settings, with IPv6 left disabled (this dialog may differ + between versions of virtualbox):
    nat net config
-

Start up the VM

-

Using the virtualbox interface, you should now be able to start your +

Starting up the VM and Connecting to It

+

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.

-

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:

-
ssh developer@cakelampvm.com  (or equivalent with your ssh client)
+ 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.

+

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.  (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.)

+ 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: +
ssh developer@10.28.42.20
# or perform the equivalent connection with your ssh client.

And then provide the password to log in.

-

A feature called "X forwarding" is enabled, so if you start graphical - applications on the VM, you can display them from an appropriately - configured host.  (If you're running Linux as the host for the VM, - you can definitely run remote windows.  Windows may not support - that.)

-

#### check this!!!

-

Using the guest VM's DNS services

+

Once the DNS services are set up (discussed in detail below), you will be + able to run the much friendlier command:

+
ssh developer@cakelampvm.com
+

Key Forwarding to the VM

+

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:

+
cakelampvm.com
10.28.42.20
+

Updating cakelampvm to the Latest Model

+

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...

+

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 on the VM:

+
# update to the latest version of feisty meow.
rpuffer $FEISTY_MEOW_APEX; reconfigure_feisty_meow
# enact any configuration changes needed, such as permissions and account setup. +revamp_cakelampvm
+ +

These two commands can be run at any time to patch up your VM to the + latest.

+

Recent versions of feisty meow support a new "get_feisty" + 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.

+ +

First Tasks as the Developer User

+

Here are some first steps that will make the vm your own:

+
    +
  1. 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:
    +
    passwd
    + The 'passwd' command will ask for your current password, and then for a + new password plus a verification of that new password.
    +  
  2. +
  3. Change your git configuration for the user and email address.  + This is how we've configured it so far:
    + + 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.
  4. +
+

Powering up with the Feisty Meow® scripts

+ 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. +

The site avenger scripts are documented separately within the feisty meow + codebase.  Consult the feisty +meow + readme file first, as it provides some valuable information on + configuring the codebase initially.  The site avenger script commands + are documented in the feisty + meow command reference file.

+

(The feisty meow codebase is already configured for the developer account + on the cakelampvm virtual machine.)

+

Using the guest VM's DNS services

The cakelampvm has been set up to provide a DNS server which will answer - name requests for all of the sites that the VM hosts.

+ 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 + domains that need to be looked up.

To use the cakelampvm DNS, modify your host operating system network configuration by adding or changing the DNS server to use the guest VM's - DNS service.  This is available at the local address - 10.28.42.20.  The DNS server can be tested with nslookup, dig and - other tools.

+ DNS service.  The cakelampvm is available at the local IP address + 10.28.42.20.  (The DNS server can be tested with nslookup, dig and + other tools.)

Note that the cakelampvm DNS should be listed first, if one intends to - override any DNS names that actually exist out on the internet.

-

If the DNS server is properly set up, then these ping commands should get - answering responses:

-
ping cakelampvm.com
-
ping defaultcake.cakelampvm.com
-
ping mapsdemo.cakelampvm.com
-

Setting up DNS on Windows

+ 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.

+

If your Host PC is running Windows, see the DNS configuration section + below that is tailored to that operating system.

+

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!  The + official Google DNS servers are 8.8.8.8 and 8.8.4.4.

+

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:

+
ping cakelampvm.com
+ +
ping www.cakelampvm.com
+

Note that any other answer than 10.28.42.20 for the address is *bzzzt* + wrong, and means something needs to be fixed.

+

If these pings succeed (which hopefully they will!), then try accessing + the websites of each domain:

+
(browse to) http://cakelampvm.com
+
(browse to) http://mapsdemo.cakelampvm.com
+

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.

+

Setting up DNS on Windows

The ipconfig tool will provide helpful information about your current networking and DNS configuration:

-
ipconfig --all
+
> ipconfig /all

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:

-
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
-


-

-


-

-


-

-

Editing files on the guest VM from the host

+
Control Panel | Network & Internet | Network & Sharing | click WiFI or Ethernet link near top right | click Adapter Settings button...
 | click on the specific network device to modify | select Properties
+

Once the properties dialog is displayed, find "internet protocol version + 4" in the list and double click it.

+

Change the DNS setting from "obtain...automatically" to "use the + following dns addresses".

+

Enter 10.28.42.20 as the first DNS address and clear the second address + (all blanks).

+

Hit okay, then okay, then close, etc to back out of adapter + configuration.

+

Troubleshooting the DNS

+

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 to start getting the right IP + address.  On Windows, the command for flushing DNS is:

+
> ipconfig /flushdns
+

and on Linux the flush DNS command can be many different things, but try + these two most common options:

+
# restarts the client side DNS cache.
sudo service dns-clean restart
+

or

+
# restarts the nscd caching server.
sudo service nscd restart
+ 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.
+

Host Key Issues for ssh

+

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:

+
The authenticity of host 'cakelampvm.com (104.236.56.82)' can't be established.
+

Note that the IP address shown is not our beloved 10.28.42.20 local IP + address.

+

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.

+

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).

+

Troubleshooting the Apache Sites

+

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 + shutting the browser application down.  Then, start the browser up + 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.

+

Editing files on the guest VM from the host

On the host computer, look for the guest vm as a networked computer called cakelampvm.  This should provide some network shares using Microsoft SMB protocol, and they can be attached to using the "developer" @@ -183,104 +351,218 @@ for easier access.

Currently, the root of all web servers is exposed as "www".  Editing the files in those folders requires ownership by the developer user.  - Currently the defaultcake server is owned by developer.

-

One should be able to create a new directory in the www folder owned by - the developer user over the network also, which can be used for creating - new projects.  However, there is a config issue in the current vm - (v001) about this; to fix, run this command on the guest vm as the - developer user:

-
sudo chmod g+w /var/www
-

Afterwards, the www folder should allow the developer user to create new - folders at will.

-

Accessing files on the host PC from the guest VM

+ The existing mapsdemo site is owned by a different user ("fred") rather + than developer, mostly as a test case.  The "fred", "developer", and + "www-data" accounts on the VM have all been put into each others Unix + "groups" so that they can access each other's files, and thus you may not + notice any issues editing fred's files.

+

One should be able to create a new directory over the network also.  + Try creating a junk folder in the "www" folder, and then deleting it + again.  That should succeed, and this approach can be used to create + folders (from the Host PC) that are owned by the developer user (on the + VM).  You should be able to create folders or copy files within the + developer's home folder also ("/home/developer").

+

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 (repeated from the section above about updating the cakelampvm):

+
revamp_cakelampvm
+

Afterwards, the www folder and others should allow the developer user to + create new folders at will.

+

Accessing files on the host PC from the guest VM

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 steps:

  1. Create a folder on the host that is to be shared.
  2. -
  3. Right-click on the vm in virtualbox manager and choose "Settings".
  4. +
  5. Right-click on the vm in Virtualbox manager and choose "Settings".
  6. In the "Shared Folders" tab of the settings, go to "Machine Folders".
  7. Click the folder plus icon to create a new share.
  8. Fill in the "Folder Path" on the host PC to the folder that will be shared, and give it a name for the guest.  We assume the folder name will be "myshare".
  9. On the guest vm, run the following commands to mount the share:
    -
    mkdir ~/shared    # for the guest's version of the shared folder
    -
    sudo mount -t vboxsf myshare ~/shared    # mount the vm's share name onto the folder on the vm.
    +
    # make the guest's version of the shared folder
    mkdir ~/shared
    # mount the vm's share name onto the folder on the vm.
    sudo mount -t vboxsf myshare ~/shared
+

X11 applications launched from the VM

+

[incomplete section]

+

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.

+

...{insert that info}...

Adding a new website and domain on the guest VM

-

To add a new website, you will need to pick one of the DNS options below - (A or B) depending on how you want to name the site.  After the DNS - is updated, then follow the section after for creating a new apache conf - file.

-

Assuming one has created a new folder in "www" called "greatsite", then - the new web site can be brought online on the vm with one of the following - options.

-

DNS Option A: Using a sub-domain in the cakelampvm.com domain

- Connect to the cakelampvm via ssh as the developer user, e.g.: ssh - developer@cakelampvm.com -

Execute the following command to edit the DNS file for the cakelampvm - domain:

-
sudo vi /etc/bind/cakelampvm.com.conf
+

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 feisty + meow command reference document.  These instructions are for + situations when the domain or site is idiosyncratic in some way that + standup doesn't support.

+

To add a new website, you will first need to pick one of the DNS options + below (A or B) depending on how you want to name the site.  If the + DNS name of the site is contained within another existing domain (e.g., + "A.B.C" has subdomain A contained in domain B.C), use Option A.  If + the DNS name is a so-called "Second Level Domain" (SLD), then it stands on + its own (e.g., "B.C" is an SLD).

+

Once the DNS option has been picked and implemented, continue to the next + section of "Creating a New Apache Site".

+

For either Option A or Option B, first connect to the cakelampvm via ssh + as the developer user, e.g.: ssh developer@cakelampvm.com

+

DNS Option A: Adding a sub-domain in an existing domain

+

Let us say a customer needs an application called "excalibur".  It + will be a new subdomain within an existing domain, such as the + "cakelampvm.com" domain, meaning we want the VM to start answering + requests for "excalibur.cakelampvm.com".

+ Note that this option requires the containing domain "cakelampvm.com" to + already exist before adding the subdomain; see DNS Option B below for + details on how to add a containing domain for the first time. +

Quick approach: Use the feisty meow "add_domain" command.

+

Run this command in a bash shell on the VM:

+
add_domain excalibur.cakelampvm.com
+

Done.

+

Manual approach: Edit the bind9 configuration.

+

Note: the manual approach is not compatible with later use of feisty + meow's "remove_domain".

+ Execute the following command to edit the DNS file for the cakelampvm + domain: +
sudo vi /etc/bind/cakelampvm.com.conf

Add a stanza for the new site at the end of this file:

-
greatsite.cakelampvm.com    IN A    10.28.42.20
        IN HINFO "linux server" "ubuntu"
-

Restart the DNS server: sudo service bind9 restart

-

Afterwards, pinging greatsite.cakelampvm.com should work from either the - guest or the host.

+
excalibur.cakelampvm.com.    IN A    10.28.42.20
        IN HINFO "linux server" "ubuntu"
+

Restart the DNS server:

+
sudo service bind9 restart
+

Afterwards, pinging excalibur.cakelampvm.com should work from both the + guest VM and the host PC.

DNS Option B: Using an entirely new domain for the site

-

Similar procedure to above, but we will create a new file for the new - domain and add it to the bind directory.  For this example, we will - create a file called /etc/bind/greatsite.tv.conf for our new domain - greatsite.tv with these contents:

-
$TTL 1W
@       IN SOA          @       fred.cakelampvm.com. (
                        2017100801      ; serial
                        2H              ; refresh
                        8M              ; retry
                        14D             ; expiry
                        6H )            ; minimum

        IN NS           ns.cakelampvm.com.
        IN MX   10      mail.cakelampvm.com.

# main domain for machine.
greatsite.tv.                 IN A            10.28.42.20
                              IN HINFO        "linux server" "ubuntu"
- The gnarly prefix stuff above the "greatsite.tv." listing establishes +

This is a similar procedure to Option A, but we will create a totally new + config file for the new domain and add it to the bind directory.  For + this example, we need to add the site "excalibur.tv" into the DNS.

+

Quick approach: Use the feisty meow "add_domain" command.

+ Run this command in a bash shell on the VM: +
add_domain excalibur.tv
+

Done.

+

Manual approach: Edit a new DNS config file

+

Note: the manual approach is not compatible with later use of feisty + meow's "remove_domain".

+ Create a file called /etc/bind/excalibur.tv.conf for our new domain + excalibur.tv with these contents: +
$TTL 1W
@       IN SOA          @       fred.cakelampvm.com. (
                        2017100801      ; serial
                        2H              ; refresh
                        8M              ; retry
                        14D             ; expiry
                        6H )            ; minimum

        IN NS           ns.cakelampvm.com.
        IN MX   10      mail.cakelampvm.com.

# new SLD for our excalibur site.
excalibur.tv.                 IN A            10.28.42.20
                              IN HINFO        "linux server" "ubuntu"
+ The gnarly prefix stuff above the "excalibur.tv." listing establishes configuration info for the new domain.  This file relies on the existing cakelampvm.com infrastructure in DNS, such as the "ns" host, which - is the domain's name server. -

Now that the config file is in place, edit "named.conf.local" to add the - new file by adding this bit of configuration at the end:

-
zone "greatsite.tv" in {
        file "/etc/bind/greatsite.tv.conf";
        type master;
        allow-query { any; };
};
-

Restart the DNS server: sudo service bind9 restart

-

Afterwards, pinging greatsite.tv should work from either the guest or the + is the domain's name server.  However, the new domain does not + live inside the cakelampvm.com domain.
+

Now that the config file is in place, edit "/etc/bind/named.conf.local" + to add the new file by adding this bit of configuration at the end:

+
zone "excalibur.tv" in {
        file "/etc/bind/excalibur.tv.conf";
        type master;
        allow-query { any; };
};
+

Restart the DNS server:

+
sudo service bind9 restart
+

Afterwards, pinging excalibur.tv should work from both the guest and the host.

-

Create a new apache configuration file and load it

+

Creating a New Apache Site

+

First, connect to the cakelampvm via ssh as the developer user, e.g.: ssh + developer@cakelampvm.com

+

Quick approach: Use the feisty meow "add_apache_site" command.

+

Run this command in a bash shell on the VM:

+
add_apache_site excalibur excalibur.tv
+

(The first parameter is the application name, the second is the domain + name.)

+

Done.

+

Manual approach: Edit an Apache config file

+

Note: the manual approach is not compatible with later use of feisty + meow's "remove_apache_site".

+

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.

Start with the following template file for the new website, and modify it - for the appropriate host name:

-
<VirtualHost *:80>
    ServerName greatsite.cakelampvm.com
    ServerAlias greatsite.cakelampvm.com *.greatsite.cakelampvm.com
    DocumentRoot /var/www/greatsite
    ErrorLog ${APACHE_LOG_DIR}/greatsite.cakelampvm.com-error.log
    CustomLog ${APACHE_LOG_DIR}/greatsite.cakelampvm.com-access.log combined
    Alias /statistics "/var/www/webwork.repository/webwork/maps_demo/webroot/statistics"
    Include /etc/apache2/conf-library/basic-options.conf
    Include /etc/apache2/conf-library/rewrite-enabling.conf
</VirtualHost>
-

The above example is pre-modified for DNS Option A above, the - greatsite.cakelampvm.com name.  Switching all of those to - "greatsite.tv" instead would support DNS option B.

-

Copy that file into /etc/apache/available-sites under an appropriate - name, which here we will call "greatsite.conf".

-

Tell apache to use the new file:

-
a2ensite greatsite.conf
+ for the appropriate host name and "DocumentRoot" path:

+
<VirtualHost *:80>
    ServerName excalibur.tv +    DocumentRoot /home/apps/excalibur
    ErrorLog ${APACHE_LOG_DIR}/excalibur.tv-error.log
    CustomLog ${APACHE_LOG_DIR}/excalibur.tv-access.log combined
    Include /etc/apache2/conf-library/basic-options.conf
    Include /etc/apache2/conf-library/rewrite-enabling.conf
</VirtualHost>
+

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 (and the path in the DocumentRoot) is sufficient to + re-target it for any domain you want.

+

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:

+
sudo cp ~/excalibur.tv.conf /etc/apache2/sites-available
+

Then tell apache to use the new file:

+
sudo a2ensite excalibur.tv
# the '.conf' portion of the filename is unnecessary for this command.
+

Finally, restart apache to get it to begin serving the site:

-
sudo service apache2 restart
+
sudo service apache2 restart

Test the new web site

Given the configuration above, your host PC should now be able to access - the new website.

-

To test this, first try pinging the hostname, e.g.: ping - greatsite.cakelampvm.com or ping greatsite.tv

-

Then, if there are responses to the ping, it means the DNS is - working.  If there are no responses, check the instructions in the - above DNS option section.

-

Once the DNS is working, one can try browsing to the site at: - http://greatsite.cakelampvm.com or http://greatsite.tv (depending on the - DNS option chosen).

-

If the 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 generally named after the website.

+ the new website on the domain "excalibur.tv".

+

To test this, first try pinging the new DNS name:

+
ping excalibur.tv
+

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.

+

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.

+

If the new site is not showing up properly, try examining the apache logs + 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).

+

Handy Techniques for Using cakelampvm

+

Assorted Guides and Cheat-Sheets

+

A Cheat sheet for the Vim editor (there are many of these available): https://vim.rtorr.com/

+

A git branching model that seems to work well: http://nvie.com/posts/a-successful-git-branching-model/

+

This is a basic guide to the Google Developer Console and API Key + management: Google + API Docs 

+

Using the "meld" Tool to Compare Files & Directories

+

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.

+

To run meld, just type this command:

+
meld A B
+

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.

+

Get the network address on the guest vm

+

Run this command:

+
ifconfig
+

In the results, look for "inet addr".  + There may be more than one, if there are multiple network interfaces.

+

The standard IP address is 10.28.42.20 for the cakelampvm.

+

How to cleanly reboot or shut down the guest VM

+

When you've got the DNS and everything integrated, these commands will + manage the vm's state:

+

First, log into the guest VM:

+
ssh developer@cakelampvm.com
+

Then, to reboot the guest VM:

+
sudo reboot
+

Or, to halt the guest VM:

+
sudo shutdown -h now
+

Using these commands is kinder to the VM than just cycling the power from + the Virtualbox control panel.

+

Gritty Details of the Nitty Variety

+

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.

Configuring the guest VM

The guest VM should already be set up appropriately.  These steps are provided for reference and updates.

-

Set up virtualbox guest additions for the VM

-

** note for v001 of cakelampvm: the below steps are still needed on the - shipped image.

-

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.

+

Set up Virtualbox guest additions for the VM

+ 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.
  1. To install the guest additions, open the guest VM and have its window in focus.
  2. @@ -288,17 +570,19 @@ Image".  This will mount the CD's ISO image on the VM.
  3. On the guest VM, it may be necessary to mount the CD image that's now available:
    - sudo mount /dev/sr0 /media/cdrom
  4. +
    sudo mount /dev/sr0 /media/cdrom
    +

    Linux will mention that the device is mounted "read-only".

    +
  5. Since the VM currently has no windowing system installed, one must start the Guest Additions install manually:
    - cd /media/cdrom
    - sudo sh VBoxLinuxAdditions.run
  6. -
  7. This should install the guest additions.
  8. +
    cd /media/cdrom
    sudo sh VBoxLinuxAdditions.run
    + +
  9. The latest Virtualbox guest additions should now be installed.

Set up network adapters on guest VM

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 + the Virtualbox configuration.  This is available by clicking on the + VM in the Virtualbox manager and selecting "Settings".  These are the configuration settings used:

Adapter 1:
  Attached to: Host-only Adapter
@@ -313,44 +597,56 @@
auto enp0s8
iface enp0s8 inet dhcp

-

Handy Techniques

-

Get the network address on the guest vm

-

Run this command: ifconfig

-

In the results, look for "inet addr".  There may be more than one, - if there are multiple network interfaces.

-

How to cleanly reboot or shut down the guest VM

-

When you've got the DNS and everything integrated, these commands will - manage the vm's state:

-

First, log into the guest VM: ssh developer@cakelampvm.com

-

Then, reboot the guest VM: sudo reboot

-

Or, halt the guest VM: sudo shutdown -h now

-

Using these commands is better than just cycling the power from the - virtualbox control panel.

+

Compacting the VM Disk Image

+

To minimize the size used for the disk image, there are three major + steps.

+

1. While running the VM, run this command:

+
sudo apt clean
+

This throws away any cached data from the apt tool, which can be + substantial.

+

If there are other junk files you know of that can be removed, delete + those now also.

+

2. Reboot the VM to the gparted ISO image (available at the gparted + site) and run the following command:

+
sudo zerofree /dev/sda
+

This sets all free space to the zero byte, enabling Virtualbox to free + that space in the next step.

+

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):

+
VBoxManage modifyhd --compact ~/cake_lamp_vm/cake-lamp-vm-hd.vdi
+

Replace the ~/cake_lamp_vm + path with the real VM storage path.  This command compacts the root + (and only) partition of the VM.

+

After these steps are complete, the VM should be its minimal size.

Notes on building the Cake Lamp VM

This is all work that should already have been done.  It is mentioned here just as breadcrumbs for a future vm builder.


+ +
+