Skip to content
Browse files

Merge pull request #868 from jjb/better-s3-url-docs

s3 url doc improvements
  • Loading branch information...
2 parents 01406e1 + 9ab9286 commit d6a3a712dbf13b81be58145f0f69d7c2d3b09be7 @sikachu sikachu committed May 11, 2012
Showing with 13 additions and 6 deletions.
  1. +13 −6 lib/paperclip/storage/s3.rb
View
19 lib/paperclip/storage/s3.rb
@@ -60,12 +60,19 @@ module Storage
# Normally, this won't matter in the slightest and you can leave the default (which is
# path-style, or :s3_path_url). But in some cases paths don't work and you need to use
# the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
- # NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
- # :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
- # alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
- # by S3. The fourth option for the S3 url is :asset_host, which uses Rails' built-in
- # asset_host settings. NOTE: To get the full url from a paperclip'd object, use the
- # image_path helper; this is what image_tag uses to generate the url for an img tag.
+ #
+ # Notes:
+ # * The value of this option is a string, not a symbol.
+ # <b>right:</b> <tt>":s3_domain_url"</tt>
+ # <b>wrong:</b> <tt>:s3_domain_url</tt>
+ # * If you use a CNAME for use with CloudFront, you can NOT specify https as your
+ # :s3_protocol;
+ # This is *not supported* by S3/CloudFront. Finally, when using the host
+ # alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
+ # by S3. The fourth option for the S3 url is :asset_host, which uses Rails' built-in
+ # asset_host settings.
+ # * To get the full url from a paperclip'd object, use the
+ # image_path helper; this is what image_tag uses to generate the url for an img tag.
# * +path+: This is the key under the bucket in which the file will be stored. The
# URL will be constructed from the bucket and the path. This is what you will want
# to interpolate. Keys should be unique, like filenames, and despite the fact that

0 comments on commit d6a3a71

Please sign in to comment.
Something went wrong with that request. Please try again.