How to Configure External File Stores in RecordM

RecordM allows you to store and manage files externally using supported cloud storage services.

Supported External File Stores

Currently, RecordM supports:

• Google Cloud Storage (GCS)
• Amazon S3 (including S3-compatible services)

Step 1: Prepare Your Storage

Google Cloud Storage (GCS)

1. Create a GCS bucket in your Google Cloud project.
2. Create a service account with Storage Object Admin role (or equivalent) permissions.
3. Generate a JSON key for the service account and download it.

Amazon S3 (and S3-compatible)

1. Create an S3 bucket in your AWS account (or S3-compatible service).
2. Create an IAM user with AmazonS3FullAccess (or equivalent) permissions.
3. Generate Access Key ID and Secret Access Key for the user.

Step 2: Configure RecordM

To configure an external file store, edit the file /etc/recordm/services/com.cultofbits.recordm.service.properties and provide the following information:

For GCS

extFileStore.gcs[0].label=<external file store label>
extFileStore.gcs[0].bucket=<Google Cloud Storage bucket>
extFileStore.gcs[0].credentials=<absolute path to the Google Cloud Storage credentials file>

For S3

extFileStore.s3[0].label=<external file store label>
extFileStore.s3[0].bucket=<s3 bucket>
extFileStore.s3[0].credentials=/<absolute path to the s3 credentials file>
extFileStore.s3[0].region=<aws-region>
extFileStore.s3[0].endpoint=https://... (optional)

S3 Credentials File Format:
The S3 credentials file must be a properties file and define the following properties:

aws_access_key=<your access key>
aws_secret_access=<your secret key>

WARNING

Requires RecordM restart

Step 3: Apply and Test

1. Save your configuration file.
2. Restart RecordM
3. Run cob-health to check the system status

If the RecordM service reports healthy, the external bucket is reachable and properly configured.

INFO

You can configure multiple external file stores by incrementing the index ([0], [1], etc.).

INFO

Only GCS and S3 (including S3-compatible services) are currently supported. Other storage providers are not supported at this time. If you need support for other external file stores, please contact our support team.