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.
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. The site avenger script documentation is available in the feisty meow command reference file.
(The feisty meow codebase is already configured for the developer account on the cakelampvm virtual machine.)
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.
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.
To configure the host-only network, follow these steps:
Additional information on host-only (and other) network adapter types is at: https://www.virtualbox.org/manual/ch06.html#network_nat_service
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.
To set up the NAT network, follow these steps:
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)
And then provide the password to log in.
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.
...{insert that info}...
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 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. 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. 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.
It is important 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!
Once the DNS server is properly set up, these ping commands should get answering responses (from 10.28.42.20):
ping cakelampvm.com
ping defaultcake.cakelampvm.com
ping mapsdemo.cakelampvm.com
The ipconfig tool will provide helpful information about your current networking and DNS configuration:
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
{fill in rest}
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" user and its password.
On windows, one may want to mount this network location as a drive letter 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.
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:
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.
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.
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".
Run this command in a bash shell on the VM:
add_domain excalibur.cakelampvm.com
Done.
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.
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 1WThe gnarly prefix stuff above the "greatsite.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.
@ 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"
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 host.
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
Finally, restart apache to get it to begin serving the site:
sudo service apache2 restart
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 guest VM should already be set up appropriately. These steps are provided for reference and updates.
** 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.
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:
Adapter 1:Adapter 2:
Attached to: Nat Network
Name: NatNetwork
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:
source /etc/network/interfaces.d/*
auto lo
iface lo inet loopback
auto enp0s3
iface enp0s3 inet static
address 10.28.42.20
netmask 255.255.255.0
network 10.28.42.0
broadcast 10.28.42.255
dns-domain cakelampvm.com
dns-search cakelampvm.com
dns-nameservers 127.0.0.1 8.8.8.8
auto enp0s8
iface enp0s8 inet dhcp
Cheat sheet for Vim: https://vim.rtorr.com/
Git branching model that seems to work well: http://nvie.com/posts/a-successful-git-branching-model/
Run this command: ifconfig
In the results, look for "inet addr". There may be more than one, if there are multiple network interfaces.
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.
This is all work that should already have been done. It is mentioned here just as breadcrumbs for a future vm builder.
remaining work:
todo: arrange gritty details to back.
todo: toc goes after intro paragraph.