cfs-aliyun
cfs-aliyun copied to clipboard
Aliyun Storage Adaptor for Meteor CollectionFS
iyyang:cfs-aliyun
Meteor Package: Aliyun storage adaptor for CollectionFS.
中文说明
Installation
$ meteor add iyyang:cfs-aliyun
Aliyun OSS Setup
- Create Access Key and enable OSS Service on Aliyun.
- In access key management console, copy the generated key pairs (Access Key ID and Access Key Secret) and paste into your configuration file.
- Create OSS Bucket, make sure you have rememberd bucket name and region, or paste into configuration file.
Usage
After performimg Installation and Aliyun OSS Setup, we may create
CollectionFS
storage via the following:
var imageStore = new FS.Store.OSS('images', {
region: 'oss-my-region', //optional, default is 'oss-cn-hangzhou'
aliyunInternal: false, //optional, set to true if access from Aliyun ECS
bucket: 'Bucket Name', //required
accessKeyId: 'Access Key ID', //required
secretAccessKey: 'Access Key Secret', //required
ACL: 'private', //optional, access limit of new files, default is 'private'
folder: 'folder/in/bucket', //optional, which folder (key prefix) in the bucket to use
// The rest are generic store options supported by all storage adapters
transformWrite: myTransformWriteFunction, //optional
transformRead: myTransformReadFunction, //optional
maxTries: 1 //optional, default 5
});
Images = new FS.Collection('images', {
stores: [imageStore]
});
Supported options
- Supported
region
s:'oss-cn-hangzhou'
,'oss-cn-shanghai'
,'oss-cn-beijing'
,'oss-cn-qingdao'
,'oss-cn-shenzhen'
,'oss-cn-hongkong'
,'oss-us-east-1'
,'oss-us-west-1'
,'oss-ap-southeast-1'
- Supported
ACL
s:'private'
,'public-read'
,'public-read-write'
Secure your Credential
We must put whatever storage credential to server
directory otherwise it
is accessble by clients. Note that Meteor.isServer
is NOT secure.
We would need to define store in two files, located in client
and server
directories respectively. And we should not put any options in client
file.
Example by cfs:s3:
Client (client/collections_client/avatars.js)
var avatarStoreLarge = new FS.Store.OSS('avatarsLarge');
var avatarStoreSmall = new FS.Store.OSS('avatarsSmall');
Avatars = new FS.Collection('avatars', {
stores: [avatarStoreSmall, avatarStoreLarge],
filter: {
allow: {
contentTypes: ['image/*']
}
}
})
Server (server/collections_server/avatars.js)
var avatarStoreLarge = new FS.Store.OSS('avatarsLarge', {
region: 'oss-my-region',
aliyunInternal: false,
bucket: 'avatars.large',
accessKeyId: 'ACCESS-KEY-ID-HERE',
secretAccessKey: 'ACCESS-KEY-SECRET-HERE',
transformWrite: function(fileObj, readStream, writeStream) {
gm(readStream, fileObj.name()).resize('250', '250').stream().pipe(writeStream)
}
})
var avatarStoreSmall = new FS.Store.OSS('avatarsSmall', {
region: 'oss-my-region',
aliyunInternal: false,
bucket: 'avatars.small',
accessKeyId: 'ACCESS-KEY-ID-HERE',
secretAccessKey: 'ACCESS-KEY-SECRET-HERE',
beforeWrite: function(fileObj) {
fileObj.size(20, {store: 'avatarStoreSmall', save: false});
},
transformWrite: function(fileObj, readStream, writeStream) {
gm(readStream, fileObj.name()).resize('20', '20').stream().pipe(writeStream)
}
})
Avatars = new FS.Collection('avatars', {
stores: [avatarStoreSmall, avatarStoreLarge],
filter: {
allow: {
contentTypes: ['image/*']
}
}
})
API
Contributors
This package is inspired by cfs:s3 package, where we have introduced Aliyun SDK and created our own version for OSS. We have slightly optimized stream handling.
This packages is contributed by: @yyang