Index of /

      Name                    Last modified       Size  Description


[DIR] Parent Directory        05-Feb-2008 13:03      -  
[TXT] MANIFEST                04-Mar-2005 02:38    18k  
[DIR] awstats/                07-Mar-2005 20:58      -  
[TXT] bio.html                05-Feb-2008 13:02     2k  
[DIR] bio/                    17-Apr-2006 15:04      -  
[DIR] cgi-bin/                07-Mar-2005 20:58      -  
[   ] config.php              09-Mar-2005 15:04     6k  
[DIR] cp/                     07-Mar-2005 20:46      -  
[DIR] docs/                   09-Mar-2005 14:58      -  
[TXT] edgar.html              05-Feb-2008 13:02     1k  
[   ] embed.php               02-Mar-2005 08:57    27k  
[TXT] family.html             05-Feb-2008 13:02     1k  
[DIR] images.old/             07-Mar-2005 20:46      -  
[DIR] images/                 09-Mar-2005 14:58      -  
[DIR] img/                    05-Feb-2008 13:02      -  
[TXT] index.html              05-Feb-2008 13:02     1k  
[TXT] index.html.old          07-Mar-2005 20:46    11k  
[   ] index.php               28-Jan-2005 17:40     1k  
[   ] init.php                10-Feb-2005 15:54     7k  
[DIR] install/                09-Mar-2005 15:55      -  
[DIR] layouts/                09-Mar-2005 14:58      -  
[DIR] lib/                    09-Mar-2005 14:58      -  
[TXT] login.html              07-Mar-2005 20:46    11k  
[   ] main.php                27-Feb-2005 15:18    17k  
[TXT] me.html                 05-Feb-2008 13:02     1k  
[DIR] modlogan/               03-Jul-2010 02:28      -  
[DIR] modules/                09-Mar-2005 14:58      -  
[DIR] templates/              09-Mar-2005 14:58      -  
[TXT] thanksgiving.html       05-Feb-2008 13:02     1k  
[DIR] themes/                 09-Mar-2005 14:58      -  
[DIR] upgrade/                09-Mar-2005 14:58      -  
[DIR] webalizer/              20-Oct-2009 02:40      -
README: Gallery 2 Beta 1 (Dark Fibre) Gallery 2.0 Beta 1

Welcome to Gallery 2.0 (G2). This is the first “Beta” release of G2, code named “Dark Fibre”. Please read through this document carefully before installing G2 and before asking for help. We have taken care to try to answer as many of your questions here as possible. If you don't read this and have problems, we may refer you back to this document as a first resource.

Contents

Quick Start

If you’re impatient like us, you just want to get going. The odds are that your system is all set to handle G2 so just skip right to the installer and start clicking. It should walk you through everything you need to get going. Before you do that, you should really read the When to use G2 Beta and When not to use G2 Beta sections! But if you hit a snag, please come back here and read more before asking questions! Enjoy.

What is Gallery?

Gallery is a web based software product that lets you manage your photos on your own website. You must have your own website with PHP support in order to install and use it. With Gallery you can easily create and maintain albums of photos via an intuitive interface. Photo management includes automatic thumbnail creation, image resizing, rotation, ordering, captioning, searching and more. Albums and photos can have read, write, caption and other permissions per individual authenticated user for an additional level of privacy. Give accounts to your friends and family and let them upload and manage their own photos on your website!

What is G2 Beta?

A Beta version or Beta release is the second official round of releases of a product. A Beta release can sometimes be unstable, contains both known and unknown bugs. Generally, almost all of the features of the final product will be present. We release it early so that you can see what is coming and give us feedback that will help us improve the final release.

G2 Beta requirements

When to use G2 Beta

You should install G2 Beta to try it out. You could install it next to your production version of Gallery 1.x in a hidden directory. You could install it on a development server. We want you to try it, test it, break it, and tell us all about it. Get your friends and colleagues to poke around. You can use the migration module to import some or all of your G1 albums into G2 for test purposes (this shouldn’t affect your G1 installation at all).

When not to use G2 Beta

Do not use it as the main repository for your data. Do not use it for a production web site. Although we provide an upgrade path we will not provide the same level of support for G2 that we provide for G1 until we get to release candidates. We know that G2 is much better than G1, and it may be tempting to just replace your G1 with it. But we're still making plenty of changes and mistakes happen so if you use it in production, be prepared to dig into it yourself and fix things if they break.

Warning!

G2 has not yet been subjected to a rigorous security audit! While we have taken great pains to make sure that it is secure, there is still the chance that there are some big security holes in it that might cause you trouble. If you find a security flaw, please contact us at gallery@menalto.com right away!

What’s new in G2 Beta

G2 has been redesigned from the ground up and is database driven! It is secure, scalable, reliable, modular, customizable, portable and intuitive. In short, we looked at all the things we did wrong in G1 and we did them again the right way. Two and a half years of design and development have gone into G2. It’s got customizable themes and layouts using XHTML compliant templates which makes it much easier for you to personalize your G2 install. All the cool bells and whistles are in modules that can be enabled separately for maximum control.

Highlight of changes in Gallery 2 Beta 1 (Dark Fibre) -

  1. Rewrite - New module for creating compact, search engine friendly urls.
  2. Recursively Add Directories - You can now add an entire hierarchy of images in directories at once. Gallery will turn each sub-directory into an appropriate sub-album.
  3. Locking - New database locking system that allows Gallery to run properly on NFS filesystems.
  4. Shutterfly - New module for printing photos with Shutterfly.com.
  5. Classic Layout - New layout similar to the G1 top level album. Shows thumbnails, item details and a tree of links to subalbums.
  6. Origination Timestamp - New field to store the date normally shown with items. The field is automatically set from EXIF data if available but can also be changed manually.
  7. Resizes - Added support for both width and height bounds for photo resizes and scaling the original image.
  8. Archive Upload - New module extracts files from uploaded zip archives and adds each to the album. Implemented to allow support for other archive formats to be added later.
  9. Size Limit - New module to define maximum dimensions or file size of uploaded images.
  10. Custom Thumbnails - Thumbnail module now allows uploading a custom jpeg thumbnail for any album or item.
  11. Rearrange - New module allows rearranging the order of all items in an album at once.
  12. Album Select - New module adds a select box for jumping directly to any album.
  13. EXIF - Added ability to set item summary/description from EXIF description when new photos are uploaded.
  14. Symlink - Option to add items using symbolic links to existing files on a unix server.
  15. Sort Order
  16. Image Block Enhancements
  17. User Album Options
  18. Embedding
  19. Multisite Support - The installer can now configure multiple independent sites using a single codebase.
  20. Internationalization
  21. Error Handling - Improved handling and display of error messages.
  22. Bugs - Many, many bugs fixed.

Highlight of changes in Gallery 2 Alpha 4 (Nice Commits) +

Highlight of changes in Gallery 2 Alpha 3 (Farva) +

Highlight of changes in Gallery 2 Alpha 2 (Grand Theft Photo) +

Highlight of changes in Gallery 2 Alpha 1 (Cowbell) +

G2 Beta Installation Prerequisites

  1. Latest Version - There are two ways to get the code.
  2. Storage - Create a directory for gallery to store photos. This must be writable by the web server, but for security reasons we suggest that you do not put it in the web root. If you put it in the web root, then anybody can get directly to your images with their web browser which circumvents G2’s security.

    Unix Example

    % cd $HOME
    % mkdir g2data
    % chmod 777 g2data

    Windows Example

    C:\> mkdir g2data
    In the Unix example, you may note that modes of 777 on your g2data directory are not all that secure. However, making it more secure depends on how your system is configured. Talk with your system administrator about ways to change the permissions on that directory to make it so that Gallery can still write to the files but that others can’t.
  3. Database - Right now we support MySQL, PostgreSQL and Oracle. MySQL is generally faster than PostgreSQL. We require you to create the database yourself. In our examples below, we’ll be creating a database called gallery2. You can use any database name that you choose.

    MySQL

    mysqladmin -uroot create gallery2
    mysql gallery2 -uroot -e"GRANT ALL ON gallery2.* TO username@localhost IDENTIFIED BY 'password'"

    PostgreSQL

    createdb gallery2 -E UNICODE

    If it complains that UNICODE is not a valid encoding name, then try:
    createdb gallery2 -E SQL_ASCII

    If it complains about that, too then try:
    createdb gallery2

    Oracle

    create database gallery2 {additional parameters};
  4. Graphics Toolkits - G2 works with NetPBM, ImageMagick or GD. They’re all equally good, though some say that NetPBM has slightly better quality and that ImageMagick is slightly faster than NetPBM. GD is the fastest and is compiled into PHP by default if your PHP is 4.3.0 or more recent, however it may not have support for all image types (e.g. it might not have JPEG support). If the binaries for NetPBM and ImageMagick are installed in default, or standard, locations then G2 will auto-detect them during G2 installation. It won’t cause any harm to enable all of these toolkits—in fact you’ll get the widest file type support if you do so.

Installing G2 Beta

Open up your web browser and browse to the G2 install directory. G2 will walk you through the process of validating that your system is properly configured and will set everything up for you.

  1. Authenticate - You will be asked to create and save a small text file in order to authenticate. You may not proceed until you do this. That’s how G2 knows that you’re authorized to use the installer.
  2. System Checks - The installer checks your system to make sure that it will support G2.
  3. Admin User Setup - You are prompted for an administrator username and password. In this beta release the default Admin username is set to admin and cannot be changed during the install process (though you can change it to something else later on). Type in a password and type it again to validate it. Then click ’Create’ to create the admin user for this installation of Gallery 2.
  4. Storage Setup - Read the instructions on the installer to set up a storage location for Gallery 2. This is where G2 will store all of your images, as well as other cache information.
  5. Database Setup - Select your database type and enter your database authentication information.
  6. Create Config File - G2 will create the config.php file in your G2 directory. This contains all the answers you’ve provided in the installer and is necessary for G2 to function properly.
  7. Install the Core module - Here’s where we create all the database tables and initial users and albums to get you started. Unless something goes wrong, there’s nothing for you to do here.
  8. Install other modules - G2 has lots of different modules that provide useful functionality. Choose which ones you want to use. You can always go to the Site Admin page later on to install, activate, deactivate or uninstall modules, so it’s ok to experiment here.
  9. Check Security - G2 walks you through the process of locking down your new config.php.
  10. Finished! - Congratulations! You have successfully installed Gallery 2 Beta!

Getting started with G2 Beta

  1. Log in - Once you’ve successfully got G2 Beta installed, you should start by logging in as the admin user that was created for you at install time. The admin user has special privileges that you’ll need in order to administer your new G2.
  2. Activate Graphics Toolkits - Click on the Site Admin link then the Modules link to see the module list. Install, configure and activate one of the NetPBM, ImageMagick, or GD modules. You can activate as many of them as you want (more is better, here).
  3. Add photos - Browse back to the top of your new G2 and click on the Add Items link. This will bring up a page with a few different upload options (at least 3, more if you have other upload modules installed). Select the one you want and try adding a new photo to your album. If all goes well, you should see the new photos in your Gallery!.
  4. Add an album - You don't want to put all of your images into the top level of your G2, so you should try creating a new album. Browse back to the top of your new G2 and click on the add sub-album link from the left side of the page. This will give you a form where you can enter information about the new album you want to create. Fill it out and click the Create button. Now try adding images to that album instead, or select the Move Photo link from under any of the images you added earlier and move them into this new album.
  5. Import Gallery 1.x albums - you can easily import albums from Gallery 1.x (G1). It won’t cause any harm to your G1. Just go to the Migration Page and enter the path to your G1 albums directory and then follow the instructions.
    Note - there are known issues with the migration module. Please read about them before filing bugs!
  6. Plenty to do and see! -

Getting Help

If you have problems, you should start by looking in the G2 Support Forum on the Gallery Website. Search the forum to see if somebody else has posted a similar problem and maybe there’s an answer there, otherwise start a new topic to get help. If the problem seems like a bug in the G2 software you can file a bug in our bug tracker on SourceForge. Please read our tracker guidelines before filing a bug so that we can cut down on the number of spurious reports. If you're unsure whether to file a bug you can always post in the forums first and we'll ask you to file a bug if needed. Finally you can try to catch one of the G2 developers on our irc channel, #gallery on irc.freenode.net. Please remember that our users outnumber our developers by many orders of magnitude, and our developers are doing this in their spare time, so be considerate.

Remember – reporting bugs is good. Even if you think it’s silly, go ahead and report it. We can always close the bug or refile it (please don’t be offended in this case) but it’s harder to find bugs than it is to fix them so we’re counting on you to help us with the finding part.

Known Issues / Bugs

  1. Layouts/Themes - The current layout and theme architecture is going to change sometime during the beta cycle. We are still considering several different approaches to make creating new themes, layouts and modules easier.
  2. Performance - This beta release is much faster than the previous alphas. There are still some tweaks that we have planned that will make it even faster. We’ve still focused on features and reliability before performance, and will be continually optimizing during the Beta cycle. One issue that we are well aware of is that G2 places a heavy load on the webserver and database because of our image firewall. We have a solution for this and will implement it during the beta cycle.
  3. URL Redirection - Rewrite module and G1->G2 URL redirection do not work together in the same .htaccess file (G2 is installed where G1 used to be). To use G1 redirection and short urls, remove the Rewrite module code from .htaccess, deactivate Rewrite module and turn on pathinfo based short urls in Site Admin / General.
  4. Toolkit upgrades - Upgrade of graphics toolkits (ImageMagick, NetPBM, GD) from alpha-4 to beta-1 via the upgrader does not properly update the database. Toolkits should still work after upgrade but if you later try to activate another toolkit or the Square Thumbnails module you'll see ERROR_COLLISION: CRC mismatch. To resolve this visit Site Admin/Modules and deactivate all of the toolkits and Square Thumbnails. Then reactivate any you wish to use.

Updating your Gallery 2 Installation

Updating is quick and easy and should not lose any of your data.

  1. Get the latest code and unpack it over your existing copy of G2.
  2. Browse to the upgrader and follow the instructions there. Make a backup of your data when it tells you to! Should you lose your data due to a bug in the upgrader, the first thing we're going to tell you to do is to restore from your backups! (Then we'll probably ask you to help us reproduce the bug.)
  3. Enjoy your new version of G2.

Advanced Topics

Unit Tests - G2 was designed using Extreme Programming methodologies. This means that we have a ton of unit tests that help us make sure that the code is behaving as it should. If you want to help us out, you can try running the unit tests and report back to us if any of them fail. Note - these tests shouldn’t change your G2 settings at all, but if they fail, they may leave things in a weird state. Be warned that you might have to ditch your G2 data and start over if something catastrophic happens.

Test Harness - We also have an older test harness that we use to do some load testing type tasks that might be fun to experiment with. Try creating 1000 users or a random tree of 5,000 photos to see what it’s like.

Localization - If you’re interested in localizing G2 into another language, you can review the current state of localization and then read the localization how-to and get started. Submit your localizations early and often - no need to wait until you’re entirely done.

For Developers - We've gotten started on some documentation that you should read if you want to start hacking on G2. It's an early draft and is a little bit out of date, but it's a start.

This page is valid XHTML 1.0 Gallery 2.0 beta-1 (Dark Fibre) Gallery 2.0 beta-1 (Dark Fibre)

$Id: README.html,v 1.70 2005/03/02 23:05:11 mindless Exp $