Support for S3 storage and CDN for project files

[martastain]

Overview

Project files (such as reviewables and comment attachments) can now be stored in S3-compatible object storage. Storage configurations are flexible and can be overridden on a per-project basis. On cloud instances, Ayon can also be configured to use the Ynput Cloud CDN for file delivery.

While the current implementation allows for site-wide S3 integration via environment variables, future updates will extend functionality to allow per-project overrides.

Environment Configuration

You can set up S3 storage using the following environment variables:

environment:
  - "AYON_DEFAULT_PROJECT_STORAGE_TYPE=s3"
  - "AYON_DEFAULT_PROJECT_STORAGE_ROOT=media/{instance_id}/server/projects"
  - "AYON_DEFAULT_PROJECT_STORAGE_BUCKET_NAME=ayon-media"

  - "AWS_ACCESS_KEY_ID=myawsaccesskeyid"
  - "AWS_SECRET_ACCESS_KEY=myawssecretassetkey"
  - "S3_ENDPOINT_URL=https://s3.mystudio.example.com"
  - "S3_REGION_NAME=home-1"

In this configuration, the specified S3 bucket will be used instead of the default local storage at /storage/server/projects.

The AYON_DEFAULT_PROJECT_STORAGE_ROOT replaces the previous project_storage_dir directive and is applicable to both local and s3 storage types. The directory structure beneath the root remains identical, making it easy to migrate existing files to S3.

Additionally, the {instance_id} placeholder is automatically replaced with the current instance ID, supporting scenarios involving multiple Ayon instances sharing a single bucket. If the S3_ environment variables are not provided, the system will attempt to resolve the appropriate S3 settings based on the AWS access key provided.

CDN Support

If you're using a CDN, you can specify an HTTP endpoint for file delivery via the AYON_DEFAULT_PROJECT_STORAGE_CDN_RESOLVER environment variable.

This endpoint is responsible for resolving the current project and file ID into a valid file URL.

If no CDN resolver is specified, Ayon will fallback to generating a signed URL from the S3 storage and redirect users to that link when a file is requested.

Compatibility

This feature has been tested with:

• AWS S3 + CloudFront
• Self-hosted Min.io + Signed URLs