Skip to content

Latest commit

 

History

History
83 lines (65 loc) · 2.64 KB

README.md

File metadata and controls

83 lines (65 loc) · 2.64 KB
Raw

thumbnaild

the missing thumbnail service for amazone AWS S3.

<img src="http://localhost:3000/90x90/my-pics/2010-10/DSC_1.jpg" />
<img src="http://localhost:3000/full/huizhe_pictures/test2.jpg?sign=12b74babb069365781b23bfe61274f91ba210452" />

Features:

  • generate thumabnails for images storaged on AWS S3 through HTTP (uses imagemagick)
  • caching support on both hard-disk & S3
  • multi bucket & account support (checkout /config/buckets/)
  • user-defined thumbanil schemas support (checkout /config/schemas/)

Usage (command-line):

  1. Install ImageMagick (for processing images) http://www.imagemagick.org/script/index.php
  2. Install Node http://nodejs.org/
  3. Install thumbnaild
npm install -g thumbnaild
  1. Create a folder for thumbnaild server
thumbnaild install <folder path>

  1. Modify the config files in /config/buckets & /config/schemas under the you just entered

  2. Kick off the thumbnail server

cd <folder path>
thumbnaild start [--port <port defaults to 8011>]
  1. Your thumbnail can now be accessed via
http://<your server name>:8011/<thumbnail schema>/<s3 bucket name>/<s3 image full path>

Usage (programmaticlly)

global.THUMBNAILD_HOME = 'your thumbnaild home folder'; // where thumbnaild will read bucket & schema configuration & store cache files
var thumbnaild = require('thumbnaild');
var app = express();
app.get('/:schema/:bucket/*', thumbnaild.getThumbnail);

Planning:

  • support for other storage system other than S3 (mogilefs, etc)
  • more testcases
  • more documents

License

(The MIT License)

Copyright (c) 2013 Huizhe XIAO <huizhe.xiao@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.