Contents

Gallery 2

Welcome to Gallery 2.1. This integration package is part of the ongoing effort to seamlessly integrate Gallery 2 in PHPNuke. 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 and directories you will need in order to integrate Gallery 2.1 into your PHPNuke-powered website. Please keep in mind, though, that this integration package, is still being developed and debugged. While most heavy development has stopped, bugs are still present and being fixed as they are found. However, it should be stable enough to be used in a production environment. Standard Disclaimer: Back up all files/folders/databases related to Gallery 2 before attempting this integration.

What this package does

[table of contents]

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

  1. Creates an administration panel in the PHPNuke administration page.
  2. Contains a PHPNuke block that allows you to utilize Gallery 2's built-in sidebar.
  3. Allows you to export your existing PHPNuke users to Gallery 2.

Installation

[table of contents]

CRITICAL

Starting with version 0.5.0 of the PHPNuke integration, this integration package will only work with Gallery 2.1 or newer. For more information, please read this post.


NOTICE

This integration package does not install or configure Gallery 2.1 for you. Before you proceed with this integration, you must install and configure Gallery 2.1. Additionally, Gallery 2.1 must be installed into the "modules" directory of your PHPNuke installation.


IMPORTANT

The use of the Gallery 2 rewrite module in an integrated environment has proven to be a tricky task. It is highly recommended that you deactivate and uninstall the Gallery 2 rewrite module prior to attempting this integration.

This package contains four folders:

To install, simply upload the contents of these folders into the corresponding folders in your PHPNuke installation.


IMPORTANT

If you are using a version of PHPNuke older than version 7.5, you must delete the following files from the integration package:
html/modules/gallery2/admin/case.php
html/modules/gallery2/admin/links.php

If you are using a version of PHPNuke equal to or newer than version 7.5, you must delete the following files from the integration package:
html/admin/case/case.gallery2.php
html/admin/links/links.gallery2.php

Things to check

[table of contents]

By default, the Gallery 2 installation will be installed in html/modules/gallery2/. If you decide to change the name of your Gallery 2 directory (ie, to just "Gallery"), then you must make the following changes:

In html/admin/case/case.gallery2.php

You will need to update the following line:
$module_name = "gallery2";
Change "gallery2" to whatever you renamed your Gallery 2 installation directory to.

Configuration

[table of contents]

Before you can view your Gallery 2 installation in PHPNuke, you must first configure this integration package. To do this, navigate to the PHPNuke administration panel and click on the "Gallery2" logo. You will now be presented with three areas which will need configuration.

The first area is the primary integration settings. If these are incorrectly set, your integration will not succeed. Fear not, though, as it will probably take you two or three attempts before you land upon the correct settings.

Gallery 2 Integration Settings

The integration package will attempt to fill these values in to the best of it's ability, however, it is a good idea for you to double-check them, since your Gallery 2 integration will not work if these values are incorrect.
  1. Full URL to your embedded Gallery - This is the full URL that would take you to your Gallery 2 installation when it is integrated. For example:

    http://www.example.com/modules.php?name=gallery2

  2. Full URL to your standalone Gallery - This is the full URL that would take you to your Gallery 2 installation when you visit it in standalone mode. For example:

    http://www.example.com/modules/gallery2/

  3. Active User ID - You can safely leave this set to 0.
  4. Cookie Path - This you can safely leave set at it's default value. But when Gallery is reachable at http://www.example.com/application/modules/gallery2/ and your website homepage is at http://www.example.com/application/, then you have to compare the path /application/modules/gallery2/ with /application/. The cookie path is the part of the paths that is equal, in this case it is '/application/'.
When you are finished, click the "Update integration settings" button. This will save your configuration to your database and will verify that your Gallery 2 installation has been properly set up.

Gallery 2 Main Settings

As of this writing, it only allows you to control the sidebar. The show sidebar checkbox allows you to remove the sidebar from the main Gallery2 display. If you leave this unchecked, you can display it inside a standard PHPNuke block. (Install the G2_Sidebar block to get it)

Export Users to Gallery 2

This will export all your PHPNuke users and create a G2 account for them if they do not have one. The first PHPNuke admin account will also be mapped to the G2 admin account. Therefore, if you're logged as an admin in PHPNuke, you will also been logged as the admin in G2 regardless of your PHPNuke normal user login.

No group mapping is done at this time; it will come in a future release.

The dynamic addition of users works. Everytime a new user registers on your PHPNuke portal, on their first G2 visit, an account will be created for him.

Users are now automatically added to Gallery 2 when they activate their membership on your PHPNuke site.

Almost done...

Don't forget to activate your Gallery 2 modules via the PHPNuke administration panel.

Block Configuration

This is a standard PHPNuke block, and activating it via the PHPNuke administration panel is all that's required. Please note that this block is still very unstable, and should not be used on a production website.

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. Verification of settings - Right now, a very rudimentary check is done to ensure that Gallery2 is installed and configured. A more robust check of the remaining settings needs to be done.
For a list of known issues with Gallery 2, view the Gallery 2 README.

This page is valid XHTML 1.0 Gallery 2.1

$Id: Readme.html 15219 2006-11-17 13:49:54Z dmolavi $