Configuring the Amazon S3 plugin

Use the instructions on this page to configure CollectionSpace (version 4.3 or greater) to store binaries (images, PDF documents, text files, etc) in an Amazon S3 bucket.

Configure a NEW CollectionSpace Instance - Step-by-step guide

• Install CollectionSpace by following the instructions at "Installing CollectionSpace".

• If CollectionSpace is running, shut it down.

• In the Apache Tomcat directory, edit the file at: cspace/config/services/proto-repo-config.xml by replacing:

<binaryStore path="default"/>

with

<binaryManager class="org.nuxeo.ecm.core.storage.sql.S3BinaryManager"/>

•  In the Apache Tomcat directory, edit the file at: nuxeo-server/config/s3binarymanager.properties by adding your Amazon S3 bucket name and credentials.

nuxeo.s3storage.bucket=BucketName
nuxeo.s3storage.awsid=AWSAccessKeyId
nuxeo.s3storage.awssecret=AWSSecretKey

•  You may need to modify your Amazon S3 bucket settings at https://console.aws.amazon.com/s3.  Select the bucket you're using for CollectionSpace.  Review the "Permissions" settings for your bucket by clicking on the "Properties" button near the top right corner.  For example, you may need to add "Authenticated Users" to your Grantee list.

• Finally, restart CollectionSpace. 

Configure an existing CollectionSpace Instance - Step-by-step guide

1. Follow all the instructions for configuring a NEW CollectionSpace Instance (see above) except for the last step of restarting CollectionSpace.

2. Before restarting CollectionSpace, you'll need to migrate your existing binaries by coping them to your Amazon S3 bucket.

   1. The existing binaries will be inside the Apache Tomcat directory at nuxeo-server/data/TENANT_NAME.  For example, for the core/default tenant, the binaries would be here: nuxeo-server/data/default.  And for the Life Sciences tenant, they would be here: nuxeo-server/data/lifesci_domain
   2. Use a tool like Amazon's s3cmd to copy the entire contents of your existing binaries directory to your Amazon S3 bucket.
3. Finally, restart CollectionSpace.

Related articles