4 <meta content="text/html; charset=windows-1252" http-equiv="content-type">
5 <title>Cake LAMP VM Documentation</title>
8 <h1 style="text-align: center;">The cakelampvm VM:<br>
9 Configuration and Usage</h1>
10 <h2 style=" text-align: center;">By Chris Koeritz</h2>
11 <h3 style=" text-align: center;"> Vintage: cakelampvm v002
12 Updated: 2017-11-16</h3>
13 <p>The cakelampvm project provides a virtualbox VM that acts as an "internet
14 in a bottle". The virtual machine provides DNS services (<a title="dns server"
15 href="http://www.bind9.net/">bind9</a>), a Web server (<a title="patchy"
16 href="https://httpd.apache.org/">Apache2</a>), a full <a title="ubuntu means compassion and humanity"
17 href="https://www.ubuntu.com/">Ubuntu</a> <a title="it's pronounced leenoox"
18 href="https://www.linuxfoundation.org/">Linux</a> desktop environment,
19 the <a title="flux is change" href="http://fluxbox.org/">Fluxbox</a> <a
20 title="a better windows" href="https://www.x.org/">X window manager</a>,
21 and a suite of tools called the <a title="feisty meow® concerns ltd. website"
22 href="https://feistymeow.org/">Feisty Meow® codebase</a>
23 <meta http-equiv="content-type" content="text/html; charset=utf-8">
24 . Together, these services provide you with a very flexible and
25 powerful testbed for web development, especially suited for <a title="it's cake"
26 href="https://cakephp.org/">CakePHP</a>.</p>
27 <p>todo: arrange gritty details to back.</p>
30 <h2><span style="text-decoration: underline;">G</span>uest VM Configuration</h2>
32 <li>hostname: <a title="the vm's website, when configured properly" href="https://cakelampvm.com/">cakelampvm.com</a></li>
33 <li>local IP address: 10.28.42.20</li>
34 <li>services: DNS (bind9), apache2, fluxbox X windowing system, <a title="not just in the garden"
35 href="https://www.gnome.org/">gnome display manager</a></li>
36 <li>main user: developer (password distributed separately)</li>
37 <li>mysql root password: (password distributed separately)</li>
39 <h2>Powering up with the Feisty Meow® scripts</h2>
40 <p>[First, let me drop the registered trademark symbol from here on
41 in. I hope its presence above has been sufficiently clear for legal
42 purposes, but now it will just get in the way. Also, capitalization
43 really bores me, and it's the feisty meow codebase anyhow, so that's how
44 it will be written henceforth.]</p>
45 <p>The feisty meow scripts are a cohesive bash scripting environment for
46 getting a variety of tasks done. The scripts recently incorporated
47 the 'avbash' collection from Saco Designs, which provides tools for
48 bringing up CakePHP web sites and managing the collection of repositories
49 for those sites. Each website is considered an "application", and
50 the application name itself (e.g. "winterportlibrary") can often provide
51 all the details for "powering up" the site. The feisty meow team has
52 added additional scripts for managing DNS domains and Apache websites that
53 provide the capability to "stand up" an entire website around an
54 application, with accompanying domain.</p>
55 <p>The scripts for now are documented separately within the Feisty Meow
56 codebase. The Feisty Meow readme file provides some valuable
57 information on configuring the codebase. If you have the cakelampvm,
58 then this has already been done for you on the vm in the developer account.
59 The script documentation is available in the UHHHHHH page of something..</p>
60 <h2>How to set up virtualbox for your host PC</h2>
62 <li>Download and install virtualbox:
63 https://www.virtualbox.org/wiki/Downloads</li>
64 <li>Install the extension pack for virtualbox: This provides USB drivers
65 and other features. This is installed on virtualbox itself, not on
68 <li>Download the extension pack at
69 https://www.virtualbox.org/wiki/Downloads</li>
70 <li>Stop any running virtualbox vms.</li>
71 <li>Close virtualbox control panel.</li>
72 <li>Double-click on the downloaded extensions package (in a file
73 explorer) and virtualbox should install it.</li>
75 <li>Run the virtualbox control panel.</li>
76 <li>Download the cakelampvm guest vm package and unzip it. Store the
77 unzipped version in some appropriate place where you want the virtual
78 machine to reside on your host's hard drive.</li>
79 <li>Add the guest VM to your list of VMs. From the virtualbox menus,
80 choose the "Machine" menu and select "Add". Point the selector
81 dialog at the cakelampvm folder you created above and open the
82 cakelampvm.vbox file.</li>
83 <li>Now the cakelampvm should show up in the list of virtual
84 machines. Before starting it, perform the following network
85 configuration sections.</li>
87 <h3>Configure the Host-Only network on virtualbox</h3>
88 <p>Configuring host-only networking for the VM makes the VM completely local
89 to your machine. The cakelampvm will not be accessible on the
90 internet or from the LAN, and can only be accessed by your host PC.</p>
92 <li> Go to virtual box "Preferences" (global preferences, not for a
94 <li> Click on the "Network" tab.</li>
95 <li> Choose the "Host-only Networks" tab from within "Network".</li>
96 <li> Click the plus icon to add a new host-only network, or if there is
97 already a Host-only network, then edit it.</li>
98 <li>Set the "Adapter" parameters:<br>
99 IPv4 Address: 10.28.42.1<br>
100 IPv4 Network Mask: 255.255.255.0<br>
101 IPv6 Address: (leave blank)<br>
102 IPv6 Prefix Length: 0<br>
103 Virtualbox will fill in the other details like so:<br>
104 <p><img alt="host only network adapter" src="images/host_only_network_adapter.png"></p>
106 <li>Set the "DHCP Server Settings" to disabled, e.g.<br>
107 <img alt="host only dhcp" src="images/host_only_adapter_dhcp_server.png"><br>
108 This is disabled because we will be using statically assigned addresses
109 for convenience and stability.</li>
111 <p>Additional information on host-only (and other) network adapter types is
112 at: https://www.virtualbox.org/manual/ch06.html#network_nat_service<br>
114 <h3>Configure the Nat Network on virtualbox</h3>
116 <li> Go to virtual box "Preferences" (global preferences, not for a
118 <li> Click on the "Network" tab.</li>
119 <li> Choose the "Nat Networks" tab from within "Network".</li>
120 <li> Click the plus icon to add a new host-only network.</li>
121 <li>Set the "NAT Network Details" parameters:<br>
122 Network Name: NatNetwork<br>
123 Network CIDR: 10.0.2.0/24<br>
124 Supports DHCP: checked<br>
125 Supports IPv6: optionally checked<br>
126 These are my settings, with IPv6 left disabled:<br>
127 <img alt="nat net config" src="images/nat_network_config.png"></li>
129 <h2>Start up the VM</h2>
130 <p>Using the virtualbox interface, you should now be able to start your
131 virtual machine. Virtualbox will complain if it detects any
132 remaining configuration problems in the VM, but it should start
133 normally. The Linux boot sequence will show many lines of text,
134 before bringing up a black console window with a login dialog.</p>
135 <p>You can log in directly on the VM console with the developer account, but
136 it is generally more useful to connect to the cakelampvm over ssh.
137 If the networking has been established properly, you should be able to do
139 <pre>ssh developer@cakelampvm.com (or equivalent with your ssh client)</pre>
140 <p>And then provide the password to log in.</p>
141 <p>A feature called "X forwarding" is enabled, so if you start graphical
142 applications on the VM, you can display them from an appropriately
143 configured host. (If you're running Linux as the host for the VM,
144 you can definitely run remote windows. Windows may not support
146 <p>#### check this!!!</p>
147 <h2>Using the guest VM's DNS services</h2>
148 <p>The cakelampvm has been set up to provide a DNS server which will answer
149 name requests for all of the sites that the VM hosts.</p>
150 <p>To use the cakelampvm DNS, modify your host operating system network
151 configuration by adding or changing the DNS server to use the guest VM's
152 DNS service. This is available at the local address
153 10.28.42.20. The DNS server can be tested with nslookup, dig and
155 <p>Note that the cakelampvm DNS should be listed first, if one intends to
156 override any DNS names that actually exist out on the internet.</p>
157 <p>If the DNS server is properly set up, then these ping commands should get
158 answering responses:</p>
159 <pre>ping cakelampvm.com</pre>
160 <pre>ping defaultcake.cakelampvm.com</pre>
161 <pre>ping mapsdemo.cakelampvm.com</pre>
162 <h3>Setting up DNS on Windows</h3>
163 <p>The ipconfig tool will provide helpful information about your current
164 networking and DNS configuration:</p>
165 <pre>ipconfig --all</pre>
166 <p>The DNS configuration on Windows is somewhat byzantine. The pipe
167 characters ('|') below are used to separate the menus or tabs or dialogs
168 to traverse. Follow this path to get to the DNS config:</p>
169 <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>
176 <h2>Editing files on the guest VM from the host</h2>
177 <p>On the host computer, look for the guest vm as a networked computer
178 called cakelampvm. This should provide some network shares using
179 Microsoft SMB protocol, and they can be attached to using the "developer"
180 user and its password.</p>
181 <p>On windows, one may want to mount this network location as a drive letter
182 for easier access.</p>
183 <p>Currently, the root of all web servers is exposed as "www". Editing
184 the files in those folders requires ownership by the developer user.
185 Currently the defaultcake server is owned by developer.</p>
186 <p>One should be able to create a new directory in the www folder owned by
187 the developer user over the network also, which can be used for creating
188 new projects. However, there is a config issue in the current vm
189 (v001) about this; to fix, run this command on the guest vm as the
191 <pre>sudo chmod g+w /var/www</pre>
192 <p>Afterwards, the www folder should allow the developer user to create new
194 <h2>Accessing files on the host PC from the guest VM</h2>
195 <p>If you want to share a folder from the host to the guest, perhaps for
196 driver updates or other conveniences, then make the share with these
199 <li>Create a folder on the host that is to be shared.</li>
200 <li>Right-click on the vm in virtualbox manager and choose "Settings".</li>
201 <li>In the "Shared Folders" tab of the settings, go to "Machine Folders".</li>
202 <li>Click the folder plus icon to create a new share.</li>
203 <li>Fill in the "Folder Path" on the host PC to the folder that will be
204 shared, and give it a name for the guest. We assume the folder
205 name will be "myshare".</li>
206 <li>On the guest vm, run the following commands to mount the share:<br>
207 <pre>mkdir ~/shared # for the guest's version of the shared folder</pre>
208 <pre>sudo mount -t vboxsf myshare ~/shared # mount the vm's share name onto the folder on the vm.</pre>
211 <h2>Adding a new website and domain on the guest VM</h2>
212 <p>To add a new website, you will need to pick one of the DNS options below
213 (A or B) depending on how you want to name the site. After the DNS
214 is updated, then follow the section after for creating a new apache conf
216 <p>Assuming one has created a new folder in "www" called "greatsite", then
217 the new web site can be brought online on the vm with one of the following
219 <h3>DNS Option A: Using a sub-domain in the cakelampvm.com domain</h3>
220 Connect to the cakelampvm via ssh as the developer user, e.g.: ssh
221 developer@cakelampvm.com
222 <p>Execute the following command to edit the DNS file for the cakelampvm
224 <pre>sudo vi /etc/bind/cakelampvm.com.conf</pre>
225 <p>Add a stanza for the new site at the end of this file:</p>
226 <pre>greatsite.cakelampvm.com IN A 10.28.42.20<br> IN HINFO "linux server" "ubuntu"</pre>
227 <p>Restart the DNS server: sudo service bind9 restart</p>
228 <p>Afterwards, pinging greatsite.cakelampvm.com should work from either the
229 guest or the host.</p>
230 <h3>DNS Option B: Using an entirely new domain for the site</h3>
231 <p>Similar procedure to above, but we will create a new file for the new
232 domain and add it to the bind directory. For this example, we will
233 create a file called /etc/bind/greatsite.tv.conf for our new domain
234 greatsite.tv with these contents:</p>
235 <pre>$TTL 1W<br>@ IN SOA @ fred.cakelampvm.com. (<br> 2017100801 ; serial<br> 2H ; refresh<br> 8M ; retry<br> 14D ; expiry<br> 6H ) ; minimum<br><br> IN NS ns.cakelampvm.com.<br> IN MX 10 mail.cakelampvm.com.<br><br># main domain for machine.<br>greatsite.tv. IN A 10.28.42.20<br> IN HINFO "linux server" "ubuntu"</pre>
236 The gnarly prefix stuff above the "greatsite.tv." listing establishes
237 configuration info for the new domain. This file relies on the
238 existing cakelampvm.com infrastructure in DNS, such as the "ns" host, which
239 is the domain's name server.
240 <p>Now that the config file is in place, edit "named.conf.local" to add the
241 new file by adding this bit of configuration at the end:</p>
242 <pre>zone "greatsite.tv" in {<br> file "/etc/bind/greatsite.tv.conf";<br> type master;<br> allow-query { any; };<br>};</pre>
243 <p>Restart the DNS server: sudo service bind9 restart</p>
244 <p>Afterwards, pinging greatsite.tv should work from either the guest or the
246 <h3>Create a new apache configuration file and load it</h3>
247 <p>Start with the following template file for the new website, and modify it
248 for the appropriate host name:</p>
249 <pre><VirtualHost *:80><br> ServerName greatsite.cakelampvm.com<br> ServerAlias greatsite.cakelampvm.com *.greatsite.cakelampvm.com<br> DocumentRoot /var/www/greatsite<br> ErrorLog ${APACHE_LOG_DIR}/greatsite.cakelampvm.com-error.log<br> CustomLog ${APACHE_LOG_DIR}/greatsite.cakelampvm.com-access.log combined<br> Alias /statistics "/var/www/webwork.repository/webwork/maps_demo/webroot/statistics"<br> Include /etc/apache2/conf-library/basic-options.conf<br> Include /etc/apache2/conf-library/rewrite-enabling.conf<br></VirtualHost></pre>
250 <p>The above example is pre-modified for DNS Option A above, the
251 greatsite.cakelampvm.com name. Switching all of those to
252 "greatsite.tv" instead would support DNS option B.</p>
253 <p>Copy that file into /etc/apache/available-sites under an appropriate
254 name, which here we will call "greatsite.conf".</p>
255 <p>Tell apache to use the new file:</p>
256 <pre>a2ensite greatsite.conf</pre>
257 <p>Finally, restart apache to get it to begin serving the site:</p>
258 <pre>sudo service apache2 restart</pre>
259 <h3>Test the new web site</h3>
260 <p>Given the configuration above, your host PC should now be able to access
262 <p>To test this, first try pinging the hostname, e.g.: ping
263 greatsite.cakelampvm.com or ping greatsite.tv</p>
264 <p>Then, if there are responses to the ping, it means the DNS is
265 working. If there are no responses, check the instructions in the
266 above DNS option section.</p>
267 <p>Once the DNS is working, one can try browsing to the site at:
268 http://greatsite.cakelampvm.com or http://greatsite.tv (depending on the
269 DNS option chosen).</p>
270 <p>If the site is not showing up properly, try examining the apache logs for
271 error messages that can be corrected. The log files are stored in
272 /var/log/apache2 and are generally named after the website.</p>
273 <h2>Configuring the guest VM</h2>
274 <p>The guest VM should already be set up appropriately. These steps
275 are provided for reference and updates.</p>
276 <h3>Set up virtualbox guest additions for the VM</h3>
277 <p>** note for v001 of cakelampvm: the below steps are still needed on the
279 <p>This procedure is needed if the guest provides an older or incompatible
280 version of the guest additions (which have already been installed on the
281 guest vm). It may also be necessary when a new version of the guest
282 additions becomes available.</p>
284 <li>To install the guest additions, open the guest VM and have its window
286 <li>Choose the "Devices" menu and select "Insert Guest Additions CD
287 Image". This will mount the CD's ISO image on the VM.</li>
288 <li>On the guest VM, it may be necessary to mount the CD image that's now
290 sudo mount /dev/sr0 /media/cdrom</li>
291 <li>Since the VM currently has no windowing system installed, one must
292 start the Guest Additions install manually:<br>
294 sudo sh VBoxLinuxAdditions.run</li>
295 <li>This should install the guest additions.</li>
297 <h3>Set up network adapters on guest VM</h3>
298 <p>The network interfaces should already be configured on the guest within
299 the virtualbox configuration. This is available by clicking on the
300 VM in the virtualbox manager and selecting "Settings". These are the
301 configuration settings used:</p>
303 Attached to: Host-only Adapter<br>
304 Name: vboxnet0 <br>
306 Attached to: Nat Network<br>
307 Name: NatNetwork</p>
308 <p>On the guest VM itself, the network settings are specified in a file
309 called /etc/network/interfaces. Here are the current contents of
311 <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>
312 <pre>auto enp0s8</pre>
313 <pre>iface enp0s8 inet dhcp</pre>
315 <h2>Handy Techniques</h2>
316 <h3>Get the network address on the guest vm</h3>
317 <p>Run this command: ifconfig</p>
318 <p>In the results, look for "inet addr". There may be more than one,
319 if there are multiple network interfaces.</p>
320 <h3>How to cleanly reboot or shut down the guest VM</h3>
321 <p>When you've got the DNS and everything integrated, these commands will
322 manage the vm's state:</p>
323 <p>First, log into the guest VM: ssh developer@cakelampvm.com</p>
324 <p>Then, reboot the guest VM: sudo reboot</p>
325 <p>Or, halt the guest VM: sudo shutdown -h now</p>
326 <p>Using these commands is better than just cycling the power from the
327 virtualbox control panel.</p>
328 <h2>Notes on building the Cake Lamp VM</h2>
329 <p>This is all work that should already have been done. It is
330 mentioned here just as breadcrumbs for a future vm builder.</p>
332 <li>Downloaded and installed virtualbox for host computer (where the vm
333 image will be built).</li>
334 <li>Downloaded ubuntu server 16.04 iso.
335 (https://www.ubuntu.com/download/server)</li>
336 <li>Created a new vm in virtualbox, telling it to start from the ubuntu
338 <li>Installed LAMP stack on guest VM. Some help here:
339 http://howtoubuntu.org/how-to-install-lamp-on-ubuntu</li>
340 <li>Configured CAKE on the guest VM. Useful link:
341 https://askubuntu.com/questions/628938/how-to-install-cakephp-in-ubuntu-14-04</li>
342 <li>Configured the two network adapters as needed (one for host-only
343 network and one for nat network). Here's some info about
344 virtualbox networking with two adapters similar to our setup:
345 https://askubuntu.com/questions/293816/in-virtualbox-how-do-i-set-up-host-only-virtual-machines-that-can-access-the-in<br>
347 <li>Installed and configured Samba service for the guest VM. The
348 main config file lives in "/etc/samba/smb.conf". Some pointers
350 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>
projects / feisty_meow.git / blob