Skip to content

Connecting Cloud Storage: S3-Compatible APIs#

Kolena connects with any S3-compatible system to load files (e.g. images, videos, documents) directly into your browser for visualization. Supported systems include:

In this tutorial, we'll learn how to establish an integration between Kolena and a storage system implementing an S3-compatible API.

To get started, ensure you have administrator access within Kolena. Navigate to the "Integrations" tab on the Organization Settings page and click "Add Integration", then "MinIO".

Steps performed outside of Kolena are shown for a subset of possible S3-compatible systems. You may need to consult documentation for your provider to perform equivalent steps.

Step 1: Create a Service User for Kolena#

mc admin user add <deployment_alias> <kolena_user> <secret_access_key>

Step 2: Create an Access Policy#

Create a policy to allow read access for a bucket or set of buckets.

Save the following JSON policy to a file called /tmp/kolena-policy.json, replacing s3://share-with-kolena with the appropriate bucket(s):

    "Version": "2012-10-17",
    "Statement": [{
        "Sid": "S3ListBucket",
        "Effect": "Allow",
        "Action": [
        "Resource": [

Note: Bucket names

Please note that bucket names must follow S3 naming rules

Next, create the policy and attach the policy to the service user created in step 1:

mc admin policy create <deployment_alias> kolenaread /tmp/kolena-policy.json
mc admin policy attach <deployment_alias> kolenaread --user <kolena_user>

Step 3: Save Integration on Kolena#

Return to the Kolena platform Integrations tab.

By default, any locators beginning with s3:// will be loaded using this integration.

Note: scoping integrations

Optionally, each integration can be scoped to a specific bucket such that only locators of the pattern s3://<specific-bucket>/* will be loaded using the integration. This can be necessary if multiple integrations are required. Unchecking "Apply to all buckets by default?" and specifying a bucket will enable this behavior.

Fill in the fields for the integration and then click "Save".

Field Description
Access Key Id The username (<kolena_user>) of the user created in step 1
Secret Access Key The secret key (<secret_access_key>) of the user created in step 1
Endpoint The hostname or IP address of your S3-compatible service
Port The optional port to access your S3-compatible service
Region The region your buckets will be accessed from