bfast-s3like
v2.1.0
Published
AWS S3-like adapter for parse-server
Downloads
4
Maintainers
Readme
Parse Server: S3-like storage adapter
Based on Minio's client.
If you want to:
- Use AWS S3: go to parse-server-s3-adapter
- Use S3-like storage, such as Minio, Ceph, GCS, etc: use this.
Install
$ npm install --save bfast-s3like
Usage
filesAdapter: {
module: 'bfast-s3like',
options: {
accessKey: 'accessKey',
bucket: 'my_bucket',
useSSL: true,
endPoint: 'https://...',
secretKey: 'secretKey'
}
}
| Option | Default | Description |
|:-------|:-------:|:------------|
| accessKey
| required ||
| bucket
| required | The bucket to store data into. This can be a function that takes the filename and returns a string. |
| direct
| false
| Whether files are served from the endPoint
(true
) or proxied by Parse (false
). This can be a function that takes the filename and returns a boolean. |
| endPoint
| required | The URL to the storage service. Should be a full URL, with protocol and port (if non-standard), e.g. https://play.minio.io:9000
or https://minio.example.com
. |
| port
| From endPoint
| Override the port number. By default is parsed from the endPoint
URL, with 80/443 as standard defaults based the value of secure
. |
| prefix
| ''
| A prefix to apply to all filenames. Can be set to e.g. 'foo/'
to put all files in a subdirectory. This can be a function that takes the filename and returns a string. |
| region
| 'us-east-1'
| May not actually matter for some services, refer to your documentation. This can be a function that takes the filename and returns a string. |
| secretKey
| required ||
| useSSL
| From endPoint
| Override whether the connection is secure or not. By default is parsed from the endPoint
URL (https
is secure, otherwise not). |