Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update documentation #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update documentation #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 77 additions & 69 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,120 +1,128 @@
= paperclip-azure

home :: https://github.com/supportify/paperclip-azure
code :: https://github.com/supportify/paperclip-azure
rdoc :: https://www.rubydoc.info/docs/paperclip-azure
bugs :: https://github.com/supportify/paperclip-azure/issues

== DESCRIPTION:
# paperclip-azure

Paperclip-Azure is a [Paperclip](https://github.com/thoughtbot/paperclip) storage driver for storing files in a Microsoft Azure Blob.

== FEATURES/PROBLEMS:
* home https://github.com/supportify/paperclip-azure
* code https://github.com/supportify/paperclip-azure
* rdoc https://www.rubydoc.info/docs/paperclip-azure
* bugs https://github.com/supportify/paperclip-azure/issues

* FIX (list of features or problems)

== SYNOPSIS:
## SYNOPSIS

The Azure storage engine has been developed to work as similarly to S3 storage configuration as is possible. This gem can be configured in a Paperclip initializer or environment file as follows:

Paperclip::Attachment.default_options[:storage] = :azure
Paperclip::Attachment.default_options[:azure_credentials] = {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME']
}

```ruby
Paperclip::Attachment.default_options[:storage] = :azure
Paperclip::Attachment.default_options[:azure_credentials] = {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME']
}
```
Or, at the level of the model such as in the following example:

has_attached_file :download,
storage: :azure,
azure_credentials: {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME']
}

Additionally, you can also supply credentials using a path or a File that contains the +storage_access_key+ and +storage_account_name+ that Azure gives you. You can 'environment-space' this just like you do to your `database.yml` file, so different environments can use different accounts:

development:
storage_account_name: foo
storage_access_key: 123...
test:
storage_account_name: foo
storage_access_key: abc...
production:
storage_account_name: foo
storage_access_key: 456...
```ruby
has_attached_file :download,
storage: :azure,
azure_credentials: {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME']
}
```

This is not required, however, and the file may simply look like this:
Additionally, you can also supply credentials using a path or a File that contains the `storage_access_key` and `storage_account_name` that Azure gives you. You can 'environment-space' this just like you do to your `database.yml` file, so different environments can use different accounts:

```yaml
development:
storage_account_name: foo
storage_access_key: 123...
test:
storage_account_name: foo
storage_access_key: abc...
production:
storage_account_name: foo
storage_access_key: 456...
```

This is not required, however, and the file may simply look like this:

```yaml
storage_account_name: foo
storage_access_key: 456...
```
In which case, those access keys will be used in all environments. You can also put your container name in this file, instead of adding it to the code directly. This is useful when you want the same account but a different container for development versus production.


=== Private Blob Access
### Private Blob Access

In the even that are using a Blob that has been configured for Private access, you will need to use the Shared Access Signature functionality of Azure. This functionality has been baked in to the `Attachment#expiring_url` method. Simply specify a time and a style and you will get a proper URL as follows:

object.attachment.expiring_url(30.minutes.since, :thumb)
`object.attachment.expiring_url(30.minutes.since, :thumb)`

For more information about Azure Shared Access Signatures, please refer to [here](http://azure.microsoft.com/en-us/documentation/articles/storage-dotnet-shared-access-signature-part-1/).

=== Azure Environments
### Azure Environments

Microsoft offers specialized Azure implementations for special circumstances should the need arise. As of the most recent update of this gem, the AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud environments all offer specific storage URL's that differ from those of the standard AzureCloud. These regions can be specified via the `:region` key of the `:azure_credentials` dictionary by using the symbols `:cn`, `:usgovt`, and `:de` respectively. When working with one of these environments, simply update your credentials to include the region as follows:

Paperclip::Attachment.default_options[:azure_credentials] = {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME'],
region: :de
}
```ruby
Paperclip::Attachment.default_options[:azure_credentials] = {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME'],
region: :de
}
```

Or, in the instance where the credentials are specified at the model level:

has_attached_file :download,
storage: :azure,
azure_credentials: {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME'],
region: :cn
}
```ruby
has_attached_file :download,
storage: :azure,
azure_credentials: {
storage_account_name: ENV['AZURE_STORAGE_ACCOUNT'],
storage_access_key: ENV['AZURE_STORAGE_ACCESS_KEY'],
container: ENV['AZURE_CONTAINER_NAME'],
region: :cn
}
```

== REQUIREMENTS:
## INSTALL

* An Azure storage account.
### REQUIREMENTS

== INSTALL:
* An Azure storage account.

Add this line to your application's Gemfile after the Paperclip gem:

gem 'paperclip-azure', '~> 1.0'

```ruby
gem 'paperclip-azure', '~> 1.0'
```
And then execute:
```bash
$ bundle install
```

$ bundle install
## FEATURES / PROBLEMS

== DEVELOPERS:
* FIX (list of features or problems)

## DEVELOPERS

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* After checking out the source, run:

$ rake newb

```bash
$ rake newb
```
This task will install any missing dependencies, run the tests/specs, and generate the RDoc.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
* Submit a pull request for the finished product's integration.

== LICENSE:
## LICENSE

(The MIT License)

Expand Down