Getting started

From Archivematica
Revision as of 19:00, 11 August 2015 by Hbecker (talk | contribs) (→‎Installation: Ansible and local)
Jump to navigation Jump to search

Main Page > Development > Getting Started

Vital Stats


Archivematica consists of several projects working together.

  • Archivematica: Main repository containing the user-facing dashboard, task manager MCPServer and clients scripts for the MCPClient
  • Storage Service: Responsible for moving files to Archivematica for processing, and from Archivematica into storage
  • Format Policy Registry: Submodule shared between Archivematica and the Format Policy Registry (FPR) server that displays and updates FPR rules and commands

There are also several smaller repositories that support Archivematica in various ways. In general, you will not need these to develop on Archivematica.


There are two main ways to run Archivematica in development.

  1. Use ansible and vagrant to install Archivematica in a VM
  2. Install Archivematica on your development machine

Ansible & Vagrant

To install and run Archivematica from source on a VM:

  1. Checkout deployment repo
    • git clone
  2. Temporary: switch to playbooks/archivematica branch
    • git checkout playbooks/archivematica
  3. Install VirtualBox, Vagrant, Ansible
    • sudo apt-get install virtualbox vagrant
    • Vagrant must be at least 1.5
      • vagrant --version
    • sudo pip install ansible
  4. Helpers
  5. Create machine
    • cd deploy-pub/playbooks/archivematica/
    • vagrant up
    • Will prompt for sudo to modify /etc/hosts adding
  6. Login now available (but nothing needs to be run on the VM)
    • ssh
  7. Get updates to roles
    • ansible-galaxy install -r requirements.yml [--force]
  8. Execute playbook
    • ansible-playbook -i hosts singlenode.yml
  9. Archivematica should be available at and the storage service at

You may want to add this to your .ssh/config

Host 192.168.168.* *
  StrictHostKeyChecking no
  User root
  LogLevel ERROR

Development Machine

See development environment setup instructions