Skip to main content

S3 Integration

RSpace can connect to external object storage that supports the S3 protocol (Amazon S3 and S3-compatible providers). Once your system administrator has configured an S3 file system, you can browse, l…

RSpace can connect to external object storage that supports the S3 protocol (Amazon S3 and S3-compatible providers). Once your system administrator has configured an S3 file system, you can browse, link and download S3 files from the Gallery (since RSpace 2.22/1.122), and move, copy or transfer files into S3 (since RSpace 2.23/1.123). S3 authentication is handled by the RSpace server, so you never enter S3 credentials yourself.

Before you start

Your system administrator must enable the S3 file system (see Sysadmin S3 Configuration guide) and add your username to its read and/or write allowlist. If nothing is configured, the S3 options below will not appear.

Add an S3 Filestore

A Filestore is your entry point into a configured S3 file system, rooted at a folder you choose.

  1. In the Gallery, start with 'Create' button and choose 'Add a Filestore'.
  2. Select a File system, then choose 'Choose Filesystem'. File systems you cannot read are disabled and marked "(no read access; contact your sysadmin)".
  3. Select the folder that you want to be a starting point for your Filestore (top-level folder), then select 'Choose Folder'.
  4. Name the Filestore, then choose 'Add Filestore'.
add filestore dialog

Open your filestore from the Filestores section of the Gallery to browse the bucket.

  • Link S3 resource (file or folder) inside a document: in the document editor choose Insert → From RSpace Gallery, open your S3 Filestore, select the file, and choose Add. The file stays in S3; RSpace stores only a reference. S3 links display with a distinct S3 icon in the document.
  • Download a file: when in Gallery view, select the file and choose Download from the Actions menu. You can also download the file after clicking on the link inserted in a document
filestore link details dialog
  1. In the Gallery, select one or more items, open the Actions menu, and choose 'Move to S3'.
  2. Pick the Destination S3 filestore. Filestores you cannot write to are disabled and marked "No write access".
  3. To keep the original in RSpace, tick Retain a copy in RSpace (the button then reads Copy); leave it unticked to move (button reads Move).

Same-name files at the destination are reported as already existing and are not overwritten. If no S3 filestore is configured, or you have no write access to any, the dialog tells you so and to contact your administrator.

'move to s3' dialog

Transfer between S3 filestores

When you select a file that is already inside an S3 Filestore and choose 'Move to S3', the dialog opens in transfer mode (titled 'Transfer to S3'): the source filestore is excluded from the destination list. There is a checkbox allowing to retain a copy on source bucket (i.e. doing a 'copy' rather than 'move'). The transfer runs server-side on S3, so it is fast. Single files larger than 5 GB cannot be transferred this way and will fail with a clear error.

Access and permissions

Your administrator controls access per file system with two allowlists: a read list (browse, link, download) and a read + write list (move, copy, transfer). Write access always includes read access. If you need access you do not have, contact your system administrator.

How did we do?

DMPonline Integration

Working with DMPs

Contact