Skip to content

Commit

Permalink
Update README.md with S3 object ownership settings
Browse files Browse the repository at this point in the history
  • Loading branch information
Vithusha Kethiri committed Feb 2, 2025
1 parent 0b04ebf commit a99db56
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,35 @@ Note: Not all object stores listed below are tested/in-use directly by Catalyst
]
}
```


#### New Setting: Configurable S3 Object Ownership

S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to control ownership of objects uploaded to your bucket and to disable or enable [access control lists (ACLs).](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html) By default, Object Ownership is set to the Bucket owner enforced setting and all ACLs are disabled. When ACLs are disabled, the bucket owner owns all the objects in the bucket and manages access to data exclusively using access management policies.

A new setting has been introduced to provide more control over S3 Object Ownership when storing files in an S3 bucket. Previously, the default ACL was set to private, which could lead to access control limitations in certain configurations. This update allows users to select from various ACL options to better manage permissions.


For more details on S3 Object Ownership and permissions, refer to:

- [Amazon S3 Object Ownership](https://aws.amazon.com/about-aws/whats-new/2021/11/amazon-s3-object-ownership-simplify-access-management-data-s3/)
- [AWS PutObject API Documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
- [AWS Object Ownership Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)


#### How to Configure S3 Object Ownership in Moodle?

- Navigate to Site Administration > Plugins > Admin Tools > Object Storage File System.

- Under Amazon S3 Settings, locate the new setting: Bucket ACL.

#### Choose the appropriate ACL option:

- private (default, recommended for secure storage)

- bucket-owner-full-control (if the bucket owner needs full access to the object)


### Minio S3

Setup for Minio.io bucket can be found on there website [here](https://min.io)
Expand Down Expand Up @@ -301,6 +330,7 @@ S3 specific settings
- **Key**: AWS credential key.
- **Secret**: AWS credential secret.
- **Bucket**: S3 bucket name to store files in.
- **Bucket ACL**: ACL permission to S3 Bucket.
- **AWS region**: AWS API endpoint region to use.
- **Base URL**: useful for s3-compatible providers *eg* set to `https://storage.googleapis.com` for gcs
- **Key Prefix**: useful for adding a prefix for all data stored in bucket. Can be used to reuse the same CloudFront distribution for both Moodle itself and the pre-signed URLs files.
Expand Down

0 comments on commit a99db56

Please sign in to comment.