Contents

Gallery 2

Welcome to Gallery 2.1. This integration package is part of the ongoing effort to seamlessly integrate Gallery 2 in phpBB2. Please read through this document carefully before integrating Gallery 2 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.

Description

This package contains all the files, directories and mod instructions you will need in order to integrate Gallery 2 into your phpBB2 website. This integration package is still under continual development and improvement and is being released as a beta package.

What this package does

[table of contents]

Simply put, this package allows you to integrate Gallery 2 into phpBB2. Among it's many features, it:

  1. Creates an administration link/page in the phpBB2 administration page.
  2. Allows you to export your existing phpBB2 users and groups to Gallery 2.
  3. Maintains synchronization between Gallery 2 and phpBB2 user database tables.
  4. Allows users to include Gallery 2 images in phpBB2 posts.

Installation

[table of contents]

NOTICE

Standard Disclaimer: Back up all files/folders/databases related to Gallery 2 and phpBB2 before attempting this integration.

NOTICE

This integration package does not install or configure Gallery 2 for you. Before you proceed with this integration, you must install and configure Gallery 2 and you must already have phpBB2 installed and configured.

IMPORTANT

The use of the Gallery 2 rewrite module in an integrated environment can be a tricky task. It is highly recommended that you deactivate the Gallery 2 rewrite module prior to attempting this integration. You can then try activating it once everything else is working properly.

IMPORTANT

In order for the image selector to work so that Gallery 2 images can be included in phpBB posts, the Image Block module must be installed and activated in Gallery 2. This can be done in the Gallery 2 Admin Options.

IMPORTANT

This integration package is developed and tested using the subSilver template style. If you are using any kind of custom template, style, theme, skin, etc.; you will have to find and make the necessary equivalent changes yourself. We cannot support every variant out there.

This package contains these folders:

To install, create a folder named "g2image" in your phpBB2 installation. Then upload the contents of the phpBB2, phpBB2/admin, phpBB2/g2image and phpBB2/templates folders into the corresponding folders in your phpBB2 installation. 

	phpBB2/gallery2.php
	phpBB2/g2helper.inc
	phpBB2/admin/admin_gallery2.php
	phpBB2/admin/gallery2_export.php
	phpBB2/admin/g2helper_admin.inc
	phpBB2/admin/G2EmbedDiscoveryUtilities.class
	phpBB2/g2image/g2image.php
	phpBB2/g2image/css/g2image.css
	phpBB2/g2image/jscripts/functions.js
	phpBB2/language/lang_english/lang_g2image.php
	phpBB2/language/lang_english/lang_gallery2.php
	phpBB2/templates/subSilver/gallery2.tpl
	phpBB2/templates/subSilver/admin/gallery2_config_body.tpl
	phpBB2/templates/subSilver/admin/gallery2_export.tpl
	phpBB2/templates/subSilver/admin/gallery2_show_body.tpl
	phpBB2/templates/subSilver/admin/gallery2_sync_intro_body.tpl
	phpBB2/templates/subSilver/images/exif_parser.gif
	gallery2/modules/core/templates/blocks/local/BreadCrumb.tpl

The gallery2 folder contains a customized breadcrumb navigation file that will include a link back to your forum's index page. To use this feature, create a directory called "local" within gallery2/modules/core/templates/blocks and copy this version of BreadCrumb.tpl into your new "local" directory:

Unix Example

$ mkdir ~/public_html/gallery2/modules/core/templates/blocks/local
$ cp BreadCrumb.tpl ~/public_html/gallery2/modules/core/templates/blocks/local/

Windows Example

C:\> mkdir c:\web\gallery2\modules\core\templates\blocks\local
C:\> copy BreadCrumb.tpl c:\web\gallery2\modules\core\templates\blocks\local\

Note that you may want to alter the following line in the included BreadCrumb.tpl file to reflect the actual home page of your forums:

<a href="/" class="BreadCrumb-1">Forum Index</a>

Next follow the instructions in the following mod file.

MOD instructions in plain mod txt format

Optional MODifications

[table of contents]

Optional MOD's can be found in the /add-on mods folder. Check the readme's in these folders for additional information if you are interested in using any of them. It is recommended you get the basic integration installed and working before adding optional mods.

Configuration

[table of contents]

Before you can view your Gallery 2 installation in phpBB2, you must first configure this integration package. To do this, navigate to the phpBB2 administration page and click on the "Gallery 2" link. You will now be presented with two options.

The first area is the primary integration settings. If these are incorrectly set, your integration will not succeed. Fear not though, as you should really only have to fill in one value, making it fairly painless.

Configure Settings

  1. The following value depends on your particular installation and you must ensure it is entered correctly.
    URL path to the gallery2 directory - This should be the only setting that you really have to worry about. It is the URL you installed Gallery in and the same as you'd use to view your gallery in standalone mode. Proper examples would be:

    http://example.com/gallery2/   OR    /phpbb2/gallery2/   OR   /gallery2/

  2. The next value will be auto-detected based on the file location the script is running at and should be correct, however, you should double check it.
    URL path to gallery2.php - This is the URL that would take you to your Gallery 2 installation when it is integrated. For example:

    http://www.yoursite.com/phpbb2/gallery2.php   OR    /phpbb2/gallery2.php

  3. The integration package will attempt to automatically generate this value. It will not contain any information until after you've saved the config settings. This is normal.
    Full file path to embed.php - This setting is the complete path to your embed.php file. For example:

    /home/myuser/public_html/gallery2/embed.php

  4. The integration package will automatically generate this value. It will not contain any information until after you've run the user export at least once. This is normal.
    Active Admin ID - This setting is the gallery external id of a valid admin.
  5. UTF-8 Translation - This setting controls utf-8 translation. This is only needed for non-english installations that require special extended charaters such as é, ö, etc.

When you are finished, click the "Submit" button. This will save your configuration to the phpBB2 database and will verify that your Gallery 2 installation has been properly set up.

Synchronize Users

This will export all your phpBB2 users and create a G2 account for them if they do not have one. The phpBB2 admin accounts will also be mapped to the G2 admin accounts. Therefore, if you're logged as an admin in phpBB2, you will also be logged as an admin in G2. The integration configuration will not be completed until the export users option has been run at least once. This will fill in the Active Admin ID field and map the admin and guest accounts, along with the users if you elect to export all users at config time.

Un-Synchronize Users

This will remove all groups, admins, guests and users, including all items belonging to these users, that have an external id mapping in Gallery 2. All Gallery 2 albums and photos belonging to these users will be deleted and cannot be undone. The admin defined by activeAdminId will remian as an admin in Gallery 2, but will be removed from the external id map. Use with caution!

Latest Export Results

This allows you to view the results from the latest export run

Getting Help

[table of contents]

If you are having problems getting your integration completed successfully, start out by searching the Forums at NukedGallery.net. Gallery2 specific help is offered in this forum on NukedGallery.

If you are having general Gallery 2 problems, you should start by looking in the Gallery 2 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 Gallery 2 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. If you want to chat in real time, you can talk on our user-to-user irc support channel, #gallery-support on irc.freenode.net.

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

[table of contents]

The following are known issues with this integration package:

  1. Apache aliased directories are known to have issues or not work at all with this integration.

For a list of known issues with Gallery 2, view the Gallery 2 README.

$Id: Readme.html 14689 2006-10-05 13:34:05Z dmolavi $