Closed
Description
The S3 file adapter is missing some parameters that have been added over time.
Suggestions for parameters to add to doc:
baseUrl
- Description: The base URL the file adapter uses to determine the file location for direct access.
- Note: Optional. Default:
null
. To be used whendirectAccess=true
. When set the file adapter returns a file URL in formatbaseUrl/bucketPrefix
+filename
. Example forbaseUrl='http://domain.com/folder'
andbucketPrefix='prefix_'
the returned file location ishttp://domain.com/folder/prefix_file.txt
.
baseUrlDirect
- Description: Is true if the file adapter should ignore the bucket prefix when determining the file location for direct access.
- Note: Optional. Default:
false
. To be used whendirectAccess=true
andbaseUrl
is set. When set totrue
, the file adapter returns a file URL in formatbaseUrl/filename
. Example forbaseUrl='http://domain.com/folder'
andbaseUrlDirect=true
the returned file location ishttp://domain.com/folder/file.txt
.
globalCacheControl
- Description: The
Cache-Control
http header to set in the file request. - Note: Optional. Default:
null
. Example:public, max-age=86400
for 24 hrs caching. More info here.
It seems worth to include the interplay of these parameters with the directAccess
.
Found some references here:
https://github.com/parse-community/parse-server-s3-adapter
#1857
parse-community/parse-server-s3-adapter#13
Are the above parameter details understandable and correct?
Metadata
Metadata
Assignees
Labels
No labels