User Tools

Site Tools


ce4_104

A Beginner's Guide to the CE4 Client Proofing Bundle

The CE4 Client Proofing Bundle is designed for users who may have an existing website, not made with The Turning Gate's CE4 series plugins. In such a case, it's possible to use our plugins in parallel to your existing website, so long as you meet the hosting requirements for our tools, detailed below.

Goals

In this tutorial, you will learn how to setup your gallery publishing system using CE4 Auto Index, Client Response Gallery and Publisher, and how to use these tools to create and manage your galleries.

This tutorial covers setup and workflow for the CE4 Client Proofing Bundle, which includes:

  • TTG BE
  • CE4 Auto Index
  • CE4 Client Response Gallery
  • CE4 Publisher

* The bundle also includes CE4 Viewport Sizer, not discussed in this tutorial.


Requirements for Use

The shop page for each TTG plugin lists out the system and software requirements for running the web engines, as well as the hosting requirements for publishing content to the web. Pay close attention to these requirements when purchasing. For hosting, we recommend a web server meeting the following bullet points:

  • Linux OS
  • Apache server
  • PHP 5.2.6 or newer, with SQLite and PDO modules

If you are yet in need of hosting, or would like to move to a new host, we recommend Bluehost. Fair prices, great support and everything you need for publishing from TTG plugins.

To set things up, you will also need an FTP client.

Finally, you should review our file naming guidelines for images. When putting your images on the Web, it is important to observe web-safe file name convention.


Step 1: Take Inventory

Now, let's get into it. Download and unzip all of the files that come along with your order. You will have:

  • Three web engine packages:
    • CE4-Auto-Index-Enabler.lrwebengine
    • CE4-Auto-Index.lrwebengine
    • CE4-CRG.lrwebengine
  • One LR plugin:
    • CE4-Publisher.lrplugin
  • Three online modules
    • /crg
    • /publisher
    • /ttg-be

That may seem like a lot of pieces, but it's not all too daunting. Hang in there.


Step 2: Do the Install

A. Install the Web Engines

Depending on your operating system, copy the .lrwebengine packages into one of the following locations. Do not double-click the packages to install; you need to manually copy these into the correct location on your system.

on Mac OS X Lion / Mountain Lion / Mavericks / Yosemite
Users/username/Library/Application Support/Adobe/Lightroom/Web Galleries/

If unable to locate the /Library/ folder in Lion or newer, go to the Finder's Go menu, hold the OPT key, and “Library” will appear in the list.

on Windows Vista, Windows 7 & Windows 8
C:\Users\username\AppData\Roaming\Adobe\Lightroom\Web Galleries\

On Windows platforms, the /Application Data/ directory is usually hidden. You must enable “show hidden folders” in the folder options before you can browse to it.

For more detailed information, see Installing a Web Engine.

B. Install the Publisher Plugin

To install CE4-Publisher.lrplugin, we'll be using Lightroom's Plugin Manager. First, copy the CE4-Publisher.lrplugin from the downloaded zip file to a location on your computer for safekeeping. This should be someplace that the plugin may remain longterm, as LR will read from this location after installation.

In Lightroom's Library module, access the File menu and select Plug-in Manager…

The left-hand side of the Plug-in Manager will display a list of installed plugins. Click Add, navigate to the location of the CE4-Publisher.lrplugin on your drive, and click Add Plug-in. TTG CE4 Publisher will appear in the list of installed plugins.

Click Done. TTG CE4 Publisher should now be installed, and can be seen in the Library's Publish Services control pane.

For a more detailed overview, see Install the CE4 Publisher Lightroom Plugin.

C. Install the Online Components

Again, we have three online components.

  • /crg
  • /publisher
  • /ttg-be

TTG BE (/ttg-be) is the overarching back-end framework for the CE4 series, and acts as parent to the other modules. The /crg and /publisher modules correspond to CE4 Client Response Gallery and CE4 Publisher, respectively.

First, copy both /crg and /publisher into the /ttg-be folder, such that you will have:

  • /ttg-be
  • /ttg-be/crg
  • /ttg-be/publisher

Next, upload the /ttg-be folder to the top-level of your website, such that you will have:

  • yourdomain.com/ttg-be
  • yourdomain.com/ttg-be/crg
  • yourdomain.com/ttg-be/publisher

At this point, you may be mingling /ttg-be with your other site assets. For example, if you're running a WordPress site, then you might find yourself with:

  • index.php
  • /ttg-be
  • /wp-admin
  • /wp-content
  • /wp-includes
  • etc.

This is completely fine. Don't worry about it.

At this point, all pieces are in place, albeit not yet configured. We'll get to that, each in turn.


Step 3: A Home for Your Galleries

On server, your future galleries will need a place to reside. We're going to create that location using CE4 Auto Index. Go to Lightroom's Web module, then load CE4 Auto Index from the Layout Style list in the top-right corner of the module.

If you'd prefer to speed ahead, to get up-and-running quickly, then keep the default settings. You may return to this later to customize things.

If you would prefer to spend some time customizing the page now, we recommend that you begin at the top of the controls, then work your way downward. Do not jump around; there are a lot of options, and jumping around will only get you lost.

We also recommend that you right-click the control panels on the right, and enable “Solo Mode”, so that only one panel will remain open at a time. Complete the panel, then open the next one, and so on …

When finished making customizations, find the Template Browser on the lefthand side of the module and save a template. This will allow you to recall your configuration later, and you will also be able to copy your settings for use in other CE4 plugins.

When satisfied with your configuration, hit the Export button and save to your desktop as “galleries”. This will create a /galleries folder on your desktop.

Upload the /galleries folder to your server using FTP, and place it alongside the /ttg-be folder, like so:

  • /galleries
  • /ttg-be

Change permissions on the /galleries/ folder to make it writeable. Depending on your server, we'll want permissions to be either 777 or 755. This is so that we can publish to the folder using CE4 Publisher later on. If you're not sure whether to use 777 or 755, then just pick one; it can be changed later if there's a problem. If hosting on Bluehost, use 755.

If you are unsure how to change permissions, try right-clicking on the /galleries folder and choosing “Get Info” from the context menu. In most FTP clients, this will allow you to change permissions on a file or folder.

If you'd like, you should now be able to visit the auto index page in your browser, at yourdomain.com/galleries. The gallery index will be empty, of course; we have yet to add any galleries!


We will now create our first gallery template. The template is not itself a gallery people will see, so we'll want just a handful of images to use as visual stand-ins while we work.

When we later publish albums, the albums will reference this template for design, with each album filling in its own images, captions, etc.

In Lightroom's Web module, select CE4 Client Response Gallery from the Layout Style list.

If you've already customized CE4 Auto Index above, then you may wish to reuse your work. It's a great way to save time, and to ensure that all of your pages maintain consistent in design and configuration.

When ready, hit the Export button and save the gallery to your desktop. Save using whatever name you like; for the sake of example, I'm going to use “my-template” here in the article.

When the export has finished, you should upload the new /my-template folder to /ttg-be/templates/gallery, such that you will have online:

  • /ttg-be/templates/gallery/my-template

Step 5: Configure TTG BE

TTG BE (/ttg-be) and our other components are online, so let's log in and things up to be used. Visit the dashboard at:

  • yourdomain.com/ttg-be/admin

The default admin username and password is admin and ttg8888.

Once logged in, immediately do the following:

  • Select “Client Response Gallery Admin” from the Dashboard menu to complete the CRG installation.
  • Select “Publisher Admin” from the Dashboard menu to complete the Publisher installation.
  • Select “TTG BE Admin” from the Dashboard menu, then select Settings > Manage Users. Change your login username and password.

These things done, select “TTG BE Settings” from the Settings menu. Edit the settings as needed (company details, email setup, etc.).


Step 6: Setup a Publisher Instance

Next up, we connect Lightroom's Publish Services to TTG BE to facilitate album publishing.

Go to Lightroom's Library module. Under Publish Services, on the left, double-click CE4 Publisher.

Here you will need to fill in the API information to get the two connected, and set the “Top-level galleries directory” to use the “galleries” folder that we created in step 3.

For details on how to do all of this, see the CE4 Publisher documentation article Setup a Publisher Instance.


Step 7: Publish an Album

In Lightroom's Library module, under Publish Services, you will now have created an instance of TTG CE4 Publisher.

Beneath that, you will probably have an album named “Default Album”. It's not possible to publish to this, so delete it.

Create albums by right-clicking the publish service, and selecting Create Album. You may also right-click an Album Set to create an album within the set.

When creating an album:

  • Under Base Settings:
    • Provide a Name; this is how the album will appear within the Publish Services list.
    • Provide an Album Title; this is how the album will be titled online.
    • Provide a short Album Description; if you CE4 Auto Index design includes descriptions, this will be used there; The album description is also used by social media and search engines.
    • Select a Template for the gallery to use. You created a template in step 4; you may create as many templates as you want.
  • Under Page Content:
    • Write a gallery description to appear on the page, if you want one.
    • If your template includes text you want to appear in every gallery (such as the Legend), change the Copy placement option accordingly.
  • Under Features:
    • Set whatever options you like.
    • If the gallery is private, you should enable “Hide from Auto Index”. Client Response Galleries are not searchable, so “Hide from Search” is irrelevant.
    • Under Integration:
      • Enable feedback.
      • Keep the “default” Feedback Profile; you may create additional profiles later.
      • Set your preference for Client Management.
        • If you want clients to login, choose “Managed by CRG Admin”. This also allows client feedback to be saved between sessions.
        • Use “Standalone” if you do not require clients to login. Feedback cannot be saved, so should be submitted before the client leaves the gallery.

When finished, press the Create button.

You may now drag images into the Collection under Publish Services. Press the Publish button to post images to the gallery online.

Repeat this step for each gallery you'd like to create.


Step 8: Back to CRG Admin

We now have our first gallery online, so let's return to the CRG Admin to finish things off. Return to:

  • yourdomain.com/ttg-be/admin

Log in, then select “Client Response Gallery Admin” from the Dashboard menu.

  • Under the Settings menu, select “CRG Settings”.
    • Set preferences as you like.
    • Under Personalisation, set CRG Template to use your template from step 4.
      • This is used to determine the appearance of message pages the client may see apart from the gallery itself, such as the confirmation page after submitting feedback, the client login page, etc.
  • Under the Settings menu, select “Clients”.
    • For client managed galleries, you may create client accounts and assign galleries to each client.
    • For a completely explanation of the benefits of client-managed galleries, see here.
  • Under the Settings menu, select “Client Fields”.
    • Here you may edit the required information for when clients submit feedback from a gallery.
  • Under the Feedback menu, select “Feedback Profiles”.
    • Here you may create feedback profiles for your gallery, or edit the 'default' profile.
    • For the gallery we created in step 7, we selected the 'default' profile. Go ahead and edit this to your liking. Visit the gallery to observe your changes.
    • You may create any number of profiles. Select which profile to use when creating or editing your gallery.

Wrapping Up

At this point, you have your system entirely setup, and you should have a grasp on how to publish albums.

Here are a few additional points to keep in mind:

  • We created a gallery template, /my-template.
    • You may replace the template with a newer version. All existing galleries referencing the template will be affected by the change.
    • You may create additional templates; set which template an album should use when creating or editing an album.
  • You can use CE4 Auto Index to create Album Sets, to further organize your galleries.
  • If you have questions or issues, our community forum is the best place to get answers.
ce4_104.txt · Last modified: 2015/03/04 05:24 by matthew

The Turning Gate
Creating webbly, wobbly, Lightroomy things since 2007.