- Getting Started
- Browser Support
- Languages Support
- Shortcuts
- Activation
- Examples
- Customize the Editor
- Use-cases
- Plugins
- APIs
- Development Frameworks
- Server Integrations
- Server SDKs
- Migration Guides
- Changelog
- Tutorials
Ruby File S3 Upload
How it works
- Create a bucket on Amazon S3 and set the CORS for it.
- Code computes the Amazon S3 signature on server side.
- The editor initializes with the
fileUploadToS3
option. - Uploaded files go directly to the S3 bucket without passing through the server.
Create a S3 Bucket
For information on creating a bucket and setting a region, refer to the Amazon documentation. If you have any issues creating it, please contact Amazon for getting it set up.
http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html
Set CORS on the S3 Bucket
Cross-origin resource sharing (CORS) tells Amazon from which domains to accept requests and what kind of requests. For a detailed explanation of how that works, refer to the Amazon CORS Documentation.
The following example shows the recomended configuration, remember to replace ALLOWED_URL
with the URL of the page where you are using editor:
<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
<AllowedOrigin>ALLOWED_URL</AllowedOrigin>
<AllowedMethod>GET</AllowedMethod>
<AllowedMethod>POST</AllowedMethod>
<AllowedMethod>PUT</AllowedMethod>
<MaxAgeSeconds>3000</MaxAgeSeconds>
<AllowedHeader>*</AllowedHeader>
</CORSRule>
</CORSConfiguration>
Compute Signature
To get the file uploaded to S3, it is necessary to compute a signature using the AWS access key ID
and AWS secret access key
and provide it together with the upload request. The editor .NET SDK comes with methods to compute the S3 signature using the V4 signing algorithm that works with buckets created on any of the S3 regions.
class UploadController < ActionController::Base
...
def index
# Configuration object.
options: {
# The name of your bucket.
bucket: 'bucket-name',
# S3 region. If you are using the default us-east-1, it this can be ignored.
region: 'eu-west-1',
# The folder where to upload the images.
keyStart: 'uploads',
# File access.
acl: 'public-read',
# AWS keys.
accessKey: 'YOUR_AWS_ACCESS_KEY',
secretKey: 'YOUR_AWS_SECRET_KEY'
}
# Compute the signature.
@aws_data = FroalaEditorSDK::S3.data_hash(options)
end
...
end
Initialize the javascript editor
To upload files to Amazon S3, set the fileUploadToS3
option on initialization. The editor Ruby SDK computes the hash required for this as the response of the FroalaEditorSDK::S3.data_hash
method.
<script>
new FroalaEditor({
fileUploadToS3: @aws_data.to_json.html_safe
})
</script>
Complete Example
<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
<AllowedOrigin>ALLOWED_URL</AllowedOrigin>
<AllowedMethod>GET</AllowedMethod>
<AllowedMethod>POST</AllowedMethod>
<AllowedMethod>PUT</AllowedMethod>
<MaxAgeSeconds>3000</MaxAgeSeconds>
<AllowedHeader>*</AllowedHeader>
</CORSRule>
</CORSConfiguration>
class UploadController < ActionController::Base
...
def index
options: {
# The name of your bucket.
bucket: 'bucket-name',
# S3 region. If you are using the default us-east-1, it this can be ignored.
region: 'eu-west-1',
# The folder where to upload the images.
keyStart: 'uploads',
# File access.
acl: 'public-read',
# AWS keys.
accessKey: 'YOUR_AWS_ACCESS_KEY',
secretKey: 'YOUR_AWS_SECRET_KEY'
}
@aws_data = FroalaEditorSDK::S3.data_hash(options)
end
...
end
The view:
<script>
$(function() {
$('.selector').froalaEditor({
fileUploadToS3: <%= @aws_data.to_json.html_safe %>,
})
});
</script>
Do you think we can improve this article? Let us know.