Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloud8421/dragonfly-server
Elixir app to serve Dragonfly images
https://github.com/cloud8421/dragonfly-server
Last synced: 8 days ago
JSON representation
Elixir app to serve Dragonfly images
- Host: GitHub
- URL: https://github.com/cloud8421/dragonfly-server
- Owner: cloud8421
- Archived: true
- Created: 2014-10-21T13:42:58.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-08-07T07:00:54.000Z (over 9 years ago)
- Last Synced: 2024-08-02T02:11:15.905Z (3 months ago)
- Language: Elixir
- Size: 904 KB
- Stars: 41
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Elixir app to serve Dragonfly images. (Applications)
- fucking-awesome-elixir - dragonfly_server - Elixir app to serve Dragonfly images. (Applications)
- awesome-elixir - dragonfly_server - Elixir app to serve Dragonfly images. (Applications)
README
# Dragonfly server
[![Build Status](https://travis-ci.org/cloud8421/dragonfly-server.svg?branch=master)](https://travis-ci.org/cloud8421/dragonfly-server)
This application can be used to serve Dragonfly urls.
# Limitations
- Doesn't support the full Dragonfly feature set (for now).
- Limited to Imagemagick.# Setup
## Dependencies
#### Erlang
**IMPORTANT**: Due to a known bug in Erlang 17.3, fetching urls with an `https` scheme are not processed correctly and throw an exception.
Please use Erlang >= 17.4, available at .
#### Elixir
To install elixir on a Mac, `brew install elixir` (you may need to `brew update` first).
Alternatively, you can follow [these instructions](http://elixir-lang.org/install.html).
#### Imagemagick
To install Imagemagick with png support, run `brew install jpeg libpng imagemagick`.
#### Goon
Communication with Imagemagick is managed by [Goon](https://github.com/alco/goon), a middleman needed to polyfill the incomplete Port
implementation provided by Erlang (see [here](https://github.com/alco/porcelain/wiki/Implementation#the-middleman) for more information).Download the binary and add it to a directory available in your `$PATH`.
## App setup
$ mix deps.get
This will install all needed packages.
Then, copy the example environment file and make the necessary adjustments.
$ cp .env.example .env
## Run the app in development
$ iex -S mix
Starts the app and opens a console.
## Run tests
$ mix test
## General api
Images are served at the entry point defined in `config.exs`, set as default at `/media/:payload/:filename`.
Note that both params in the url scheme are needed by the application.
## Admin api
The app exposes an admin api that can be used to programmatically expire an image and all its associated resources.
Endpoints are:- GET image (shows steps necessary to generate image)
- DELETE image (expires all caches involved in the generation of the image)Given an image url in the form of:
http://example.com/media/12345/untitled.jpg
It can be deleted by sending a `DELETE` request to the following endpoint:
http://example.com/admin/media/12345/untitled.jpg
From the command line:
$ curl -XDELETE http://example.com/admin/media/12345/untitled.jpg
The expected response is a `202`, which indicates that the cache expiry has been scheduled and will be performed asyncronously.
The steps necessary to generate the image can also be examined at:
http://example.com/admin/media/12345/untitled.jpg
From the command line:
$ curl http://example.com/admin/media/12345
## Deploy on Heroku
The app runs only on Cedar-14 and requires the multi-buildpack as it uses a custom Elixir buildback (it includes Goon).
Buildpacks are defined in `.buildpacks`.
Please follow instructions at .