Please, visit the Rhotoalbum's GitHub page.
The latest version 0.9 was released on January 17, 2011. The first one on May 25, 2007.
Rhotoalbum is a photo album generator programmed in Ruby.
It works with a directory structure, it produces static web content and it does not require any database.
Rhotoalbum generates thumbnails and the index.html (rss.xml) file in each subdirectory. There is a possibility to add titles and descriptions of the images.
i) for generating cute thumbnails by applying various effects:
ii) for displaying EXIF data of the photos:
For installing the libraries you may need an admin or root access, e.g. on Linux you may use sudo gem install exifr.
There are two ways how to publish the photos and files generated by rhotoalbum:
a) a web hosting with a shell account
b) a minimal web hosting or without Ruby or libraries
Rhotoalbum expects that your photos are stored in directories (and their subdirectories). The Rhotoalbum files should be installed (do not worry, it means unpacked) it the top directory of this structure.
photos 2005 01_London 02_Stockholm 03_Oslo 2006 01_Paris 02_Madrid 03_Rome 2007 01_Sydney 02_Melbourne
In this example, the Rhotoalbum files should be stored in the
photos john 200702 Beach 200705 Party alice 200703 Nice sunset 200705 Party
Again, the Rhotoalbum files should be stored in the
That's all :)
Rhotoalbum starts in the actual directory where it gathers all subdirectories and image files.
If there are image files, it creates the
thumbnails directory, creates a thumbnail for each image and stores is in the
Then it creates the index.html file that contains:
And it repeats these steps for each subdirectory (and its subdirectories).
Directories and files are ordered by their names.
There are plenty of possibilities how to customize the generated result.
The first step is to prepare your options file options.yml by copying the options template options.yml.template, so the next rhotoalbum update does not overwrite your settings:
(Windows) copy options.yml.template options.yml
(Linux or OS X) cp options.yml.template options.yml
Change the title option to set the photoalbum title:
title: My Photos
Change the author option to set the author name:
author: John Smith
There are various thumbnail effects that can be set in the effect setting:
And there are various album thumbnail effects that can be set in the effectAlbum setting:
All effects that include rotating (rotate, polaroid and all album effects) are randomly rotated - each thumnail looks slightly different; and each generator run will produce different thumbnails.
Once a thumbnail is generated, it is not generated again - it is necessary to remove existing thumbnails to reflect a changed effect option. This can be done by calling the rhotoalbum generator with the clean command:
ruby rhotoalbum.rb clean
To clean only album thumnails (highlight.jpg) you may use the cleanhighlight command:
ruby rhotoalbum.rb cleanhighlight
The album cover is by default the first image in the album. The album cover image is used to generate an album thumbnail - that is used in the parent album page as an image for the album link.
To change the default behaviour (the first image of album) just create the cover.jpg file the album:
ln -s img_1234.jpg cover.jpg
copy img_1234.jpg cover.jpg
A link to an album = subdirectory uses a thumbnail
highlight.jpg located in that subdirectory.
It is automatically created from the first image or the cover image in the album = directory, however there is a possibility to set own or already genereated thumbnail:
ln -s thumbnails/th_img_1234.jpg highlight.jpg
copy thumbnails/img_1234.jpg . mv img_1234.jpg highlight.jpg
Note: This is an older way how to set an album thumbnail, but it is still supported and it allows to use own images as thumnails.
The best practice / sequence of steps for generating albums:
./rhotoalbum.rb textto generate
description.txtfile in each directory.
cp options.yml.template options.yml
options.ymlfile, e.g. enable cool effects for the photo slideshow:
panning: true fading: true
./rhotoalbum.rbAll thumbnails, index pages will be generated.
highlight.jpg(by copy or symbolic link) in each directory for the album front page.
Rhotoalbum uses the TripTracker slideshow. See the link for more details.
Rhotoalbum is distributed under the GPL license.
A few of (not so) frequently asked questions:
ssh account, FTP
Q: I do not have an ssh account, only FTP. Is there a way how to use Rhotoalbum?
A: Well, there is a possibility to generate your album on your computer and then transfer all files to your server. Usually, photos are quite large, so to copy the whole album again and again is cumbersome. Of course, you could copy only the changed files, but if you would install a new version of Rhotoalbum :), you would have to manually copy all changed files in all directories.
Q: Is it possible to change the image viewer?
Q: The panning and fading effects are cool, but it does not run smoothly on slower computers. What to do?
A: Unfortunately, then there is only one way: to disable them. For that reason they are disabled by default.
Q: What should I do to regenerate some or all files?
A: There are two options:
./rhotoalbum.rb cleanindexto remove all index files, or
./rhotoalbum.rb cleanto delete thumbnails, indices, highlights
Q: What should I do if I added photos to already existing structure?
A: As simple as you may think :) Just copy them to a directory where you want to have them and execute the
./rhotoalbum.rb as you did the first time.
./rhotoalbum.db [command] Commands: generate (default) generates index.html, thumbnails for all subdirectories recursively (doesn't overwrite already generated files) text generates descriptions.txt file in each subdirectory where album/photo descriptions can be written rebuild combines cleanindex, text, and generate (helpful when using text description for your photos) cleanindex remove all index.html files recursively clean remove all generated thumbnails, indices, highlights recursively help displays a short Usage
If a photo title is not enough, you can assign a description text to any album or photo.
Thereare two ways how to do it:
IMG123.JPGthe description file is
description.txtcontaining one-line mappings of the format: image name, text separated by colon, semicolon, comma or tab, e.g.
IMG123.JPG : Sunset My Album : Vacation 2007
You can customize the album generation. You can do it in the
options.yml file. If this file is present the options will be used. You can copy the file from
The following properties can be customized:
Michael Adams for his CSS file optimisation and double thumbnails fix.
Mooffie for the relative links, adding index.html to URLs for browsing without a web server and a fix for the too many open files bug.