Skip to content
  • Documentation >
  • Infrastructure and maintenance >
  • Clustering >
  • Clustering with AWS S3

Clustering with Amazon AWS S3

When setting up clustering, you can use Amazon AWS S3 as a binary handler, meaning AWS S3 will be used to store binary files.

Tip

Before you start, you should be familiar with the clustering documentation.

Set up AWS S3 account

  1. Go to https://aws.amazon.com/ and create an account. An existing Amazon account can be used.
  2. Choose a region. The example below uses EU (Ireland): eu-west-1
  3. Create a bucket in your chosen region and make note of the bucket name: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html.
  4. Go to the IAM Management Console and create a user. See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html.
  5. Then create a group and assign the user to the group.
  6. Assign policies to the group. The AmazonS3FullAccess policy gives read/write access to your bucket.
  7. Still in the IAM console, view the user you created. Click the "Security credentials" tab.
  8. Click "Create access key" and make note of the "Access key ID" and the "Secret access key". The secret key cannot be retrieved again after the key has been created, so don't lose it. (However, you can create new keys if needed.)

Note

Make sure that your bucket is configured as Public to avoid facing 403 errors, as the current S3 handler is meant to store files publicly so they can be served directly from S3.

Set up Ibexa DXP for AWS S3

In your Ibexa DXP root directory, run php composer require league/flysystem-aws-s3-v3:^2.0. Then, register the AWS S3 client as a service:

1
2
3
4
5
6
7
8
9
services:
    Aws\S3\S3Client:
        arguments:
            -
                version: latest
                region: eu-west-1 # The region string of your chosen region
                credentials:
                    key: ABCDEF... # Your AWS key ID
                    secret: abc123... # Your AWS secret key

Set up the Flysystem v2 adapter that uses the S3 client under the oneup_flysystem.adapters configuration key:

1
2
3
4
5
6
7
oneup_flysystem:
    adapters:
        aws_s3_adapter:
            awss3v3:
                client: Aws\S3\S3Client
                bucket: my-bucket # Your bucket name
                prefix: 'my-prefix' # Your custom prefix, for example: 'my_site'

In the same place, set up the binary data handler for the S3 adapter:

1
2
3
4
5
ibexa_io:
    binarydata_handlers:
        aws_s3:
            flysystem:
                adapter: aws_s3_adapter

Note

aws_s3 is an arbitrary handler identifier that is used in the config block below. You can configure multiple handlers.

For example, you could configure one called gcloud_storage for a Google Cloud Storage adapter.

Under the ibexa.system.<scope>.io configuration key, enable the binary data handler:

1
2
3
4
5
6
7
ibexa:
    system:
        default:
            io:
                binarydata_handler: aws_s3
                # Also remember to use DFS for metadata_handler to avoid expensive lookups to S3 (see Clustering guide)
                # metadata_handler: dfs

Clear all caches and reload, and that's it.

Migrate your existing binary data to S3

You can migrate existing binary data to S3 using the php bin/console ibexa:io:migrate-files command which was added in EZP-25946.