Configure Relution

Once an S3-compatible object storage backend is ready - whether self-hosted or cloud-based - Relution needs to be configured to use it.


Prerequisites

The following information is needed from the object storage provider:

SettingDescription
EndpointThe S3 API URL
Access KeyAuthentication key ID
Secret KeyAuthentication secret
Bucket NameThe storage bucket name

In the configuration examples below, we will use example values matching our SeaweedFS guide →. If a different backend or provider is used, adjust them accordingly.


Configuration

Choose one of the two options below. Both achieve the same result.

Option A: Using application.yml

Add the following to the application.yml:

relution:
  storage:
    resourceStorageType: S3
    s3:
      customEndpoint: http://seaweedfs:8333
      accessKey: %YOUR-ACCESS-KEY%
      secretKey: %YOUR-SECRET-KEY%
      bucketName: relution

Option B: Using Environment Variables

Add these environment variables to the relution service in the compose.yml:

services:
  relution:
    environment:
      RELUTION_STORAGE_RESOURCESTORAGETYPE="S3"
      RELUTION_STORAGE_S3_CUSTOMENDPOINT="http://seaweedfs:8333"
      RELUTION_STORAGE_S3_ACCESSKEY="%IHR-ACCESS-KEY%"
      RELUTION_STORAGE_S3_SECRETKEY="%IHR-SECRET-KEY%"
      RELUTION_STORAGE_S3_BUCKETNAME="relution"

Starting the Services

  1. Pull the latest images:

    docker compose pull
    
  2. Start or restart the containers:

    docker compose up -d
    
  3. Relution will automatically begin migrating content from the resource database table to the object storage bucket.


Monitoring Progress

Watch the migration progress in the logs:

docker logs -f relution

Files being created can also be verified by checking the object storage backend (e.g., via the SeaweedFS web UI or the cloud provider’s console).


Important Notes

Top