Archivematica - User contributions [en]

Use the Live USB

2010-05-21T22:05:28Z

Berwin22:

[[File:Archivematica-usb.jpg|right]]

Archivematica can be run as a [http://en.wikipedia.org/wiki/Live_USB Live USB].

#Shut down your PC or laptop and insert the Archivematica USB key.
#Make sure no other devices are plugged into your USB ports
#Turn on your PC and hold down the key which brings up your computer's boot menu. This is usually F12. As you computer BIOS loads it will typically notify the user (briefly) which key(s) to press to enter the boot menu.
#Choose the boot from USB option
#Give the XUbuntu desktop a few minutes to load
#To help you get started, look in the Docs directory on the desktop for the Archivematica workflow instructions document.
#IMPORTANT: To shut down Archivematica, go to the top right of the screen and click on the quit button. Click the 'Shut Down' button. Give XUbuntu a few minutes to shut down.

[[File:ShutdownMouseOver.png|right]]
[[File:ShutdownMenu.png|right]]

There are some [http://en.wikipedia.org/wiki/Live_USB#Limitations known limitations] with using a Live USB on Macs and older PCs.

You can [[download]] and create your own Archivematica Live USB.

Use the Live USB

2010-05-21T22:01:14Z

Berwin22:

[[File:Archivematica-usb.jpg|right]]

Archivematica can be run as a [http://en.wikipedia.org/wiki/Live_USB Live USB].

#Shut down your PC or laptop and insert the Archivematica USB key.
#Make sure no other devices are plugged into your USB ports
#Turn on your PC and hold down the key which brings up your computer's boot menu. This is usually F12. As you computer BIOS loads it will typically notify the user (briefly) which key(s) to press to enter the boot menu.
#Choose the boot from USB option
#Give the XUbuntu desktop a few minutes to load
#To help you get started, look in the Docs directory on the desktop for the Archivematica workflow instructions document.
#IMPORTANT: To shut down Archivematica, go to the top right of the screen and click on the quit button.
Click the 'Shut Down' button. Give XUbuntu a few minutes to shut down.

[[File:ShutdownMouseOver.png|right]]
[[File:ShutdownMenu.png|right]]

There are some [http://en.wikipedia.org/wiki/Live_USB#Limitations known limitations] with using a Live USB on Macs and older PCs.

You can [[download]] and create your own Archivematica Live USB.

File:ShutdownMenu.png

2010-05-21T21:55:22Z

Berwin22: Shutdown menu

Shutdown menu

File:ShutdownMouseOver.png

2010-05-21T21:50:34Z

Berwin22: Shutdown Mouse Over

Shutdown Mouse Over

Application settings

2010-05-05T20:48:35Z

Berwin22: /* Selecting Normalization Tools */

[[Main Page]] > [[Documentation]] > Application settings

==Connect to shared directories==
**See [[Virtual_appliance_instructions#Import_files_into_virtual_appliance_.28optional.29|Connecting to shared directories on an external machine]]

==DIP upload destination==
*By default Archivematica is designed to upload access derivatives and metadata (DIPs) to ICA-AtoM
*Archivematica can upload to other access systems by switching the upload script
**create a copy of the upload-qubit.py script (e.g. upload-archon.py, upload-contentdm.py) (''where located?'')
**re-write post commands to match the expected import parameters of the target system
**change the upload script option in Archivematica (''where located?'')

==Quarantine time==
*change the following values to increase or decrease the amount of time that files spent locked in quarantine:
**/opt/archivematica/viriaccession.sh
**change 'amin' value on line 24

==Selecting Normalization Tools==
*Normalization tools used by normalize2.py are based on file extensions. It scans the NormalizationConf folder for EXTENSION.xml documents and if it doesn't find one then it uses the default normalization command. If it does find one, it reads the data inside.
**Note: file names are capitalized in the extention and lowercase '.xml'.
**Recomended naming convention for parents: Type and tool; ie 'IMAGES_CONVERT.xml'
**The default normalizationConf folder is /opt/archivematica/normalizationConf/

*If a parent is defined, it looks at the parent xml file and ignores all the other values in the current file.

*All of the %text% are defined in the replacementDic in normalize2.py.

Application settings

2010-05-05T20:45:33Z

Berwin22: added Selecting Normalization Tools

[[Main Page]] > [[Documentation]] > Application settings

==Connect to shared directories==
**See [[Virtual_appliance_instructions#Import_files_into_virtual_appliance_.28optional.29|Connecting to shared directories on an external machine]]

==DIP upload destination==
*By default Archivematica is designed to upload access derivatives and metadata (DIPs) to ICA-AtoM
*Archivematica can upload to other access systems by switching the upload script
**create a copy of the upload-qubit.py script (e.g. upload-archon.py, upload-contentdm.py) (''where located?'')
**re-write post commands to match the expected import parameters of the target system
**change the upload script option in Archivematica (''where located?'')

==Quarantine time==
*change the following values to increase or decrease the amount of time that files spent locked in quarantine:
**/opt/archivematica/viriaccession.sh
**change 'amin' value on line 24

==Selecting Normalization Tools==
*Normalization tools used by normalize2.py are based on file extensions. It scans the NormalizationConf folder for EXTENSION.xml documents and if it doesn't find one then it uses the default normalization command. If it does find one, it reads the data inside.
**Note: file names are capitalized in the extention and lowercase '.xml'.
**Recomended naming convention for parents: Type and tool; ie 'IMAGES_CONVERT.xml'

*If a parent is defined, it looks at the parent xml file and ignores all the other values in the current file.

*All of the %text% are defined in the replacementDic in normalize2.py.

Build a virtual appliance 0.6

2010-04-01T20:20:09Z

Berwin22:

[[Main Page]] > [[Development]] > Build a virtual appliance

Below are instructions for building your own Archivematica virtual appliance. This allows you to create intermediate or branch releases to test and use your own modifications.

==Requirements==
*Ubuntu server 9.10
*vmbuilder requires KVM which requires a virt compatible processor however, you do not need virt support for vmbuilder
*At least 2GB of ram

==Software Requirements==
subversion (SVN)
<pre>sudo apt-get install subversion
</pre>

vmbuilder
<pre>sudo apt-get install ubuntu-vm-builder
</pre>

A local apt-proxy. We recomend apt-cacher-ng.
<pre>sudo aptitude install apt-cacher-ng
sudo gedit /etc/apt-cacher-ng/acng.conf
</pre>
change the port.. whatever its set to..(3142 defuault) to 9999
Restart the service for changes to take effect.
<pre>sudo /etc/init.d/apt-cacher-ng restart
</pre>

==Pre Build==
1. check out the source
<pre>svn checkout http://archivematica.googlecode.com/svn/trunk/ archivematica-read-only</pre>

2. Modify archivematica-read-only/trunk/archivematica.cfg to resemble your file system IE:
<pre> execscript = /home/demo/trunk/archivematica.sh </pre>
should be
<pre> execscript = /home/yourhomefolder/archivematica-read-only/trunk/archivematica.sh </pre>

3. Build archivematica for your hosts virtualization platform. All the following commands will build the same virtual machine.. each for a different platform
<pre>
sudo vmbuilder vmserver ubuntu -c archivematica.cfg
sudo vmbuilder xen ubuntu -c archivematica.cfg
sudo vmbuilder kvm ubuntu -c archivematica.cfg
</pre>

==Post Build==
1. boot your virtual machine. For KVM its under ubuntu-kvm, for other examples please see [[Virtual_appliance_instructions]].
<pre>kvm -m 528 -smp 1 -drive file=disk0.qcow2 </pre>

2. From inside the machine open a terminal and run the following (password is demo)
<pre>
sudo aptitude install openjdk-6-jre
incrontab /etc/incron.tab
sudo mysqladmin create qubit
</pre>

3. Open firefox and navigate to http://localhost, go through the qubit installer for the database settings all defaults will work.

4. Aside from some icon placement you now have a fully functional version of archivematica!

Detox log

2010-04-01T19:42:57Z

Berwin22: /* Developoment */

{| border="1" width="50%"
|-
| Design
| This page proposes a new feature and reviews design options
|- style="background-color: rgb(255, 243, 243);"
| Development
| This page describes a feature that is currently in development
|-
| Documentation
| This page documents an existing feature
|}
== Design ==
To support various file systems the file & folder names were changed with the detox program.
These changes needed to be included in the metadata for the SIP.

== Developoment ==
- Once verified working correctly, should overwrite SIP.xml, and not create new file (SIPOUT.xml).
<br/>- Can verify the UUID for the SIPs correspond.

== Documentation ==
Detox will output a list of file changes. In the archivematica system these changes are logged to the detox.log.
To include this information, as metadata, the SIPOUT.xml is generated by add_detox_to_SIP.py from detox.log and SIP.xml.
add_detox_to_SIP.py proccesses detox.log line by line, to update any filename changes in SIPOUT.xml

Detox log

2010-04-01T19:41:47Z

Berwin22:

{| border="1" width="50%"
|-
| Design
| This page proposes a new feature and reviews design options
|- style="background-color: rgb(255, 243, 243);"
| Development
| This page describes a feature that is currently in development
|-
| Documentation
| This page documents an existing feature
|}
== Design ==
To support various file systems the file & folder names were changed with the detox program.
These changes needed to be included in the metadata for the SIP.

== Developoment ==
- Once verified working correctly, should overwrite SIP.xml, and not create new file (SIPOUT.xml).
- Can verify the UUID for the SIPs correspond.

== Documentation ==
Detox will output a list of file changes. In the archivematica system these changes are logged to the detox.log.
To include this information, as metadata, the SIPOUT.xml is generated by add_detox_to_SIP.py from detox.log and SIP.xml.
add_detox_to_SIP.py proccesses detox.log line by line, to update any filename changes in SIPOUT.xml

Detox log

2010-04-01T19:39:11Z

Berwin22:

{| border="1" width="50%"
|-
| Design
| This page proposes a new feature and reviews design options
|- style="background-color: rgb(255, 243, 243);"
| Development
| This page describes a feature that is currently in development
|-
| Documentation
| This page documents an existing feature
|}

[[Category:Design]]
To support various file systems the file & folder names were changed with the detox program.
These changes needed to be included in the metadata for the SIP.

[[Category:Developoment]]
- Once verified working correctly, should overwrite SIP.xml, and not create new file (SIPOUT.xml).
- Can verify the UUID for the SIPs correspond.

[[Category:Documentation]]
Detox will output a list of file changes. In the archivematica system these changes are logged to the detox.log.
To include this information, as metadata, the SIPOUT.xml is generated by add_detox_to_SIP.py from detox.log and SIP.xml.
add_detox_to_SIP.py proccesses detox.log line by line, to update any filename changes in SIPOUT.xml

Build a virtual appliance 0.6

2010-02-20T01:06:58Z

Berwin22: /* Software Requirements */

[[Main Page]] > [[Development]] > Build a virtual appliance

Below are instructions for building your own Archivematica virtual appliance. This allows you to create intermediate or branch releases to test and use your own modifications.

==Requirements==
*Ubuntu 9.04
*vmbuilder requires KVM which requires a virt compatible processor however, you do not need virt support for vmbuilder
*At least 2GB of ram

==Software Requirements==
subversion (SVN)
<pre>sudo apt-get install subversion
</pre>

vmbuilder
<pre>sudo apt-get install ubuntu-vm-builder
</pre>

A local apt-proxy. We recomend apt-cacher-ng.
<pre>sudo aptitude install apt-cacher-ng
sudo gedit /etc/apt-cacher-ng/acng.conf
</pre>
change the port.. whatever its set to..(3142 defuault) to 9999
Restart the service for changes to take effect.
<pre>sudo /etc/init.d/apt-cacher-ng restart
</pre>

==Pre Build==
1. check out the source
<pre>svn checkout http://archivematica.googlecode.com/svn/trunk/ archivematica-read-only</pre>

2. Modify archivematica-read-only/trunk/archivematica.cfg to resemble your file system IE:
<pre> execscript = /home/demo/trunk/archivematica.sh </pre>
should be
<pre> execscript = /home/yourhomefolder/archivematica-read-only/trunk/archivematica.sh </pre>

3. Build archivematica for your hosts virtualization platform. All the following commands will build the same virtual machine.. each for a different platform
<pre>
sudo vmbuilder vmserver ubuntu -c archivematica.cfg
sudo vmbuilder xen ubuntu -c archivematica.cfg
sudo vmbuilder kvm ubuntu -c archivematica.cfg
</pre>

==Post Build==
1. boot your virtual machine. For KVM its under ubuntu-kvm, for other examples please see [[Virtual_appliance_instructions]].
<pre>kvm -m 528 -smp 1 -drive file=disk0.qcow2 </pre>

2. From inside the machine open a terminal and run the following (password is demo)
<pre>
sudo aptitude install openjdk-6-jre
incrontab /etc/incron.tab
sudo mysqladmin create qubit
</pre>

3. Open firefox and navigate to http://localhost, go through the qubit installer for the database settings all defaults will work.

4. Aside from some icon placement you now have a fully functional version of archivematica!

Build a virtual appliance 0.6

2010-02-20T01:05:01Z

Berwin22: /* Software Requirements */

[[Main Page]] > [[Development]] > Build a virtual appliance

Below are instructions for building your own Archivematica virtual appliance. This allows you to create intermediate or branch releases to test and use your own modifications.

==Requirements==
*Ubuntu 9.04
*vmbuilder requires KVM which requires a virt compatible processor however, you do not need virt support for vmbuilder
*At least 2GB of ram

==Software Requirements==
subversion (SVN)
<pre>sudo apt-get install subversion
</pre>

vmbuilder
<pre>sudo apt-get ubuntu-vm-builder
</pre>

A local apt-proxy. We recomend apt-cacher-ng.
<pre>sudo aptitude install apt-cacher-ng
sudo gedit /etc/apt-cacher-ng/acng.conf
</pre>
change the port.. whatever its set to..(3142 defuault) to 9999
<pre>sudo /etc/init.d/apt-cacher-ng restart
</pre>

==Pre Build==
1. check out the source
<pre>svn checkout http://archivematica.googlecode.com/svn/trunk/ archivematica-read-only</pre>

2. Modify archivematica-read-only/trunk/archivematica.cfg to resemble your file system IE:
<pre> execscript = /home/demo/trunk/archivematica.sh </pre>
should be
<pre> execscript = /home/yourhomefolder/archivematica-read-only/trunk/archivematica.sh </pre>

3. Build archivematica for your hosts virtualization platform. All the following commands will build the same virtual machine.. each for a different platform
<pre>
sudo vmbuilder vmserver ubuntu -c archivematica.cfg
sudo vmbuilder xen ubuntu -c archivematica.cfg
sudo vmbuilder kvm ubuntu -c archivematica.cfg
</pre>

==Post Build==
1. boot your virtual machine. For KVM its under ubuntu-kvm, for other examples please see [[Virtual_appliance_instructions]].
<pre>kvm -m 528 -smp 1 -drive file=disk0.qcow2 </pre>

2. From inside the machine open a terminal and run the following (password is demo)
<pre>
sudo aptitude install openjdk-6-jre
incrontab /etc/incron.tab
sudo mysqladmin create qubit
</pre>

3. Open firefox and navigate to http://localhost, go through the qubit installer for the database settings all defaults will work.

4. Aside from some icon placement you now have a fully functional version of archivematica!

Build a virtual appliance 0.6

2010-02-19T23:40:20Z

Berwin22: /* Software Requirements */

[[Main Page]] > [[Development]] > Build a virtual appliance

Below are instructions for building your own Archivematica virtual appliance. This allows you to create intermediate or branch releases to test and use your own modifications.

==Requirements==
*Ubuntu 9.04
*vmbuilder requires KVM which requires a virt compatible processor however, you do not need virt support for vmbuilder
*At least 2GB of ram

==Software Requirements==
subversion (SVN)
<pre>sudo apt-get subversion
</pre>

vmbuilder
<pre>sudo apt-get ubuntu-vm-builder
</pre>

A local apt-proxy. We recomend apt-cacher-ng.
<pre>sudo aptitude install apt-cacher-ng
sudo gedit /etc/apt-cacher-ng/acng.conf
</pre>
change the port.. whatever its set to..(3142 defuault) to 9999
<pre>sudo /etc/init.d/apt-cacher-ng restart
</pre>

==Pre Build==
1. check out the source
<pre>svn checkout http://archivematica.googlecode.com/svn/trunk/ archivematica-read-only</pre>

2. Modify archivematica-read-only/trunk/archivematica.cfg to resemble your file system IE:
<pre> execscript = /home/demo/trunk/archivematica.sh </pre>
should be
<pre> execscript = /home/yourhomefolder/archivematica-read-only/trunk/archivematica.sh </pre>

3. Build archivematica for your hosts virtualization platform. All the following commands will build the same virtual machine.. each for a different platform
<pre>
sudo vmbuilder vmserver ubuntu -c archivematica.cfg
sudo vmbuilder xen ubuntu -c archivematica.cfg
sudo vmbuilder kvm ubuntu -c archivematica.cfg
</pre>

==Post Build==
1. boot your virtual machine. For KVM its under ubuntu-kvm, for other examples please see [[Virtual_appliance_instructions]].
<pre>kvm -m 528 -smp 1 -drive file=disk0.qcow2 </pre>

2. From inside the machine open a terminal and run the following (password is demo)
<pre>
sudo aptitude install openjdk-6-jre
incrontab /etc/incron.tab
sudo mysqladmin create qubit
</pre>

3. Open firefox and navigate to http://localhost, go through the qubit installer for the database settings all defaults will work.

4. Aside from some icon placement you now have a fully functional version of archivematica!

Build a virtual appliance 0.6

2010-02-19T23:38:55Z

Berwin22: /* Pre Build */

[[Main Page]] > [[Development]] > Build a virtual appliance

Below are instructions for building your own Archivematica virtual appliance. This allows you to create intermediate or branch releases to test and use your own modifications.

==Requirements==
*Ubuntu 9.04
*vmbuilder requires KVM which requires a virt compatible processor however, you do not need virt support for vmbuilder
*At least 2GB of ram

==Software Requirements==
subversion (SVN)
<pre>sudo apt-get subversion</pre>

vmbuilder
<pre>sudo apt-get ubuntu-vm-builder</pre>

A local apt-proxy. We recomend apt-cacher-ng.
<pre>sudo aptitude install apt-cacher-ng<b>
sudo gedit /etc/apt-cacher-ng/acng.conf
<pre>
change the port.. whatever its set to..(3142 defuault) to 9999
<pre>sudo /etc/init.d/apt-cacher-ng restart</pre>

==Pre Build==
1. check out the source
<pre>svn checkout http://archivematica.googlecode.com/svn/trunk/ archivematica-read-only</pre>

2. Modify archivematica-read-only/trunk/archivematica.cfg to resemble your file system IE:
<pre> execscript = /home/demo/trunk/archivematica.sh </pre>
should be
<pre> execscript = /home/yourhomefolder/archivematica-read-only/trunk/archivematica.sh </pre>

3. Build archivematica for your hosts virtualization platform. All the following commands will build the same virtual machine.. each for a different platform
<pre>
sudo vmbuilder vmserver ubuntu -c archivematica.cfg
sudo vmbuilder xen ubuntu -c archivematica.cfg
sudo vmbuilder kvm ubuntu -c archivematica.cfg
</pre>

==Post Build==
1. boot your virtual machine. For KVM its under ubuntu-kvm, for other examples please see [[Virtual_appliance_instructions]].
<pre>kvm -m 528 -smp 1 -drive file=disk0.qcow2 </pre>

2. From inside the machine open a terminal and run the following (password is demo)
<pre>
sudo aptitude install openjdk-6-jre
incrontab /etc/incron.tab
sudo mysqladmin create qubit
</pre>

3. Open firefox and navigate to http://localhost, go through the qubit installer for the database settings all defaults will work.

4. Aside from some icon placement you now have a fully functional version of archivematica!

Build a virtual appliance 0.6

2010-02-19T00:31:29Z

Berwin22: /* Pre Build */

[[Main Page]] > [[Development]] > Build a virtual appliance

Below are instructions for building your own Archivematica virtual appliance. This allows you to create intermediate or branch releases to test and use your own modifications.

==Requirements==
*Ubuntu 9.04
*vmbuilder requires KVM which requires a virt compatible processor however, you do not need virt support for vmbuilder
*At least 2GB of ram

==Pre Build==
1. check out the source
[To obtain subversion (SVN): sudo apt-get subversion]
<pre>svn checkout http://archivematica.googlecode.com/svn/trunk/ archivematica-read-only</pre>

2. Modify archivematica-read-only/trunk/archivematica.cfg to resemble your file system IE:
<pre> execscript = /home/demo/trunk/archivematica.sh </pre>
should be
<pre> execscript = /home/yourhomefolder/archivematica-read-only/trunk/archivematica.sh </pre>

3. Build archivematica for your hosts virtualization platform. All the following commands will build the same virtual machine.. each for a different platform
[To obtain vmbuilder: sudo apt-get ubuntu-vm-builder]
<pre>
sudo vmbuilder vmserver ubuntu -c archivematica.cfg
sudo vmbuilder xen ubuntu -c archivematica.cfg
sudo vmbuilder kvm ubuntu -c archivematica.cfg
</pre>

==Post Build==
1. boot your virtual machine. For KVM its under ubuntu-kvm, for other examples please see [[Virtual_appliance_instructions]].
<pre>kvm -m 528 -smp 1 -drive file=disk0.qcow2 </pre>

2. From inside the machine open a terminal and run the following (password is demo)
<pre>
sudo aptitude install openjdk-6-jre
incrontab /etc/incron.tab
sudo mysqladmin create qubit
</pre>

3. Open firefox and navigate to http://localhost, go through the qubit installer for the database settings all defaults will work.

4. Aside from some icon placement you now have a fully functional version of archivematica!