Automated installation using Ansible¶
Installing from source using Ansible is the preferred method for new installations on Ubuntu.
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 Rocky Linux.
The Ansible roles referenced here can be used in production deployments by creating your own Ansible playbook to run them. See the deploy-pub repo for more details.
On this page
Installation instructions¶
Note
These instructions assume that you have a Python package manager, such as pip, installed on your system. From pip, you should be able to install a released version of Ansible.
Important
If you would like to install Archivematica without Elasticsearch or with limited Elasticsearch functionality, you
must first change the role variable archivematica_src_search_enabled
to
one of the available values. For more information about Archivematica’s
Ansible role, please see the ansible-archivematica-src repo.
Install VirtualBox, Vagrant, and Ansible.
sudo apt-get install virtualbox vagrant sudo pip install ansible==2.9.10 jmespath jinja2==3.0.3
Vagrant must be at least version 1.9. Check your version with:
vagrant --version
If it is not up to date, you can download the newest version from the Vagrant website .
Checkout the deployment repo:
git clone https://github.com/artefactual/deploy-pub.git
Download the Ansible roles:
cd deploy-pub/playbooks/archivematica-jammy ansible-galaxy install -f -p roles/ -r requirements.yml
Create the virtual machine and provision it:
vagrant up
Warning
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.
If there are any errors, reprovisioning the VM often fixes the issue.
vagrant provision
Once it’s done provisioning, you can log in to your virtual machine:
vagrant ssh
You can also access your Archivematica instance through the web browser:
- Archivematica: http://192.168.168.198.
- Storage Service: http://192.168.168.198:8000.
The credentials can be found in the vars-singlenode-1.15.yml.
Deploy development branches¶
The previous section described how to deploy the latest stable Archivematica release.
Our Ansible role can also be used to deploy development branches, e.g. if you want to help us QA our product.
Using deploy-pub, where we host our reference playbooks, please follow these steps:
Download the roles defined in
requirements-qa.yml
:cd deploy-pub/playbooks/archivematica-jammy ansible-galaxy install -f -p roles/ -r requirements-qa.yml
Update
singlenode.yml
to loadvars-singlenode-qa.yml
. Inside thepre_tasks
section, update the taskinclude_vars
as follows:- include_vars: "vars-singlenode-qa.yml" tags: - "always"
Optionally, if you have a specific branch(es) that you want to deploy or other custom configuration needs, update
vars-singlenode-qa.yml
as needed. By default, we will deploy off branchesqa/1.x
(Archivematica) andqa/0.x
(Storage Service).Deploy the new configuration. If you’re using Vagrant, please run:
vagrant provision