A library for generating an IIIF level 0 compatible static server on Amazon S3
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib version bump for initial release Nov 26, 2017
spec everything is tidied Nov 26, 2017
.gitignore wip commit Nov 26, 2017
.rspec wip commit Nov 26, 2017
.travis.yml wip commit Nov 26, 2017
.yardopts wip commit Nov 26, 2017
Gemfile wip commit Nov 26, 2017
Guardfile wip commit Nov 26, 2017
LICENSE.txt wip commit Nov 26, 2017
README.md reduced dependencies, all tests pass Nov 26, 2017
Rakefile
TODO.md updated dependencies Nov 26, 2017
iiif_s3.gemspec everything is tidied Nov 26, 2017
test.rb wip commit Nov 26, 2017

README.md

IiifS3

This software library is designed to be used to generate IIIF compatible images stacks and metatdata from a collection of images, and then to upload those images to Amazon S3 for static serving.

Installation

This library assumes that you have ImageMagick installed. If you need to install it, follow the instructions:

on OSX, brew install imagemagick should be sufficient.

If you have issues with TIFF files, try

brew update 
brew reinstall --with-libtiff --ignore-dependencies imagemagick

If you plan to work with PDFs, you should also have a copy of GostScript installed.

on OSX, brew install gs

Add this line to your application's Gemfile:

gem 'iiif_s3'

And then execute:

$ bundle

Or install it yourself as:

$ gem install iiif_s3

Usage

IiifS3 assumes that you have an Amazon S3 account configured for use. By default, it uses the same locations that the Amazon S3 ruby library searches:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY'] The shared credentials ini file at ~/.aws/credentials (more information) From an instance profile when running on EC2. The SDK also searches the following locations for a region: ENV['AWS_REGION']

Contributing

  1. Fork it ( https://github.com/cmoa/iiif_s3/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request