S3 servers

Arkindex uses the Amazon S3 API to store and retrieve images, Machine Learning models, and more.

Compatibility

While Arkindex should be compatible with any server implementing the S3 API, each implementation may come with some quirks and subtle issues. Arkindex is currently known to be compatible with the following servers:

Backend configuration

With the exception of the S3 ingestion feature, all S3-related settings in Arkindex can be found in the s3 section of the configuration.

CORS settings

The Arkindex frontend makes direct requests to the PutObject endpoint when uploading a file. This requires enabling cross-origin resource sharing on the staging bucket used to store uploaded files.

The following CORS configuration should be defined on the bucket, replacing https://arkindex.example.org/ with the URL of your instance:

[
    {
        "AllowedHeaders": [
            "*"
        ],
        "AllowedMethods": [
            "PUT",
            "GET",
            "HEAD"
        ],
        "AllowedOrigins": [
            "https://arkindex.example.org/"
        ],
        "ExposeHeaders": []
    }
]