photomix/README

110 lines
4.1 KiB
Plaintext
Raw Normal View History

== Welcome to Balder photo gallery
2009-05-22 14:13:46 +02:00
2009-07-06 16:12:39 +02:00
Made by Espen Antonsen.
2009-05-22 14:13:46 +02:00
Version 1.2.1 for Rails3. See the rails2 branch for previous version.
http://balderapp.com
2009-06-09 00:39:36 +02:00
== Features
2010-07-01 12:28:45 +02:00
* Stores photos to disk in folders or on S3 (can run from Heroku...yay)
2009-07-06 16:12:39 +02:00
* Create multiple thumbnails of custom sizes
* Read and writes EXIF/IPTC title, description and keywords
* Organize in albums (as events in iPhoto)
* Combine albums in collections (as albums in iPhoto)
* Upload multiple photos
2009-06-09 00:39:36 +02:00
* Tag photos. Can also tag albums (actually all photos in album is tagged)
2009-07-06 16:12:39 +02:00
* User management with roles and permissions
* Geo-location of albums & photos with Google Maps integration.
2009-07-27 19:16:17 +02:00
== License
Free for personal use. Contact me for commercial license.
2009-06-02 00:08:57 +02:00
== Requirements
2009-05-22 14:13:46 +02:00
2010-09-21 22:37:08 +02:00
Rails 3.0
2009-06-03 01:33:39 +02:00
2009-06-02 00:08:57 +02:00
Software
Default:
- ExifTool (required for Mini_EfixTool). Can be disabled. Default is to read EXIF tags but not write them to the file when database is updated as writing EXIF is slow. To enable just uncomment exif_write in photo.rb
- ImageMagicK. Carrierwave can use either RMagicK or MiniMagicK (default). To change resize option the correct gem must be used (specified in Gemfile) and change included setting for Carrierwave in file_uploader.rb
Optional:
- ImageScience.
Ruby Gems: See Gemfile
2011-04-11 11:17:08 +02:00
== Configuration
config/balder.rb has the following adjustable settings:
STORAGE_PATH Relative path to where the photos are stored. Default: uploads
Under the specified path two folders are used. "files" for original files and "thumbs" for generated thumbnails.
This can be adjusted in app/uploaders/file_uploader.rb
PRIVATE Require visitors to have a user and authenticate before viewing photos.
TITLE Title of site
HEROKU To be used on heroku.com. This will adjust carrierwave to save to Heroku's tmp area.
S3_KEY For saving files to Amazon S3 (required for Heroku)
S3_SECRET For saving files to Amazon S3 (required for Heroku)
S3_BUCKET For saving files to Amazon S3 (required for Heroku)
As these are environment variables you can easily add them to Heroku:
http://devcenter.heroku.com/articles/config-vars#rack_env_rails_env_merb_env
2011-04-11 12:02:22 +02:00
For a brief introduction to how to set up Balder on Heroku see:
http://blog.inspired.no/rails-photo-gallery-balder-on-heroku-and-s3-726
2009-06-09 00:39:36 +02:00
== Installation
2009-07-29 14:55:43 +02:00
1. Clone the project from GitHub or Gitorious:
GitHub: git clone git://github.com/espen/balder.git
2. Install required software listed above
3. 'bundle install' to install required gems.
2011-04-11 11:17:08 +02:00
4. Adjust the settings in balder.rb (See configuration above)
5. Copy database file (not needed when hosting on Heroku):
cp config/database.example.yml config/database.yml
6. Create database user and edit database file. (unless on Heroku or using SQLite3)
7. rake db:create
8. rake db:migrate
9. Start up the project with your preferred web-server
2009-07-06 15:49:03 +02:00
2009-07-06 16:12:39 +02:00
=== Optional: add photos directly to disk
2009-07-06 15:49:03 +02:00
The gallery has a web-based upload tool. Alternatively you can upload files directly to the upload folder. This means you can import an existing folder based photo collection to Balder.
2009-07-06 15:49:03 +02:00
2009-08-03 16:23:51 +02:00
Put photos in containing folders(albums) in the specified gallery folder.
Hierarchy of folders is not fully supported.
This format is recommended:
2009-06-09 00:39:36 +02:00
./ski weekend in hemsedal/snow.jpg
./ski weekend in hemsedal/afterski.jpg
./trip to iran/beautiful girls in tehran.jpg
./trip to iran/mosque in yazd.jpg
./trip to iran/powder snow in dizin.jpg
2011-04-11 11:17:08 +02:00
Every time you manually add photos to disk you must scan by visiting /photos/scan or run ScanFiles.Scan(false) from the console.
== Version history
1.2.1
- Using plupupload instead of uploadify for non-flash upload options. Can now use html5, normal form, silverlight, gears and browserplus for photo upload.
2011-04-11 11:17:08 +02:00
1.2.0
- New storage path: "/uploads/files/" instead of "/uploads/". Make sure you move your photos or adjust the storage path.
== TODO
- Testing...
2009-06-09 00:50:25 +02:00
== IDEAS
- Themes
- Improved UX
- Mobile/Tablet friendly display using CSS media queries
Patches welcome!
2009-07-29 17:52:55 +02:00
== Copyright and license info
2009-07-31 16:04:56 +02:00
This code is copyrighted by Espen Antonsen. The source code is available free under the GNU General Public License version 3 (GPLv3).
2009-07-29 17:52:55 +02:00
2009-07-31 16:04:56 +02:00
If the GPLv3 is not suitable for you please contact me for an alternative license for a fee.