Page History

...

1. #AIP Format Options: Does you institution want to backup using the default DSpace AIP format (METS packaging)? Or would you rather utilize the new BagIt AIP Format?
2. #Storage Options: Does you institution plan to use the Replication Suite to backup to a local/mounted drive? Or would you like to connect it to a DuraCloud account?
3. #Additional Options: Do you plan to use Checkm manifests for quick checksum auditing?

AIP Format Options

...

Where your AIPs will be stored is the next decision to make. There are three options currently available:

1. Local Storage: Replicate/Backup content to another location (folder) on your local filesystem.
2. Mountable Storage: Replicate/Backup content to a mounted external filesystem (e.g. NFS-mounted drive).
3. DuraCloud Storage: Replicate/Backup content to an existing DuraCloud account.

Configuring Local Storage

Before configuring a local storage option, please ensure you have enough space available on your local hard drive (or mounted drive/SAN if your local folder is actually remote storage). You can use the "Estimate Storage Space" (estaipsize) task to estimate the amount of new storage space you will need.

To configure local storage, please change the following settings in your {{\[dspace\]/config/modules/replicate.cfg}} configuration file:

1. Enable Local Storage Plugin: Ensure the Replication suite is setup to use the 'LocalObjectStore' plugin

   Code Block
   # Replica store implementation class (specify one) plugin.single.org.dspace.ctask.replicate.ObjectStore = \ org.dspace.ctask.replicate.store.LocalObjectStore

2. Wiki Markup
   *Configure Local Storage Folder*: Configure the location where you want all AIPs to be stored on your local filestystem. This defaults to the {{\[dspace\]/repstore}} folder. _However, we recommend changing this to at least a separate hard drive from your existing DSpace installation directory!_ This ensures that all your content will not be lost in the case of a hard drive failure.

   Code Block
   # Location of local (e.g. local, mountable, sync) object store # ignored for non-local stores (e.g. DuraCloud) store.dir = ${dspace.dir}/repstore

3. Optionally Configure Subfolder Settings: Optionally, you can configure the sub-folder names (under store.dir) which will be used to store AIPs, checkm manifests (if enabled), etc.

   Code Block

   # The storage group / folder where AIPs are stored/retrieved when AIP based tasks # (e.g. "Transmit AIP", "Recover from AIP") are executed. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.aip.name = aips # The storage group / folder where Manifests are stored/retrieved when Manifest based tasks # (e.g. "Transmit Manifest", "Fetch Manifest") are executed. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.manifest.name = manifests # The storage group / folder where AIPs are temporarily stored/retrieved when deletion tasks #(e.g. "Remove AIP") are executed. This 'delete' group provides a location where deleted AIPs # can be temporarily kept in case the deletion needs to be reverted and the object restored. # WARNING: THIS MUST NOT BE SET TO THE SAME VALUE AS 'group.aip.name'. If it is set to the # same value, then your AIP backup processes will be UNSTABLE and restoration may be difficult or impossible. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.delete.name = deletes

Configuring Mountable Storage

Before configuring a mounted storage option, please ensure you have enough space available on your external, mounted drive/SAN. You can use the "Estimate Storage Space" (estaipsize) task to estimate the amount of new storage space you will need.

To configure local storage, please change the following settings in your {{\[dspace\]/config/modules/replicate.cfg}} configuration file:

1. Enable Local Storage Plugin: Ensure the Replication suite is setup to use the 'MountableObjectStore' plugin

   Code Block
   # Replica store implementation class (specify one) plugin.single.org.dspace.ctask.replicate.ObjectStore = \ org.dspace.ctask.replicate.store.MountableObjectStore

2. Wiki Markup
   *Configure Mounted Folder*: Configure the location where you want all AIPs to be stored. The folder should already be mounted on your local filesystem. This defaults to the {{\[dspace\]/repstore}} folder.

   Code Block
   # Location of local (e.g. local, mountable, sync) object store # ignored for non-local stores (e.g. DuraCloud) store.dir = ${dspace.dir}/repstore

3. Optionally Configure Subfolder Settings: Optionally, you can configure the sub-folder names (under store.dir) which will be used to store AIPs, checkm manifests (if enabled), etc.

   Code Block

   # The storage group / folder where AIPs are stored/retrieved when AIP based tasks # (e.g. "Transmit AIP", "Recover from AIP") are executed. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.aip.name = aips # The storage group / folder where Manifests are stored/retrieved when Manifest based tasks # (e.g. "Transmit Manifest", "Fetch Manifest") are executed. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.manifest.name = manifests # The storage group / folder where AIPs are temporarily stored/retrieved when deletion tasks #(e.g. "Remove AIP") are executed. This 'delete' group provides a location where deleted AIPs # can be temporarily kept in case the deletion needs to be reverted and the object restored. # WARNING: THIS MUST NOT BE SET TO THE SAME VALUE AS 'group.aip.name'. If it is set to the # same value, then your AIP backup processes will be UNSTABLE and restoration may be difficult or impossible. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.delete.name = deletes

Configuring DuraCloud Storage

*DuraCloud Account / Service Settings:* 
In order to configure DuraCloud Storage, you first must have an existing DuraCloud Account.  This account's settings should be configured in your {{\[dspace\]/config/modules/duracloud.cfg}} file as follows:

1. DuraCloud HostName: This is the location of your DuraCloud instance (the URL you tend to access for your account). Just provide the hostname.

   Code Block
   # DuraCloud service location (just the hostname) host = demo.duracloud.org

2. DuraCloud Service Port: This is the port that DuraCloud is running on. It is almost always "443" unless you have installed DuraCloud yourself and configured it differently.

   Code Block
   # DuraCloud service port (usually 443 for https) port = 443

3. DuraCloud's "DuraStore" path: This the path to DuraCloud's "DuraStore" service. It is almost always "durastore" unless you have installed DuraCloud yourself and configured it differently.

   Code Block
   context = durastore

4. DuraCloud Username & Password: Finally, fill out your account username & password in these settings. Please note, as this file now contains your DuraCloud account information, we recommend securing it (if possible). Just ensure it is still readable by the system user that DSpace runs as.

   Code Block
   # DuraCloud user name username = rep-agent # DuraCloud password password = passw0rd

*Replication Suite Configuration:*
Now, to configure DuraCloud as your storage location please change the following settings in your {{\[dspace\]/config/modules/replicate.cfg}} configuration file:

1. Enable DuraCloud Storage Plugin: Ensure the Replication suite is setup to use the 'DuraCloudObjectStore' plugin

   Code Block
   # Replica store implementation class (specify one) plugin.single.org.dspace.ctask.replicate.ObjectStore = \ org.dspace.ctask.replicate.store.DuraCloudObjectStore

2. Configure DuraCloud Spaces to use: Your DuraCloud account allows you to separate content into various "Spaces". You'll need to create a new DuraCloud Space that your AIPs will be stored within, and configure that as your group.aip.name (by default it's set to a DuraCloud Space with ID of "aips"). You should also create a new DuraCloud Space that your AIPs will be moved to if they are ever removed, and configure that as your group.delete.name. Optionally, if you are using Checkm manifests, you can also create and configure a group.manifest.name DuraCloud Space

   Code Block

   # The storage group / folder where AIPs are stored/retrieved when AIP based tasks # (e.g. "Transmit AIP", "Recover from AIP") are executed. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.aip.name = aips # The storage group / folder where Manifests are stored/retrieved when Manifest based tasks # (e.g. "Transmit Manifest", "Fetch Manifest") are executed. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.manifest.name = manifests # The storage group / folder where AIPs are temporarily stored/retrieved when deletion tasks #(e.g. "Remove AIP") are executed. This 'delete' group provides a location where deleted AIPs # can be temporarily kept in case the deletion needs to be reverted and the object restored. # WARNING: THIS MUST NOT BE SET TO THE SAME VALUE AS 'group.aip.name'. If it is set to the # same value, then your AIP backup processes will be UNSTABLE and restoration may be difficult or impossible. # For Local object stores, this group name corresponds to a subfolder in the 'store.dir' # For DuraCloud object stores, this group name corresponds to a DuraCloud Space ID (Space must already exist) group.delete.name = deletes

Additional Options

Configuring usage of Checkm manifest validation

...