Archivematica is not a single application, there are a dozens of different
components and tools required for a full working installation. As a result
there are many possible deployment configurations.

These instructions are designed to get you up and running as quickly as
possible, even if you are not familiar with the linux operating system or the
various tools and applications that are bundled into an Archivematica
installation.

Experience with the linux command line is helpful, and to support a running
production system, it should be considered a requirement.

Don’t be afraid to ask for help if you get stuck, or if you don’t understand
some part of the instructions. The Archivematica google group is a good place
to look for assistance.

For testing purposes, you may find it easier to install on a virtual machine using Vagrant. See the Quick Start Guide

Archivematica 1.6.1 requires Elasticsearch 1.x (tested with 1.7.6).
Support for Elasticsearch 2.x and/or 5.x is being developed and is planned for a
future release.

Archivematica 1.6.1 has been tested with MySQL 5.5, including the Percona and
MariaDB alternatives. Archivematica uses MySQL 5.7 on Ubuntu 16.04.

Some of the tools run by Archivematica require Java to be installed (primarily
Elasticsearch and fits). On Ubuntu 14.04, Open JDK 7 is used. On Ubuntu 16.04
Open JDK 8 is the default. It is possible to use Oracle Java 7 or 8 instead.

The remaining dependencies should be kept at the versions installed by
Archivematica.

For production processing the hardware requirements depend almost entirely on
the size and number of files being processed. These recommendations should be
considered the minimum for a viable production system:

Processor: 2 CPU cores

Memory: 4GB+

Disk space: 20GB plus three to four times the disk space required for the
collection being processed (e.g., 200GB to process a 50GB transfer)

These requirements may not be suitable for certain types of material, e.g. audio-visual.

Archivematica packages are hosted at packages.archivematica.org. This has been
introduced to allow one central place to store packages for multiple OS’s.
Packages for both Ubuntu 14.04 and 16.04 are available.

This is used to install python dependencies for both the storage service and
the dashboard. There is a _known issue: https://bugs.launchpad.net/ubuntu/+source/python-pip/+bug/1658844
with the version of pip installed on Ubuntu 14.04, which makes this step
necessary. This step is optional on Ubuntu 16.04, but is still a good idea, to
get the most recent version of pip.

sudowgethttps://bootstrap.pypa.io/get-pip.pysudopythonget-pip.py

Install the Archivematica packages

The order of installation is important - the mcp-server package must be
installed before the dashboard package. While it is possible to install the
mcp-client package on a separate machine, that configuration is not
documented in these instructions.

The mcp-server package will install MySQL and configure the database used by
Archivematica. Depending on the version of MySQL that gets installed the
prompts you will say can differ. In all cases, you will be prompted to create
a password for the ‘root’ user. Keep note of the password you create.
On Ubuntu 14.04, MySQL 5.5 is installed, and
the default ‘archivematica’ database user is automatically created with a
default password of ‘demo’. On Ubuntu 16.04, MySQL 5.7 is installed, and
you are prompted to add a password for the ‘archivematica’ user. You must
use ‘demo’ as the password during the install process. The password can be
changed after the installation is complete.

Each service have a configuration file in /etc/sysconfig/archivematica-packagename

Troubleshooting

If IPv6 is disabled, Nginx may refuse to start. If that is the case make sure that the listen directives used under /etc/nginx are not using IPv6 addresses like [::]:80.

CentOS will install firewalld which will be running default rules likely blocking ports 81 and 8001. If you are not able to access the dashboard and storage service, check if firewalld is running. If it is, you will likely need to modify the firewall rules to allow access to ports 81 and 8001 from your location.

Installing from source has been tested using ansible scripts. Ansible
installations have been tested for new installations but are not fully tested
for upgrades.

These instructions are designed to create a test environment on your local
machine. A virtual machine running Ubuntu 14.04 will be created.

It is assumed here that your host operating system is Ubuntu. This can be
modified for a different unix based operating system, such as Mac OS X or
another linux distribution such as Centos. These instructions will not
work if you are using Windows as the host OS. For Windows installations
you can create a virtual machine and follow the manual install instructions.

This will take a while.
It depends on your computer, but it could take up to an hour.
Your computer may be very slow while Archivematica is being provisioned -
be sure to save any work and be prepared to step away from your computer
while Archivematica is building.

Re-provisioning

If there’s an error, you can re-run the setup.

vagrantprovision

Once it’s done provisioning, you can log in to your virtual machine:

vagrantssh

You can also access your Archivematica instance through the web browser:

After successfully completing a new installation using one of the methods
above, follow these steps to complete the configuration of your new server.

Test the storage service

The storage service runs as a separate web application from the Archivematica
dashboard. Go to the following link in a web browser and log in as user test
with the password test: http://localhost:8000 (or use the IP address of the
machine you have been installing on).

New Storage Service User

Create a new administrative user in the Storage service. The storage service
has its own set of users. In the User menu in the Administrative tab of the
storage service, add at least one administrative user, and modify the
test user, to change the password at a minimum. After you have created
an administrative user, copy its API key to your clipboard.

Test the dashboard

You can login to the Archivematica dashboard and finish the installation in a
web browser: http://localhost (again, use the IP address of the machine you
have been installing on). When prompted, enter the URL of the Storage Service,
the name of the administrative user, and that user’s API key.

Archivematica 1.5.x is available for Ubuntu 14.04 and Centos 7.x. If you are
running a version of Archivematica older than 1.5.0, you will need to upgrade
your operating system from Ubuntu 12.04 to Ubuntu 14.04, and upgrade
Archiveamtica to 1.5.0 before following these instructions. This section of
the instructions is focused on upgrading to Archivematica 1.6.0, as this is a
slightly more complicated process. Upgrading from 1.6.0 to 1.6.1 is quite
easy and covered below.

While it is possible to upgrade a github based source install using ansible,
these instructions do not cover that scenario.

Backup first

Before starting any upgrade procedure on a production system, it is prudent to
back up your system. If you are using a virtual machine, take a snapshot of it
before making any changes. Alternatively, back up the file systems being used
by your system. Exact procedures for updating will depend on your local
installation. At a minimum you should make backups of:

If you do not have a password set for the root user in mysql, you can take out
the ‘-p’ portion of that command. If there is a problem during the upgrade
process, you can restore your mysql database from this backup and try the
upgrade again.

Optionally you can remove the lines references packages.archivematica.org/1.5.x from /etc/apt/sources.list.

Update Archivematica Storage Services

sudoapt-getupdatesudoapt-getinstallarchivematica-storage-service

Update Application Container

Archivematica Storage Service 0.10.0 uses gunicorn as wsgi server. This means that the old uwsgi server needs to be stopped and disabled after perfoming the upgrade.

sudoserviceuwsgistopsudoupdate-rc.duwsgidisable

Update Archivematica

During the update process you may be asked about updating configuration files.
Choose to accept the maintainers versions. You will also be asked about
updating the database, say ‘ok’ to each of those steps. If you have set a
password for the root mysql database user, enter it when prompted. It is
better to update the dashboard before updating the mcp components.

sudoapt-getupgrade

Disable Unused Services

Archivematica 1.6.0 uses nginx as http server, and gunicorn as wsgi server. This means that some services used in Archivematica 1.5.0 should be stopped and disabled before performing the upgrade.

Note, depending on how your Ubuntu system is set up, you may have trouble
restarting gearman with the command in the block above. If that is the case,
try this command instead:

sudorestartgearman-job-server

Remove unused services

sudoapt-getremove--purgepython-pipapache2uwsgi

Update Transfer Index

If you are interested in experimenting with the use of these new features,
with a backlog created in an earlier version of Archivematica, these
instructions show how to update your Transfer Backlog Index so it can be
used with the Appraisal Tab and the Backlog tab.

These are experimental instructions. Do not use them on a production system
unless you have a back you can restore from.

Install devtools

Archivematica devtools is a set of utilities that was built by developers While
working on Archivematica. Devtools includes helper scripts that make it easier
to perform certain maintenance tasks. One of those tools is used to rebuild
the Transfer index in Elasticsearch, which is used by the different backlog
tools such as the new Appraisal Tab. Currently this must be installed using
git. These instructions will be updated when a packaged version is available.
See the _devtools repo: https:github.com/artefactual/archivematica-devtools for
more details.

You need to know the path to the Transfer Backlog Location. The default
path is ‘/var/archivematica/sharedDirectory/www/AIPsStore/transferBacklog’.
You can confirm the path for your installation by:

logging into the Storage Service and clicking on the Locations tab.

type ‘backlog’ in the search searchbox

copy the value in the column labelled ‘path’ (there should be only one row)

Rebuild Transfer Index

Using the path you confirmed above, replace the text ‘/path/to/transfers’ with
the correct path for your system.

amrebuild-transfer-backlog/path/to/transfers

This may take a while if you have a large backlog. Once it completes, you
should be able to see your Transfer Backlog in the Appraisal tab and in the
Backlog tab.

Depending on your browser settings, you may need to clear your browser cache to
make the dashboard pages load properly. For example in Firefox or Chrome you
should be able to clear the cache with control-shift-R or command-shift-F5.

Depending on your browser settings, you may need to clear your browser cache to
make the dashboard pages load properly. For example in Firefox or Chrome you
should be able to clear the cache with control-shift-R or command-shift-F5.

Update Transfer Index

If you are interested in experimenting with the use of these new features,
with a backlog created in an earlier version of Archivematica, these
instructions show how to update your Transfer Backlog Index so it can be
used with the Appraisal Tab and the Backlog tab.

These are experimental instructions. Do not use them on a production system
unless you have a back you can restore from.

Install devtools

Archivematica devtools is a set of utilities that was built by developers While
working on Archivematica. Devtools includes helper scripts that make it easier
to perform certain maintenance tasks. One of those tools is used to rebuild
the Transfer index in Elasticsearch, which is used by the different backlog
tools such as the new Appraisal Tab. Currently this must be installed using
git. These instructions will be updated when a packaged version is available.
See the _devtools repo: https:github.com/artefactual/archivematica-devtools for
more details.

sudoyuminstall-yarchivematica-devtools

Confirm Location of Transfer Backlog

You need to know the path to the Transfer Backlog Location. The default
path is ‘/var/archivematica/sharedDirectory/www/AIPsStore/transferBacklog’.
You can confirm the path for your installation by:

logging into the Storage Service and clicking on the Locations tab.

type ‘backlog’ in the search searchbox

copy the value in the column labelled ‘path’ (there should be only one row)

Rebuild Transfer Index

Using the path you confirmed above, replace the text ‘/path/to/transfers’ with
the correct path for your system.

amrebuild-transfer-backlog/path/to/transfers

This may take a while if you have a large backlog. Once it completes, you
should be able to see your Transfer Backlog in the Appraisal tab and in the
Backlog tab.

Archivematica 1.6.1 is available for Ubuntu 14.04, Ubuntu 16.04 and Centos 7.x.
If you are running a version of Archivematica older than 1.6.0, you will need to
upgrade Archiveamtica to 1.6.0 before following these instructions. See the
section above for details.

While it is possible to upgrade a github based source install using ansible,
these instructions do not cover that scenario.

Backup first

Before starting any upgrade procedure on a production system, it is prudent to
back up your system. If you are using a virtual machine, take a snapshot of it
before making any changes. Alternatively, back up the file systems being used
by your system. Exact procedures for updating will depend on your local
installation. See the ‘Update from 1.5.x to 1.6.0’ section above for an example.

Depending on your browser settings, you may need to clear your browser cache to
make the dashboard pages load properly. For example in Firefox or Chrome you
should be able to clear the cache with control-shift-R or command-shift-F5.

The recommended way to install Archivematica for development is with Ansible and
Vagrant. For instructions on how to install Archivematica from a virtual machine,
see the Ansible & Vagrant Installation instructions on the Archivematica
wiki. See also instructions for installation on a virtual machine using Vagrant in
the Quick Start Guide

Archivematica 1.6 has been tested with and is recommended for use with AtoM
versions 2.2. AtoM version 2.2 or higher is required for use with the
hierarchical DIP functionality; see Arrange a SIP from backlog.

Installation instructions for Atom 2 are available on the
accesstomemory.org documentation. When following those
instructions, it is best to download Atom from the git repository (rather than
use one of the supplied tarballs). When checking out Atom, use the head of
either the stable/2.1.x, stable/2.2.x or qa/2.3.x branch (integration with qa branch is experimental).

Once you have a working AtoM installation, you can configure dip upload
between Archivematica and Atom. The basic steps are:

Update atom dip upload configuration in the Archivematica dashboard

Confirm atom-worker is configured on the Atom server (copy the atom-
worker.conf file from atom source to /etc/init/)