https://github.com/cmoa/iiif_s3

A library for generating an IIIF level 0 compatible static server on Amazon S3
https://github.com/cmoa/iiif_s3

Last synced: about 2 months ago
JSON representation

A library for generating an IIIF level 0 compatible static server on Amazon S3

• Host: GitHub
• URL: https://github.com/cmoa/iiif_s3
• Owner: cmoa
• License: mit
• Created: 2015-11-13T16:10:21.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-26T23:24:42.000Z (about 7 years ago)
• Last Synced: 2024-08-31T20:03:01.274Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 2.57 MB
• Stars: 29
• Watchers: 10
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-iiif - iiif_s3 - Ruby library for generating a static IIIF level 0 Image and Presentation API server on Amazon S3. (Image Servers / IIIF Extensions)

README

        
# 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

```shell

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