/images3-play

Simple image hosting service for developers.

Primary LanguageJava

#ImageS3

ImageS3 is a free and open image hosting service for developers. It is designed to store, resize and manage images for all your web and mobile apps in one place.

##Features

  • Apply AmazonS3 as infrastructure for storing your image files.

  • Create template to resize your images into different versions.

  • REST APIs for easy application integration.

  • Support PNG, JPG, BMP and GIF formats.

  • Web-based admin tool with live monitoring:

##Installation

###Installing Requirements

  • Java - ImageS3 developed in Java. You can download the latest JRE7 build from here.

  • Play Framework - Play Framework is a lightweight and highly-scalable application server. ImageS3 released with Play as a standalone package which lets you don't need to download different jar files separately. Follow this instruction to install 2.3.x Play Framework.

  • MongoDB - MongoDB is a leading NoSQL database with amazing features. ImageS3 uses MongoDB to store image metadata and other objects information. Follow this instruction to install the latest MongoDB.

  • Amazon S3 -- Amazon S3 is a secure, durable and highly-scalable cloud storage service. ImageS3 uses Amazon S3 to store image files. If you already have Amazon AWS account, you can skip this, otherwise, sign up one at here.

###Installing ImageS3

Download and unzip the compressed package:

$ wget https://github.com/gogoup/images3-dist/raw/master/images3-play-latest.zip
$ unzip images3-play-latest.zip

Create default location for image files.

$ mkdir -p /images3/images

##Configuring ImageS3

All the configuration files are located in image-play-[version]/conf.

You need to set the following properties before running ImageS3:

  • mongodb.properties
    • 'mongodb.url' -- MongoDB server IP address.
    • 'mongodb.port' -- MongoDB server port number. 27017 is the default number.
    • 'mongodb.username' -- Username of MongoDB connection. Leave this value empty, if you don't setup username on MongoDB.
    • 'mongodb.password' -- Password of MongoDB connection. Leave this value empty, if you don't setup password on MongoDB.

If you have a different location for image files, then setup the following configurations.

  • imagecontent.properties

    • 'imagecontent.download.dir' -- A place used to store images uploaded from clients or download from Amazon S3. Make sure the directory exists.

  • imageprocessor.properties

    • 'image.processing.tempdir' -- A place used to store resized images. Make sure the directory exists.

##Running ImageS3

Enable execution persmissions:

$ chmod +x images3-play-[version]/bin/*

Use the following command to run ImageS3:

$ ./images3-play-[version]/bin/images3-play

And then, open http://localhost:9000 in your browser, you will see the admin tool:

#

You can also run ImageS3 on different port, for example 8080:

$ ./images3-play-[version]/bin/images3-play -Dhttp.port=8080

##How to Use

Checking the wiki page.

##License Released under the Apache License 2.0