Elixir API

ImagePipe has two entry points in an Elixir application. ImagePipe.Plug serves images over HTTP from your Phoenix or Plug app. ImagePipe.run/4 and ImagePipe.write/5 process images directly in your code, such as uploads in a background job, and return the result or write it to a file. Both use plans, written with ImagePipe.URL or as URLs, and take their sources, caches, and limits from one configuration, so an application can use both.

Elixir guides

• Installation: the Hex dependency and supported image formats.
• Processing images in Elixir: a first plan, run on a local file from iex.
• Getting started with Phoenix: mount ImagePipe.Plug in a router.
• Serving and processing in one app: share one configuration between a mount and direct calls.
• Caching processed images: store processed images on disk, with a size limit.
• Fetching images from the server: use results from an ImagePipe server running elsewhere.

Elixir API reference

• ImagePipe: configuration, supervised instances, run/4, and write/5.
• ImagePipe.Result: the fields of a successful result.
• ImagePipe.URL: building plans, signing, and source encryption.
• ImagePipe.Plug: mount options.
• Elixir configuration: where each setting goes. ImagePipe.config/1 lists every option.
• Image sources: local files, HTTP(S), and S3.
• Signing URLs and rotating keys: signing keys and expiry.
• Defining presets: named sets of options and request defaults.
• Requesting images and the processing options: what each option does, with the builder spelling of each.