...
Property | Description |
---|---|
accessKeyId REQ | |
awsSecretKey REQ | |
bucket REQ | |
region REQ | |
domain OPT | Defaults to "s3-#region#.amazonaws.com". Use this to override the domain used in URLs. |
security OPT | Defaults to "public". If you change it to "private", files will only be accessible when FarCry provides the link, and only for a limited time. |
pathPrefix OPT | Use to specify a sub-directory to store files in. |
urlExpiry OPT | This option is required if security="private", and specifies the number of seconds that a link should be valid for. |
admins OPT | An array of S3 canonical user ids and email addresses that should be given full rights on every uploaded file. While this isn't required, we strongly recommend that you include your own account email address. |
localCacheSize OPT | Number of recent files to keep on the local filesystem for fast access. Locations that have a lot of read/write access (like images) should have >5, more if many users use the system at once. Defaults to 0. |
maxAge OPT | The cache header that will be included in the response header when a file is requested. This affects how long browsers will cache these assets. |
sMaxAge OPT | The cache header that will be included in the response header when a file is requested. This affects how long proxies (like CloudFront) will cache these assets. |
Here is an example where I have overridden the location of FarCry images. Notice that first I create a new, non-standard location that has the default details. This is useful if you want to use the built in migration tool to move local files to a CDN.
...