Media Source Type - S3

Last updated Oct 20th, 2026 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$194 per month—let's make that $500!

Learn more

The Amazon S3 Media Source Type¶

This Media Source type connects the manager to an Amazon S3 bucket, or to an S3-compatible store through the endpoint property.

MODX 3 uses League Flysystem for this type, with the AWS SDK v3.

Available Properties¶

Name	Description
`url`	Required. The address the objects of the bucket are served from, for example `https://myaccount.s3.amazonaws.com/`. Default: `http://mysite.s3.amazonaws.com/`
`endpoint`	Optional. The endpoint of an S3-compatible store, for example `https://s3.<region>.example.com`. Leave empty for Amazon S3.
`region`	The region of the bucket, for example `us-west-1`. Default: `us-east-2`
`bucket`	Required. The name of the bucket.
`prefix`	Optional. The path prefix inside the bucket.
`key`	Required. The access key ID of the bucket.
`secret_key`	Required. The secret access key of the bucket.
`no_check_bucket`	When on, MODX does not check that the bucket exists. Default: `false`
`imageExtensions`	Comma-separated list of extensions treated as images. Default: `jpg,jpeg,png,gif,svg,webp`
`visibility`	Visibility of new files: `public` or `private`. Default: `private`
`skipFiles`	Comma-separated list of names to hide. Default: `.svn,.git,_notes,nbproject,.idea,.DS_Store`
`skipExtensions`	Comma-separated list of extensions to hide. Default: empty

The Region Has to Match¶

The region has to be the region the bucket was made in. A wrong region is the most common reason the Media Browser lists no files.

An empty region does not fall back to the default us-east-2 is only the value the field starts with. Once you save the source with an empty field, the empty value stays, and the connection to the bucket fails. Enter the region of your bucket.

Previews and Visibility¶

The preview of an object is the address of the object itself. This type generates no thumbnails, so it has no thumbnailType and no thumbnailQuality property. The thumbnails of a page are generated by the File System type.

This type supports the visibility of files, not of folders. The Set Visibility item appears for files only, and the visibility property covers new files.

Media Source Type - S3

The Amazon S3 Media Source Type¶

Available Properties¶

The Region Has to Match¶

Previews and Visibility¶

See Also¶