Waffle is a flexible file upload library for Elixir with straightforward integrations for Amazon S3 and ImageMagick.
Add the latest stable release to your mix.exs
file, along with the required dependencies for ExAws
if appropriate:
defp deps do
[
{:waffle, "~> 1.0.0"},
# If using S3:
{:ex_aws, "~> 2.1"},
{:ex_aws_s3, "~> 2.0"},
{:hackney, "~> 1.9"},
{:sweet_xml, "~> 0.6"}
]
end
Then run mix deps.get
in your shell to fetch the dependencies.
Waffle expects certain properties to be configured at the application level:
config :waffle,
storage: Waffle.Storage.S3, # or Waffle.Storage.Local
bucket: {:system, "AWS_S3_BUCKET"}, # if using S3
asset_host: "http://static.example.com" # or {:system, "ASSET_HOST"}
# If using S3:
config :ex_aws,
json_codec: Jason
Along with any configuration necessary for ExAws.
Waffle comes with a companion package for use with Ecto. If you intend to use Waffle with Ecto, it is highly recommended you also add the waffle_ecto
dependency. Benefits include:
- Changeset integration
- Versioned urls for cache busting (
.../thumb.png?v=63601457477
)
Copyright 2019 Boris Kuznetsov Copyright 2015 Sean Stavropoulos
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.