Overview

HTTPS SSH

Belt

Extensible Elixir OTP Application for storing files remotely or locally through a unified API. Backends currently exist for the local filesystem, SFTP and the Amazon S3 API.

Documentation

Check out the documentation at hexdocs.pm/belt and our Getting Started guide.

Usage

#Simple file upload
{:ok, config} = Belt.Provider.SFTP.new(host: "example.com", directory: "/var/files",
                                       user: "…", password: "…")
Belt.store(config, "/path/to/local/file.ext")
#=> {:ok, %Belt.FileInfo{…}}


#Asynchronous file upload
{:ok, config} = Belt.Provider.S3.new(access_key_id: "…", secret_access_key: "…",
                                     bucket: "belt-file-bucket")
{:ok, job} = Belt.store_async(config, "/path/to/local/file.ext")
#Do other things while Belt is uploading in the background
Belt.await(job)
#=> {:ok, %Belt.FileInfo{…}}

Installation

Belt can be installed by adding belt to your dependencies and application list in mix.exs:

def deps do
  [{:belt, "~> 0.1.0"}]
end

def application do
  [extra_applications: [:belt]]
end

Installation for the S3 backend

If you want to use the S3 backend, you also need to add ExAws as well as Hackney and sweet_xml (which are required by ExAws) to your dependencies and applications list:

def deps do
  [{:belt, "~> 0.1.0"},
   {:ex_aws, "~> 1.0"},
   {:hackney, "~> 1.6"},
   {:sweet_xml, "~> 0.6"}]
end

def application do
  [extra_applications: [:belt, :hackney, .sweet_xml]]
end

License

Belt is dual-licensed and can be used under the terms of either the GNU AGPLv3 or the Apache 2.0 license (which is the license Elixir uses).