Difference between revisions of "Virtual appliance instructions"

From Archivematica
Jump to navigation Jump to search
(Make deprecation warning more visible.)
 
(42 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
[[Main Page]] > Virtual appliance instructions
 
[[Main Page]] > Virtual appliance instructions
  
 +
{| class="wikitable" style="background-color:#ffcccc; font-size: 120%; font-weight: bold; " cellpadding="10"
 +
| Please note: Virtual appliance instructions were for last beta release: 0.10 - these notes are no longer supported. Instead please see: [[Getting started]]
 +
|}
  
 
= Distribution as a Virtual Appliance =
 
= Distribution as a Virtual Appliance =
Line 15: Line 18:
  
 
*Processor: Intel core 2 or AMD Opteron
 
*Processor: Intel core 2 or AMD Opteron
−
*Memory: 1 GB for the virtual appliance ('guest') operating system, i.e: if the 'host' operating system has 2 GB available, 1 GB needs to allocated to the 'guest'. Depending on the operating system, machines with less than 2 GB total memory will likely have trouble running Archivematica. Note that the default allocation setting in Archivematica is 512 MB; however, the more that is allocated the better the system will run. The setting can be changed once Archivematica is running.
+
*Memory: 2 GB for the virtual appliance ('guest') operating system, i.e: if the 'host' operating system has 4 GB available, 2 GB needs to allocated to the 'guest'. Depending on the operating system, machines with less than 2 GB total memory will likely have trouble running Archivematica. Note that the default allocation setting in Archivematica is 512 MB; however, the more that is allocated the better the system will run. The setting can be changed once Archivematica is running.
 
*Hard Drive space: a minimum of 3 GB to test the system on a small scale (i.e. use the available test files or import a small set of test files); 12 GB or more for larger implementations
 
*Hard Drive space: a minimum of 3 GB to test the system on a small scale (i.e. use the available test files or import a small set of test files); 12 GB or more for larger implementations
  
Line 32: Line 35:
 
*[http://archivematica.org/download Download] the latest version of the Archivematica appliance.
 
*[http://archivematica.org/download Download] the latest version of the Archivematica appliance.
 
*Unzip the Archivematica file. This should result in the following file appearing in an Archivematica folder:
 
*Unzip the Archivematica file. This should result in the following file appearing in an Archivematica folder:
−
**archivematica-0.9-beta.vmdk
+
**archivematica-0.10-beta.vmdk
−
[[File:extracting_archivmatica-vmdk-tbz.png]]
+
 
 
</br>
 
</br>
 
<div class="note">
 
<div class="note">
Line 53: Line 56:
 
[[File:2_VM_Name_OS_type.png]]
 
[[File:2_VM_Name_OS_type.png]]
 
<li>Click Continue / Next</li>
 
<li>Click Continue / Next</li>
−
<li>Set Memory to 1 GB (1024 MB) or higher</li>
+
<li>Set Memory to 2 GB (2048 MB) or higher</li>
−
[[File:3_set_memory.png]]
+
 
 
<li>Click Continue</li>
 
<li>Click Continue</li>
−
<li>Select 'Use existing hard disk' and browse to and select archivematica-0.9-beta.vmdk</li>
+
<li>Select 'Use existing hard disk' and browse to and select archivematica-0.10-beta.vmdk</li>
−
[[File:4_use_exist_hardisk_select_archivematica.png]]
 
 
<li>Click Continue. Review Summary and Click Create</li>
 
<li>Click Continue. Review Summary and Click Create</li>
−
[[File:5_review_click_create.png]]
+
<li>The virtual box will open with Archivematica 0.10-beta listed on the left-hand side (in some cases "archivematica" will be listed on the left-hand side). Select Archivematica 0.10-beta and click Start (the green arrow in the menu).</li>
−
<li>The virtual box will open with Archivematica 0.9-beta listed on the left-hand side (in some cases "archivematica" will be listed on the left-hand side). Select Archivematica 0.9-beta and click Start (the green arrow in the menu).</li>
 
 
[[File:6_start_archivematica_VM.png]]
 
[[File:6_start_archivematica_VM.png]]
  
Line 72: Line 73:
 
</br>
 
</br>
 
<li>As the virtual appliance starts, you may have to select your machine from the list of available options. Hit return.
 
<li>As the virtual appliance starts, you may have to select your machine from the list of available options. Hit return.
 +
</br>
 
[[File:inside_the_VM.png]]
 
[[File:inside_the_VM.png]]
−
<li>The image should launch, showing you a Linux Ubuntu desktop Login screen using the user name ''demo'' and the password ''demo''.  (on slower systems hitting return may cause the windows to reset, this is being addressed)</li>
+
<li>From here it is suggested that you use your external browser to access the archivematica dashboard. Due to an issue with the Ubuntu 12.04.1 desktop, we suggest you add settings to allow the Archivematica dashboard and ICA-AtoM to be accessed from your web browser, outside of the virtual machine. The steps are as follows [Please note, you may need to adjust your virtualbox preferences prior to taking this step. To do so, simply go to the network section of virtualbox preferences and click the "add" button, then save your change):
−
[[File:archivematica_virtualapp_login.png]]
 
−
<li>From here it is suggested that you use your external browser to access the archivematica dashboard (see '''Ubuntu login reset issue''', below)</li>
 
−
 
 
−
* Log into the Archivematica dashboard using the user name ''demo'' and the password ''demo''.
 
−
* If your mouse pointer does not appear to be working in the virtual machine, click the letter f while holding down the right-hand control button. Do the same thing to switch back to using your mouse pointer outside the virtual box.
 
−
 
 
−
<li>Congratulations, you have a running copy of Archivematica! See [[Documentation]] for instructions on how to use the software.</li>
 
−
</ol>
 
−
</br>
 
−
<div class="note">
 
−
'''Important:'''</br> Archivematica may appear to crash when used as a virtual appliance. See Ubuntu login reset issue, below.
 
−
</div>
 
−
 
 
−
==Ubuntu login reset issue==
 
−
*Due to an issue with the Ubuntu 12.04.1 desktop, Archivematica may appear to crash when in use. The user will see a brief display of dingbat characters in the terminal, followed by a return to the Ubuntu login. Logging in will restore the dashboard and the user can continue processing. To avoid this issue, you can add settings to allow the Archivematica dashboard and ICA-AtoM to be accessed from your web browser, outside of the virtual machine. The steps are as follows:
 
  
 
<ol>
 
<ol>
Line 102: Line 89:
 
<li> In your web browser, go to the url http://192.168.56.101/transfer/ (there is no need to login to the Archivematica virtual machine first). For ICA-AtoM, go to http://192.168.56.101/ica-atom/.  
 
<li> In your web browser, go to the url http://192.168.56.101/transfer/ (there is no need to login to the Archivematica virtual machine first). For ICA-AtoM, go to http://192.168.56.101/ica-atom/.  
 
<li>Congratulations! You can now use both Archivematica and ICA-AtoM via your web browser.
 
<li>Congratulations! You can now use both Archivematica and ICA-AtoM via your web browser.
−
</ol>
+
</ol></li>
  
−
==Import files into virtual appliance (optional)==
+
* Log into the Archivematica dashboard using the user name ''demo'' and the password ''demo''.  
−
If you want to use your own files in addition to the sample data provided, proceed with the following directions:
+
* If your mouse pointer does not appear to be working in the virtual machine, click the letter f while holding down the right-hand control button. Do the same thing to switch back to using your mouse pointer outside the virtual box.
−
 
 
−
===Using SFTP===
 
−
 
 
−
To use an [http://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol SSH File Transfer Protocol] to upload your own content:
 
−
 
 
−
* While in virtualbox right click the archivematica virtualmachine and click settings
 
−
* Click the 'Network' tab
 
−
* 'Adapter 1' should be set to NAT by default(this allows you to get to the internet), click on 'Adapter 2' tab
 
−
* Click enable adapter and set attached to 'host only adapter'
 
−
 
 
−
[[File:Selecting_host_only_adapter.png]]
 
−
 
 
−
* Power up the archivematica virtualmachine
 
−
* Once in the xubuntu interface goto Applications > Accessories > Terminal
 
  
 +
<li>Congratulations, you have a running copy of Archivematica! See [[Documentation]] for instructions on how to use the software.</li>
 +
</ol>
 +
</br>
 
<div class="note">
 
<div class="note">
−
<strong>Having trouble locating the Applications menu?<strong></br>
+
'''Important:'''</br> Archivematica may appear to crash when used as a virtual appliance. See Ubuntu login reset issue, below.
−
You can find applications by clicking on the little blue logo in the top left-hand corner of the virtual desktop: [[File:applications_menu_icon.png]]. Alternately, you can access the terminal by simply right-clicking anywhere in the virtual desktop, and selecting "Open terminal here."
 
 
</div>
 
</div>
  
−
[[File:applications_accessories_terminal.png]]
+
=== Permissions ===
  
−
* Type the following in terminal  (the password is demo) - this will take a minute and requires internet
+
Users that are depositing files via ssh should be added to the archivematica group.   
−
<pre>sudo aptitude install ssh </pre>
 
−
* type ifconfig in terminal you should see a IP address like '192.168.56.101'  (likely eth1 interface)
 
−
<pre>
 
−
$ ifconfig
 
−
eth1      Link encap:Ethernet  HWaddr fe:54:00:9d:92:64 
 
−
          inet addr:192.168.56.101  Bcast:192.168.56.255  Mask:255.255.255.0
 
−
          inet6 addr: fe80::1c6b:7bff:fe07:ddb6/64 Scope:Link
 
−
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
 
−
          RX packets:24 errors:0 dropped:0 overruns:0 frame:0
 
−
          TX packets:45 errors:0 dropped:0 overruns:0 carrier:0
 
−
          collisions:0 txqueuelen:0
 
−
          RX bytes:1400 (1.4 KB)  TX bytes:5815 (5.8 KB)
 
−
</pre>
 
−
*  From here your machine should be connectable via SFTP.  Download a SFTP client, a popular opensource option is FileZilla, which works on Linux and Windows.  If using OSX cyber duck is reported to be a decent opensource SFTP client.
 
  
−
* the connection information should be as follows
+
This can be done with:  
−
<pre>
+
$ sudo useradd -G archivematica Username
−
username: demo
 
−
password: demo
 
−
IP/Hostname: 192.168.56.101 < results of ifconfig likely '192.168.56.*'
 
−
port: 22
 
−
destination folder:   /home/demo/ < if this is not set you will have to navigate to /home/demo directory
 
−
</pre>
 
  
−
===Using Virtual Box Guest Additions===
+
In the Virtual Machine, the demo user is already apart of this group.
  
−
#Run Jockey
+
At a minimum, your deposited files should have the following permissions in order to upload them to the dashboard through source directories in the administration tab: rw-rw----  or rwxrwx---
−
#:<pre>sudo jockey-gtk</pre>
 
−
#Select Guest Additions from available drivers
 
−
#Restart
 
  
−
References
 
−
https://help.ubuntu.com/community/VirtualBox/SharedFolders
 
−
http://www.virtualbox.org/manual/ch04.html#sharedfolders
 
  
 
==Turn off virtual machine==
 
==Turn off virtual machine==
−
*At the end of your session, turn off the VirtualBox virtual machine by going to Machine > Close > and selecting one of the three shutdown options. It is best to choose either "Save the machine state" or "Send the shutdown signal". This is from the VirtualBox help manual:
+
*At the end of your session, turn off the VirtualBox virtual machine by going to Machine > Close > and selecting one of the three shutdown options. It is best to choose either "Save the machine state" or "Send the shutdown signal".  
 +
#:
 +
[[file:archivematica_shutdown.png]]
 +
#:
 +
[[file:archivematica_shutdown2.png]]
 +
#:
 +
 
 +
 
 +
This is from the VirtualBox help manual:
  
 
<blockquote>3.4.3. Saving the state of the machine</blockquote>
 
<blockquote>3.4.3. Saving the state of the machine</blockquote>

Latest revision as of 12:57, 20 June 2016

Main Page > Virtual appliance instructions

Please note: Virtual appliance instructions were for last beta release: 0.10 - these notes are no longer supported. Instead please see: Getting started

Distribution as a Virtual Appliance[edit]

Archivematica is distributed as a virtual appliance which integrates a number of software tools into one common virtual machine environment. A virtual appliance is one file containing a minimal operating system and server software. You can "play" this file with a free virtual machine player like VMware Player or Sun VirtualBox.

This allows Archivematica to be run on almost any workstation or server hardware without compromising the host machine's operating system or application software. At the same time, the virtual appliance is able to interact with any number of networked and/or external storage devices to allow for the flexible implementation of an archival storage and backup strategy.

  • See the software page for a full list of the tools used in each system release.
  • See the documentation page for instructions on how to use the virtual appliance to accomplish the system requirements.


Minimum hardware requirements[edit]

  • Processor: Intel core 2 or AMD Opteron
  • Memory: 2 GB for the virtual appliance ('guest') operating system, i.e: if the 'host' operating system has 4 GB available, 2 GB needs to allocated to the 'guest'. Depending on the operating system, machines with less than 2 GB total memory will likely have trouble running Archivematica. Note that the default allocation setting in Archivematica is 512 MB; however, the more that is allocated the better the system will run. The setting can be changed once Archivematica is running.
  • Hard Drive space: a minimum of 3 GB to test the system on a small scale (i.e. use the available test files or import a small set of test files); 12 GB or more for larger implementations


Instructions for using the VM image in VirtualBox[edit]

Install Oracle Virtual Box[edit]

  • Archivematica uses the Open Virtualization Format and has been tested with the free and open-source Oracle Virtual Box virtualization platform.
  • There are VirtualBox versions available for every major operating system.
    • Download and install Oracle VirtualBox: http://dlc.sun.com/virtualbox/vboxdownload.html. Note that if you are installing VirtualBox on Windows you will have to click through a number of warnings that you are attempting to install non-verified software.

Download Archivematica[edit]

  • Download the latest version of the Archivematica appliance.
  • Unzip the Archivematica file. This should result in the following file appearing in an Archivematica folder:
    • archivematica-0.10-beta.vmdk


Remember:
Be sure to take note of what location on your computer you choose to extract the file, so you can browse to it later when setting up the virtual appliance (instructions below).


Start Archivematica virtual appliance[edit]

  1. Open the Oracle VirtualBox virtual machine.
  2. Click New
  3. Click Next
    4. New next VMWizard.png
  4. Set the name and type OS type (archivematica, linux-ubuntu)
    5. 2 VM Name OS type.png
  5. Click Continue / Next
  6. Set Memory to 2 GB (2048 MB) or higher
  7. Click Continue
  8. Select 'Use existing hard disk' and browse to and select archivematica-0.10-beta.vmdk
  9. Click Continue. Review Summary and Click Create
  10. The virtual box will open with Archivematica 0.10-beta listed on the left-hand side (in some cases "archivematica" will be listed on the left-hand side). Select Archivematica 0.10-beta and click Start (the green arrow in the menu).
    11. 6 start archivematica VM.png
    USB Warning at Startup?


    Error USB setup.png

    Depending on the setup and configuration of your computer peripherals, you may get this warning the first time you try to launch the Archivematica virtual appliance. Don't worry - it has nothing to do with the installation. We suggest simply checking "Don't show this message again," clicking OK, and proceeding. If you do want some guidance on troubleshooting USB detection in the Virtualbox, you can look at Oracle's troubleshooting instructions for USB detection in Linux here.


  11. As the virtual appliance starts, you may have to select your machine from the list of available options. Hit return.
    Inside the VM.png
  12. From here it is suggested that you use your external browser to access the archivematica dashboard. Due to an issue with the Ubuntu 12.04.1 desktop, we suggest you add settings to allow the Archivematica dashboard and ICA-AtoM to be accessed from your web browser, outside of the virtual machine. The steps are as follows [Please note, you may need to adjust your virtualbox preferences prior to taking this step. To do so, simply go to the network section of virtualbox preferences and click the "add" button, then save your change):
    1. Shut the virtual machine down if it is open.
    2. In virtualbox select the archivematica virtual machine and click on Settings
    3. Click the 'Network' tab
    4. 'Adapter 1' should be set to NAT by default (this allows you to get to the internet); click on 'Adapter 2' tab
    5. Click enable adapter and set attached to 'host only adapter'
      Selecting host only adapter.png
    6. Start the virtual machine
    7. In your web browser, go to the url http://192.168.56.101/transfer/ (there is no need to login to the Archivematica virtual machine first). For ICA-AtoM, go to http://192.168.56.101/ica-atom/.
    8. Congratulations! You can now use both Archivematica and ICA-AtoM via your web browser.
    • Log into the Archivematica dashboard using the user name demo and the password demo.
    • If your mouse pointer does not appear to be working in the virtual machine, click the letter f while holding down the right-hand control button. Do the same thing to switch back to using your mouse pointer outside the virtual box.
  13. Congratulations, you have a running copy of Archivematica! See Documentation for instructions on how to use the software.


Important:
Archivematica may appear to crash when used as a virtual appliance. See Ubuntu login reset issue, below.

Permissions[edit]

Users that are depositing files via ssh should be added to the archivematica group.

This can be done with: 

$ sudo useradd -G archivematica Username

In the Virtual Machine, the demo user is already apart of this group.

At a minimum, your deposited files should have the following permissions in order to upload them to the dashboard through source directories in the administration tab: rw-rw---- or rwxrwx---


Turn off virtual machine[edit]

  • At the end of your session, turn off the VirtualBox virtual machine by going to Machine > Close > and selecting one of the three shutdown options. It is best to choose either "Save the machine state" or "Send the shutdown signal".

Archivematica shutdown.png

Archivematica shutdown2.png


This is from the VirtualBox help manual:

3.4.3. Saving the state of the machine

When you click on the "Close" button of your virtual machine window (at the top right of the window, just like you would close any other window on your system) (or press the Host key together with "Q"), VirtualBox asks you whether you want to "save" or "power off" the VM.

The difference between these three options is crucial. They mean:

Save the machine state: With this option, VirtualBox "freezes" the virtual machine by completely saving its state to your local disk. When you later resume the VM (by again clicking the "Start" button in the VirtualBox main window), you will find that the VM continues exactly where it was left off. All your programs will still be open, and your computer resumes operation.

Saving the state of a virtual machine is thus in some ways similar to suspending a laptop computer (e.g. by closing its lid).

Send the shutdown signal. This will send an ACPI shutdown signal to the virtual machine, which has the same effect as if you had pressed the power button on a real computer. So long as a fairly modern operating system is installed and running in the VM, this should trigger a proper shutdown mechanism in the VM.

Power off the machine: With this option, VirtualBox also stops running the virtual machine, but without saving its state.

This is equivalent to pulling the power plug on a real computer without shutting it down properly. If you start the machine again after powering it off, your operating system will have to reboot completely and may begin a lengthy check of its (virtual) system disks.

As a result, this should not normally be done, since it can potentially cause data loss or an inconsistent state of the guest system on disk.

The "Discard" button in the main VirtualBox window discards a virtual machine's saved state. This has the same effect as powering it off, and the same warnings apply.

Retrieved from "https://wiki.archivematica.org/index.php?title=Virtual_appliance_instructions&oldid=11135"