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]

Open the Oracle VirtualBox virtual machine.
Click New
Click Next

Set the name and type OS type (archivematica, linux-ubuntu)

Click Continue / Next
Set Memory to 2 GB (2048 MB) or higher
Click Continue
Select 'Use existing hard disk' and browse to and select archivematica-0.10-beta.vmdk
Click Continue. Review Summary and Click Create
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).

USB Warning at Startup?

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.

As the virtual appliance starts, you may have to select your machine from the list of available options. Hit return.
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'
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.

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

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.

@@ Line 1: / Line 1: @@
 [[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 =
-Archivematica is distributed as a [http://en.wikipedia.org/wiki/Virtual_appliance|virtual appliance] which integrates a number of software tools into one common virtual machine environment. Below are instructions for launching the virtual appliance.
+Archivematica is distributed as a [http://en.wikipedia.org/wiki/Virtual_appliance 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]]
+*See the [[documentation]] page for instructions on how to use the virtual appliance to accomplish the system [[requirements]].
+</br>
-----
-. Download Archivematica virtual appliance image.
+=Minimum hardware requirements=
-*Extract Archivematica-0.3.2.tar.gz by right-clicking the tar.gz file and choosing "extract here". This should result the following being created within an archivematica folder:
+*Processor: Intel core 2 or AMD Opteron
-**Archivematica-0.3.2.ovf
+*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.
-**disk0.vmdk
+*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
+</br>
-. Download and Install Sun VirtualBox
+=Instructions for using the VM image in VirtualBox=
-*[http://www.sun.com/software/products/virtualbox/index.jsp http://www.sun.com/software/products/virtualbox/index.jsp]
+==Install Oracle Virtual Box==
+*Archivematica uses the [http://en.wikipedia.org/wiki/Open_Virtualization_Format Open Virtualization Format] and has been tested with the free and open-source [http://www.sun.com/software/products/virtualbox/index.jsp 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 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.
-. Create Archivematica virtual machine
+==Download Archivematica ==
-*Open VirtualBox
+*[http://archivematica.org/download Download] the latest version of the Archivematica appliance.
-*Click File > Import Appliance
+*Unzip the Archivematica file. This should result in the following file appearing in an Archivematica folder:
-*Click Choose
+**archivematica-0.10-beta.vmdk
-*Select ''Archivematica-0.3.2.ovf''
-*Click Open
-*Click Next
-*Click Import
-*Read and agree to the Software License Agreement
-*The virtual box will open with Archivematica 0.3.2 listed on the left-hand side. Select Archivematica 0.3.2 and click Start (the green arrow in the menu)
-*The image should launch, showing you a Linux Ubuntu desktop and the digital preservation applications which are currently part of Archivematica 0.3.2.
-**You may have to login 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.
+</br>
+<div class="note">
+<strong>Remember:</strong>
+</br>
+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).
+</div>
+</br>
-.1 Importing Files into the Archivimatica Virtual Machine (optional)
+== Start Archivematica virtual appliance ==
-* See [[Create a shared folder]] for instructions on how to set up a shared folder to allow you to move test files back and forth between the host machine OS and the virtual machine.
-. Location of test files
+<ol>
+<li>Open the Oracle VirtualBox virtual machine.</li>
+<li>Click New</li>
+<li>Click Next</li>
+[[File:new_next_VMWizard.png]]
+<li>Set the name and type OS type (archivematica, linux-ubuntu)</li>
+[[File:2_VM_Name_OS_type.png]]
+<li>Click Continue / Next</li>
+<li>Set Memory to 2 GB (2048 MB) or higher</li>
-*Test files are located in home/demo/ingest.
+<li>Click Continue</li>
+<li>Select 'Use existing hard disk' and browse to and select archivematica-0.10-beta.vmdk</li>
+<li>Click Continue. Review Summary and Click Create</li>
+<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>
+[[File:6_start_archivematica_VM.png]]
+<div class="note"><strong>USB Warning at Startup?</strong>
+</br>
+[[File:error_USB_setup.png]]
+</br>
-. Generating checksums
+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 [http://www.virtualbox.org/manual/ch12.html#ts_usb-linux here].
+</div>
+</br>
+<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]]
+<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):
-*Select the files for which you would like to generate the checksums. Please note that as of the current version of Archivematica you cannot select folders, only files.
+<ol>
-*Right click, then select Scripts > makeMD5.
+<li> Shut the virtual machine down if it is open.
-*Save the report in the same folder.
+<li> In virtualbox select the archivematica virtual machine and click on Settings
-*Copy all the files, including the MD5 report, to another folder (eg. archivalstorage)
+<li> Click the 'Network' tab
-*Right-click the report, then select Scripts > checkMD5
+<li> 'Adapter 1' should be set to NAT by default (this allows you to get to the internet); click on 'Adapter 2' tab
-*The report should tell you that all files are OK. If you didn't move over all the files or if there was a problem which changed one or more of the files, the report will tell you that the checksum for those files failed.
+<li> Click enable adapter and set attached to 'host only adapter'
+</br>
+[[File:selecting_host_only_adapter.png]]
+</br>
+<li> Start the virtual machine
+<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.
+</ol></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.
-. Using DROID
+<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>
-*DROID provides a gui interface for selecting objects for processing. Navigate to home/demo/ingest/ and select the entire folder, or open the folder to select individual files.
+=== Permissions ===
-*DROID allows you to select an "include subfolders" option.
-*When the files are processed, go to File > Save List to save an xml report of the results.
+Users that are depositing files via ssh should be added to the archivematica group.
-. Using NLNZ Metadata Extraction Tool
+This can be done with:
+ $ sudo useradd -G archivematica Username
-*Creating a simple object will result in one xml report for each object; creating a complex object will create a single report for all objects.
+In the Virtual Machine, the demo user is already apart of this group.
-*When you create a new object in NLNZ, you will be asked to select the directory: enter /home/demo/ingest/.
-*The xml reports are set to output to usr/local/OAIS/metadata-extractor/harvested/nlnz_dd/.
+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---
-. Using JHOVE
-*To include calculation of checksums in the validation process, go to Edit > Preferences and click Calculate checksums.
+==Turn off virtual machine==
-*To process a directory of records, click File > Open URL and enter the directory: /home/demo/ingest/.
+*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".
-*To save an xml report, in the RepInfo window click on File > Save as; under Choose output handler select xml; then create a file name with the .xml extension added (otherwise JHOVE will save the report as plain text).
+#:
+[[file:archivematica_shutdown.png]]
+#:
+[[file:archivematica_shutdown2.png]]
+#:
-. Using Qubit
+This is from the VirtualBox help manual:
-*[http://qubit-toolkit.org/wiki/index.php?title=Main_Page Qubit] is an open-source software toolkit that allows institutions such as archives, libraries, museums, and art galleries to manage and host web-based collections of information resources.
+<blockquote>3.4.3. Saving the state of the machine</blockquote>
-**It is currently being implemented in the archival community as ICA-AtoM (International Council on Archives Access to Memory).
-***Please refer to the [http://www.ica-atom.org/docs/index.php?title=User_manual ICA-AtoM user manual] for instructions on how to use a typical Qubit application.
-*Qubit is being evaluated for use in the archivematica ''Data Management'' and ''Access'' components.
-*Please note that the VM version of Qubit is a development version, not a stable release.
-*Log in to Qubit using the user name ''demo@example.com'' and the password ''demo''.
+<blockquote>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.</blockquote>
+<blockquote>The difference between these three options is crucial. They mean:</blockquote>
+<blockquote>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.</blockquote>
+<blockquote>Saving the state of a virtual machine is thus in some ways similar to suspending a laptop computer (e.g. by closing its lid).</blockquote>
-. Using Xena
+<blockquote>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.</blockquote>
-*Click Add Directory to normalize a body of records.
+<blockquote>Power off the machine: With this option, VirtualBox also stops running the virtual machine, but without saving its state.</blockquote>
-*Select home/demo/ingest. Note that Xena will normalize the contents of the folder and any subfolders.
-*The default directory for Xena output is /home/demo/xena-output.
-*The Xena log will save automatically as /home/demo/xena-output/xena-log.
-*To view a normalized file, double-click on a file in the normalization results screen. For office documents, you will then need to select the option to view in OpenOffice.org.
-**If OpenOffice.org appears not to be working or takes a long time to open, go to Tools > Plugin Preferences >, and for "Sleep time allowed for OpenOffice to start (seconds)" select 3.
+<blockquote>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.</blockquote>
-. Using Bagit
+<blockquote>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.</blockquote>
-*Select a group of files or a folder.
+<blockquote>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.</blockquote>
-*Right-click, then select Scripts > Bagit.
-*Edit the name of the bag if desired.
-*The bag will automatically be saved to home/demo/mybags.

Difference between revisions of "Virtual appliance instructions"